Class: Twilio::REST::Chat::V1::CredentialList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Chat::V1::CredentialList
- Defined in:
- lib/twilio-ruby/rest/chat/v1/credential.rb
Instance Method Summary collapse
-
#create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance
Create the CredentialInstance.
-
#each ⇒ Object
When passed a block, yields CredentialInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of CredentialInstance records from the API.
-
#initialize(version) ⇒ CredentialList
constructor
Initialize the CredentialList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists CredentialInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of CredentialInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams CredentialInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ CredentialList
Initialize the CredentialList
18 19 20 21 22 23 24 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 18 def initialize(version) super(version) # Path Solution @solution = {} @uri = "/Credentials" end |
Instance Method Details
#create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance
Create the CredentialInstance
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 129 def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) data = Twilio::Values.of({ 'Type' => type, 'FriendlyName' => friendly_name, 'Certificate' => certificate, 'PrivateKey' => private_key, 'Sandbox' => sandbox, 'ApiKey' => api_key, 'Secret' => secret, }) payload = @version.create('POST', @uri, data: data) CredentialInstance.new(@version, payload, ) end |
#each ⇒ Object
When passed a block, yields CredentialInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
64 65 66 67 68 69 70 71 72 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 64 def each limits = @version.read_limits page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]).each {|x| yield x} end |
#get_page(target_url) ⇒ Page
Retrieve a single page of CredentialInstance records from the API. Request is executed immediately.
98 99 100 101 102 103 104 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 98 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) CredentialPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists CredentialInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
37 38 39 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 37 def list(limit: nil, page_size: nil) self.stream(limit: limit, page_size: page_size).entries end |
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of CredentialInstance records from the API. Request is executed immediately.
81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 81 def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) CredentialPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams CredentialInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
52 53 54 55 56 57 58 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 52 def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#to_s ⇒ Object
Provide a user friendly representation
147 148 149 |
# File 'lib/twilio-ruby/rest/chat/v1/credential.rb', line 147 def to_s '#<Twilio.Chat.V1.CredentialList>' end |