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 of the Credential resource to fetch.


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 269

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


308
309
310
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 308

def 
  @properties['account_sid']
end

#contextCredentialContext

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

Returns:


293
294
295
296
297
298
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 293

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

#date_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the CredentialInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchCredentialInstance

Fetch the CredentialInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


403
404
405
406
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 403

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

#sandboxString

Returns [APN only] Whether to send the credential to sandbox APNs.

Returns:

  • (String)
    APN only

    Whether to send the credential to sandbox APNs


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

def sandbox
  @properties['sandbox']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


302
303
304
# File 'lib/twilio-ruby/rest/chat/v2/credential.rb', line 302

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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

#typecredential.PushService

Returns The type of push-notification service the credential is for.

Returns:

  • (credential.PushService)

    The type of push-notification service the credential is for


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

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)

    A descriptive string that you create to describe the 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:


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

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

#urlString

Returns The absolute URL of the Credential resource.

Returns:

  • (String)

    The absolute URL of the Credential resource


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

def url
  @properties['url']
end