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

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

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


233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 233

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 that created the Credential that the PublicKey resource belongs to.

Returns:

  • (String) —

    The SID of the Account that created the Credential that the PublicKey resource belongs to


270
271
272
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 270

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:


255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 255

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

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


282
283
284
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 282

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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


288
289
290
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 288

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PublicKeyInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


317
318
319
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 317

def delete
  context.delete
end

#fetch ⇒ PublicKeyInstance

Fetch the PublicKeyInstance

Returns:


301
302
303
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 301

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


276
277
278
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 276

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


264
265
266
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 264

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


323
324
325
326
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 323

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:


310
311
312
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 310

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:


294
295
296
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 294

def url
  @properties['url']
end