Class: Twilio::REST::Api::V2010::AccountContext::SigningKeyInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the SigningKeyInstance

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 SigningKey resource.

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 241

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

#contextSigningKeyContext

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

Returns:



261
262
263
264
265
266
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 261

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

#date_createdTime

Returns:

  • (Time)


282
283
284
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 282

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns:

  • (Time)


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

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the SigningKeyInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetchSigningKeyInstance

Fetch the SigningKeyInstance

Returns:



303
304
305
306
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 303

def fetch

    context.fetch
end

#friendly_nameString

Returns:

  • (String)


276
277
278
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 276

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



330
331
332
333
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 330

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

#sidString

Returns:

  • (String)


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

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



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

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

#update(friendly_name: :unset) ⇒ SigningKeyInstance

Update the SigningKeyInstance

Parameters:

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

Returns:



312
313
314
315
316
317
318
319
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 312

def update(
    friendly_name: :unset
)

    context.update(
        friendly_name: friendly_name, 
    )
end