Class: Twilio::REST::Conversations::V1::CredentialInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/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

  • account_sid (String) —

    The SID of the Account that created this Credential resource.

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

    The SID of the Call resource to fetch.



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 291

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 unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this credential.

Returns:



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

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:



315
316
317
318
319
320
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 315

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



354
355
356
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 354

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



360
361
362
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 360

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CredentialInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



373
374
375
376
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 373

def delete

    context.delete
end

#fetch ⇒ CredentialInstance

Fetch the CredentialInstance

Returns:



381
382
383
384
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 381

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The human-readable name of this credential, limited to 64 characters. Optional.

Returns:

  • (String) —

    The human-readable name of this credential, limited to 64 characters. Optional.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



426
427
428
429
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 426

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

#sandbox ⇒ String

Returns [APN only] Whether to send the credential to sandbox APNs. Can be ‘true` to send to sandbox APNs or `false` to send to production.

Returns:

  • (String) —
    APN only

    Whether to send the credential to sandbox APNs. Can be ‘true` to send to sandbox APNs or `false` to send to production.



348
349
350
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 348

def sandbox
    @properties['sandbox']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



324
325
326
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 324

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



419
420
421
422
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 419

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

#type ⇒ PushType

Returns:

  • (PushType) 


342
343
344
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 342

def type
    @properties['type']
end

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

Update the CredentialInstance

Parameters:

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

    A descriptive string that you create to describe the new resource. It can be up to 64 characters long.

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

    The URL encoded representation of the certificate. For example, ‘—–BEGIN CERTIFICATE—– MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.….A== —–END CERTIFICATE—–`.

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

    The URL encoded representation of the private key. For example, ‘—–BEGIN RSA PRIVATE KEY—– MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG… —–END RSA PRIVATE KEY—–`.

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

    Whether to send the credential to sandbox APNs. Can be ‘true` to send to sandbox APNs or `false` to send to production.

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

    The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.

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

    The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.

Returns:



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 396

def update(
    type: :unset, 
    friendly_name: :unset, 
    certificate: :unset, 
    private_key: :unset, 
    sandbox: :unset, 
    api_key: :unset, 
    secret: :unset
)

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

#url ⇒ String

Returns An absolute API resource URL for this credential.

Returns:

  • (String) —

    An absolute API resource URL for this credential.



366
367
368
 
# File 'lib/twilio-ruby/rest/conversations/v1/credential.rb', line 366

def url
    @properties['url']
end