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 unique id of the Account that responsible for this resource.

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

    The credential_list_sid

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

    The sid



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 268

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,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:

  • (String) —

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



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

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:



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 295

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 credential_list_sid.

Returns:

  • (String) —

    The credential_list_sid



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

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 format.

Returns:

  • (Time) —

    The date that this resource was created, given as GMT in RFC 2822 format.



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

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 format.

Returns:

  • (Time) —

    The date that this resource was last updated, given as GMT in RFC 2822 format.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the CredentialInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ CredentialInstance

Fetch a CredentialInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



382
383
384
385
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 382

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.



309
310
311
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb', line 309

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 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:



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

def update(password: :unset)
  context.update(password: password, )
end

#uri ⇒ String

Returns The URI for this resource, relative to api.

Returns:

  • (String) —

    The URI for this resource, relative to api.



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

def uri
  @properties['uri']
end

#username ⇒ String

Returns The username for this credential.

Returns:

  • (String) —

    The username for this credential.



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

def username
  @properties['username']
end