Class: Twilio::REST::Notify::V1::CredentialContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/notify/v1/credential.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ CredentialContext

Initialize the CredentialContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Credential resource to fetch.


193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 193

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {sid: sid, }
  @uri = "/Credentials/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Delete the CredentialInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


248
249
250
 
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 248

def delete
   @version.delete('DELETE', @uri)
end

#fetch ⇒ CredentialInstance

Fetch the CredentialInstance

Returns:


204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 204

def fetch
  payload = @version.fetch('GET', @uri)

  CredentialInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


261
262
263
264
 
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 261

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Notify.V1.CredentialContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation


254
255
256
257
 
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 254

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Notify.V1.CredentialContext #{context}>"
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. Strip everything outside of the headers, e.g. `—–BEGIN CERTIFICATE—–MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.….A==—–END CERTIFICATE—–`

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

    The URL-encoded representation of the

    private key. Strip everything outside of the headers, e.g. `—–BEGIN RSA PRIVATE KEY—–MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieRn.—–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 `Server key` of your project from

    Firebase console under Settings / Cloud messaging.

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

    The `Server key` of your project from Firebase

    console under Settings / Cloud messaging.

Returns:


230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 230

def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Certificate' => certificate,
      'PrivateKey' => private_key,
      'Sandbox' => sandbox,
      'ApiKey' => api_key,
      'Secret' => secret,
  })

  payload = @version.update('POST', @uri, data: data)

  CredentialInstance.new(@version, payload, sid: @solution[:sid], )
end