Class: Twilio::REST::Api::V2010::AccountContext::KeyInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ KeyInstance

Initialize the KeyInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies this resource.

  • sid (String) (defaults to: nil) —

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


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 217

def initialize(version, payload, account_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'friendly_name' => payload['friendly_name'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#context ⇒ KeyContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:

  • (KeyContext) —

    KeyContext for this KeyInstance


237
238
239
240
241
242
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 237

def context
  unless @instance_context
    @instance_context = KeyContext.new(@version, @params['account_sid'], @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created


258
259
260
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 258

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated


264
265
266
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 264

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the KeyInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


287
288
289
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 287

def delete
  context.delete
end

#fetch ⇒ KeyInstance

Fetch the KeyInstance

Returns:


271
272
273
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 271

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource


252
253
254
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 252

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


300
301
302
303
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 300

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.KeyInstance #{values}>"
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


246
247
248
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 246

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


293
294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 293

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.KeyInstance #{values}>"
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:


280
281
282
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 280

def update(friendly_name: :unset)
  context.update(friendly_name: friendly_name, )
end