Class: Twilio::REST::Api::V2010::AccountContext::KeyContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/key.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ KeyContext

Initialize the KeyContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Key resource to fetch.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Key resource to fetch.



157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 157

def initialize(version, , sid)
  super(version)

  # Path Solution
  @solution = {account_sid: , sid: sid, }
  @uri = "/Accounts/#{@solution[:account_sid]}/Keys/#{@solution[:sid]}.json"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the KeyInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



200
201
202
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 200

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ KeyInstance

Fetch a KeyInstance

Returns:



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 168

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



213
214
215
216
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 213

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.KeyContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



206
207
208
209
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 206

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.KeyContext #{context}>"
end

#update(friendly_name: :unset) ⇒ KeyInstance

Update the KeyInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 185

def update(friendly_name: :unset)
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end