Class: Twilio::REST::Api::V2010::AccountContext::SipList::CredentialListInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the CredentialListInstance

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

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 282

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

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

Instance Method Details

#account_sidString

Returns The unique id of the [Account](www.twilio.com/docs/iam/api/account) that owns this resource.

Returns:



314
315
316
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 314

def 
    @properties['account_sid']
end

#contextCredentialListContext

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

Returns:



305
306
307
308
309
310
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 305

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

#credentialscredentials

Access the credentials

Returns:



386
387
388
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 386

def credentials
    context.credentials
end

#date_createdTime

Returns The date that this resource was created, given as GMT in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



320
321
322
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 320

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns The date that this resource was last updated, given as GMT in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



326
327
328
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 326

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the CredentialListInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



357
358
359
360
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 357

def delete

    context.delete
end

#fetchCredentialListInstance

Fetch the CredentialListInstance

Returns:



365
366
367
368
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 365

def fetch

    context.fetch
end

#friendly_nameString

Returns A human readable descriptive text that describes the CredentialList, up to 64 characters long.

Returns:

  • (String)

    A human readable descriptive text that describes the CredentialList, up to 64 characters long.



332
333
334
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 332

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



399
400
401
402
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 399

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

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.



338
339
340
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 338

def sid
    @properties['sid']
end

#subresource_urisHash

Returns A list of credentials associated with this credential list.

Returns:

  • (Hash)

    A list of credentials associated with this credential list.



344
345
346
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 344

def subresource_uris
    @properties['subresource_uris']
end

#to_sObject

Provide a user friendly representation



392
393
394
395
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 392

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

#update(friendly_name: nil) ⇒ CredentialListInstance

Update the CredentialListInstance

Parameters:

  • friendly_name (String) (defaults to: nil)

    A human readable descriptive text for a CredentialList, up to 64 characters long.

Returns:



374
375
376
377
378
379
380
381
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 374

def update(
    friendly_name: nil
)

    context.update(
        friendly_name: friendly_name, 
    )
end

#uriString

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

Returns:

  • (String)

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



350
351
352
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb', line 350

def uri
    @properties['uri']
end