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)

    A 34 character string that uniquely identifies this resource.

  • sid (String) (defaults to: nil)

    The sid



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 227

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:



247
248
249
250
251
252
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 247

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

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the SigningKeyInstance

Returns:

  • (Boolean)

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetchSigningKeyInstance

Fetch a SigningKeyInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_nameString

Returns The friendly_name.

Returns:

  • (String)

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



309
310
311
312
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 309

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

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



256
257
258
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 256

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation



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

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)

    The friendly_name

Returns:



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

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