class Twilio::REST::Conversations::V1::CredentialList

Public Class Methods

new(version) click to toggle source

Initialize the CredentialList @param [Version] version Version that contains the resource @return [CredentialList] CredentialList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/conversations/v1/credential.rb
18 def initialize(version)
19   super(version)
20 
21   # Path Solution
22   @solution = {}
23   @uri = "/Credentials"
24 end

Public Instance Methods

create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) click to toggle source

Create the CredentialInstance @param [credential.PushType] type The type of push-notification service the

credential is for. Can be: `fcm`, `gcm`, or `apn`.

@param [String] friendly_name A descriptive string that you create to describe

the new resource. It can be up to 64 characters long.

@param [String] certificate [APN only] The URL encoded representation of the

certificate. For example,
`-----BEGIN CERTIFICATE-----
MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==
-----END CERTIFICATE-----`.

@param [String] private_key [APN only] The URL encoded representation of the

private key. For example,
`-----BEGIN RSA PRIVATE KEY-----
MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...
-----END RSA PRIVATE KEY-----`.

@param [Boolean] sandbox [APN only] Whether to send the credential to sandbox

APNs. Can be `true` to send to sandbox APNs or `false` to send to production.

@param [String] api_key [GCM only] The API key for the project that was obtained

from the Google Developer console for your GCM Service application credential.

@param [String] secret [FCM only] The **Server key** of your project from the

Firebase console, found under Settings / Cloud messaging.

@return [CredentialInstance] Created CredentialInstance

   # File lib/twilio-ruby/rest/conversations/v1/credential.rb
49 def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
50   data = Twilio::Values.of({
51       'Type' => type,
52       'FriendlyName' => friendly_name,
53       'Certificate' => certificate,
54       'PrivateKey' => private_key,
55       'Sandbox' => sandbox,
56       'ApiKey' => api_key,
57       'Secret' => secret,
58   })
59 
60   payload = @version.create('POST', @uri, data: data)
61 
62   CredentialInstance.new(@version, payload, )
63 end
each() { |x| ... } click to toggle source

When passed a block, yields CredentialInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.

    # File lib/twilio-ruby/rest/conversations/v1/credential.rb
103 def each
104   limits = @version.read_limits
105 
106   page = self.page(page_size: limits[:page_size], )
107 
108   @version.stream(page,
109                   limit: limits[:limit],
110                   page_limit: limits[:page_limit]).each {|x| yield x}
111 end
get_page(target_url) click to toggle source

Retrieve a single page of CredentialInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of CredentialInstance

    # File lib/twilio-ruby/rest/conversations/v1/credential.rb
137 def get_page(target_url)
138   response = @version.domain.request(
139       'GET',
140       target_url
141   )
142   CredentialPage.new(@version, response, @solution)
143 end
list(limit: nil, page_size: nil) click to toggle source

Lists CredentialInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records.  If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/conversations/v1/credential.rb
76 def list(limit: nil, page_size: nil)
77   self.stream(limit: limit, page_size: page_size).entries
78 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of CredentialInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of CredentialInstance

    # File lib/twilio-ruby/rest/conversations/v1/credential.rb
120 def page(page_token: :unset, page_number: :unset, page_size: :unset)
121   params = Twilio::Values.of({
122       'PageToken' => page_token,
123       'Page' => page_number,
124       'PageSize' => page_size,
125   })
126 
127   response = @version.page('GET', @uri, params: params)
128 
129   CredentialPage.new(@version, response, @solution)
130 end
stream(limit: nil, page_size: nil) click to toggle source

Streams CredentialInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/conversations/v1/credential.rb
91 def stream(limit: nil, page_size: nil)
92   limits = @version.read_limits(limit, page_size)
93 
94   page = self.page(page_size: limits[:page_size], )
95 
96   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
97 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/conversations/v1/credential.rb
147 def to_s
148   '#<Twilio.Conversations.V1.CredentialList>'
149 end