Class: Twilio::REST::Api::V2010::AccountContext::SipList::CredentialListContext::CredentialInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the CredentialInstance

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

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

    The SID of the Call resource to fetch.



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 296

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

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

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account that is responsible for this resource.

Returns:

  • (String) —

    The unique id of the Account that is responsible for this resource.



334
335
336
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 334

def 
    @properties['account_sid']
end

#context ⇒ CredentialContext

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

Returns:



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

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

#credential_list_sid ⇒ String

Returns The unique id that identifies the credential list that includes this credential.

Returns:

  • (String) —

    The unique id that identifies the credential list that includes this credential.



340
341
342
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 340

def credential_list_sid
    @properties['credential_list_sid']
end

#date_created ⇒ Time

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:



352
353
354
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 352

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CredentialInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



371
372
373
374
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 371

def delete

    context.delete
end

#fetch ⇒ CredentialInstance

Fetch the CredentialInstance

Returns:



379
380
381
382
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 379

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



406
407
408
409
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 406

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Api.V2010.CredentialInstance #{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.



328
329
330
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 328

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(password: :unset) ⇒ CredentialInstance

Update the CredentialInstance

Parameters:

  • password (String) (defaults to: :unset) —

    The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg ‘IWasAtSignal2018`)

Returns:



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

def update(
    password: :unset
)

    context.update(
        password: password, 
    )
end

#uri ⇒ String

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

Returns:

  • (String) —

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



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

def uri
    @properties['uri']
end

#username ⇒ String

Returns The username for this credential.

Returns:

  • (String) —

    The username for this credential.



346
347
348
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 346

def username
    @properties['username']
end