Class: Twilio::REST::Chat::V2::CredentialInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v2/credential.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the CredentialInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The sid



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 275

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'type' => payload['type'],
      'sandbox' => payload['sandbox'],
      '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 account_sid.

Returns:

  • (String) —

    The account_sid



319
320
321
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 319

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:



301
302
303
304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 301

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



343
344
345
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 343

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



349
350
351
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 349

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the CredentialInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



389
390
391
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 389

def delete
  context.delete
end

#fetch ⇒ CredentialInstance

Fetch a CredentialInstance

Returns:



362
363
364
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 362

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



325
326
327
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 325

def friendly_name
  @properties['friendly_name']
end

#sandbox ⇒ String

Returns The sandbox.

Returns:

  • (String) —

    The sandbox



337
338
339
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 337

def sandbox
  @properties['sandbox']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



313
314
315
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 313

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



395
396
397
398
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 395

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

#type ⇒ credential.PushService

Returns The type.

Returns:

  • (credential.PushService) —

    The type



331
332
333
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 331

def type
  @properties['type']
end

#update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance

Update the CredentialInstance

Parameters:

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

    The friendly_name

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

    The certificate

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

    The private_key

  • sandbox (Boolean) (defaults to: :unset) —

    The sandbox

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

    The api_key

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

    The secret

Returns:



375
376
377
378
379
380
381
382
383
384
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 375

def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
  context.update(
      friendly_name: friendly_name,
      certificate: certificate,
      private_key: private_key,
      sandbox: sandbox,
      api_key: api_key,
      secret: secret,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



355
356
357
 
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 355

def url
  @properties['url']
end