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 account_sid

  • sid (String) —

    The sid



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

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



222
223
224
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 222

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

#fetch ⇒ KeyInstance

Fetch a KeyInstance

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 179

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

#to_s ⇒ Object

Provide a user friendly representation



228
229
230
231
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 228

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) —

    The friendly_name

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 200

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