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 Credential Sid that uniquely identifies the Credential to fetch



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 239

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 AccountSid the Credential resource belongs to.

Returns:

  • (String) —

    AccountSid the Credential resource belongs to



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

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:



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

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

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the PublicKeyInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ PublicKeyInstance

Fetch a PublicKeyInstance

Returns:



307
308
309
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 307

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 human readable description of this resource, up to 64 characters.

Returns:



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

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:



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

def url
  @properties['url']
end