Class: Twilio::REST::Accounts::V1::CredentialList::PublicKeyInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ PublicKeyInstance

Initialize the PublicKeyInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this PublicKey resource.

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

    The SID of the Call resource to fetch.



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 289

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Credential that the PublicKey resource belongs to.

Returns:



326
327
328
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 326

def 
    @properties['account_sid']
end

#context ⇒ PublicKeyContext

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

Returns:



311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 311

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

#date_created ⇒ Time

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

Returns:



338
339
340
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 338

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



344
345
346
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 344

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PublicKeyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



357
358
359
360
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 357

def delete

    context.delete
end

#fetch ⇒ PublicKeyInstance

Fetch the PublicKeyInstance

Returns:



365
366
367
368
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 365

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.



332
333
334
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 332

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



392
393
394
395
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 392

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

#sid ⇒ String

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

Returns:

  • (String) —

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



320
321
322
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 320

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



385
386
387
388
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 385

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

#update(friendly_name: :unset) ⇒ PublicKeyInstance

Update the PublicKeyInstance

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:



374
375
376
377
378
379
380
381
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 374

def update(
    friendly_name: :unset
)

    context.update(
        friendly_name: friendly_name, 
    )
end

#url ⇒ String

Returns The URI for this resource, relative to ‘accounts.twilio.com`.

Returns:



350
351
352
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 350

def url
    @properties['url']
end