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 that created the Key resource to fetch.

  • sid (String)

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


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

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

#deleteBoolean

Delete the KeyInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


188
189
190
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 188

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

#fetchKeyInstance

Fetch the KeyInstance

Returns:


166
167
168
169
170
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 166

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

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

#inspectObject

Provide a detailed, user friendly representation


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

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

#to_sObject

Provide a user friendly representation


194
195
196
197
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 194

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:


177
178
179
180
181
182
183
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 177

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