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

    The SID of the Account that created this Key resource.

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

    The SID of the Call resource to fetch.



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 261

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

    CallContext for this CallInstance



281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 281

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



308
309
310
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 308

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the KeyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



315
316
317
318
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 315

def delete

    context.delete
end

#fetch ⇒ KeyInstance

Fetch the KeyInstance

Returns:



323
324
325
326
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 323

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.



296
297
298
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 296

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



350
351
352
353
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 350

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

#sid ⇒ String

Returns The unique string that that we created to identify the Key resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Key resource.



290
291
292
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 290

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



343
344
345
346
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 343

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:



332
333
334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/api/v2010/account/key.rb', line 332

def update(
    friendly_name: :unset
)

    context.update(
        friendly_name: friendly_name, 
    )
end