class Twilio::REST::Api::V2010::AccountContext::SipList::CredentialListContext::CredentialList

Public Class Methods

new(version, account_sid: nil, credential_list_sid: nil) click to toggle source

Initialize the CredentialList @param [Version] version Version that contains the resource @param [String] account_sid The unique id of the Account that is responsible for

this resource.

@param [String] credential_list_sid The unique id that identifies the credential

list that includes this credential.

@return [CredentialList] CredentialList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb
25 def initialize(version, account_sid: nil, credential_list_sid: nil)
26   super(version)
27 
28   # Path Solution
29   @solution = {account_sid: account_sid, credential_list_sid: credential_list_sid}
30   @uri = "/Accounts/#{@solution[:account_sid]}/SIP/CredentialLists/#{@solution[:credential_list_sid]}/Credentials.json"
31 end

Public Instance Methods

create(username: nil, password: nil) click to toggle source

Create the CredentialInstance @param [String] username The username that will be passed when authenticating

SIP requests. The username should be sent in response to Twilio's challenge of
the initial INVITE. It can be up to 32 characters long.

@param [String] password The password that the username will use when

authenticating SIP requests. The password must be a minimum of 12 characters,
contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)

@return [CredentialInstance] Created CredentialInstance

    # File lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb
122 def create(username: nil, password: nil)
123   data = Twilio::Values.of({'Username' => username, 'Password' => password, })
124 
125   payload = @version.create('POST', @uri, data: data)
126 
127   CredentialInstance.new(
128       @version,
129       payload,
130       account_sid: @solution[:account_sid],
131       credential_list_sid: @solution[:credential_list_sid],
132   )
133 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/api/v2010/account/sip/credential_list/credential.rb
71 def each
72   limits = @version.read_limits
73 
74   page = self.page(page_size: limits[:page_size], )
75 
76   @version.stream(page,
77                   limit: limits[:limit],
78                   page_limit: limits[:page_limit]).each {|x| yield x}
79 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/api/v2010/account/sip/credential_list/credential.rb
105 def get_page(target_url)
106   response = @version.domain.request(
107       'GET',
108       target_url
109   )
110   CredentialPage.new(@version, response, @solution)
111 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/api/v2010/account/sip/credential_list/credential.rb
44 def list(limit: nil, page_size: nil)
45   self.stream(limit: limit, page_size: page_size).entries
46 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/api/v2010/account/sip/credential_list/credential.rb
88 def page(page_token: :unset, page_number: :unset, page_size: :unset)
89   params = Twilio::Values.of({
90       'PageToken' => page_token,
91       'Page' => page_number,
92       'PageSize' => page_size,
93   })
94 
95   response = @version.page('GET', @uri, params: params)
96 
97   CredentialPage.new(@version, response, @solution)
98 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/api/v2010/account/sip/credential_list/credential.rb
59 def stream(limit: nil, page_size: nil)
60   limits = @version.read_limits(limit, page_size)
61 
62   page = self.page(page_size: limits[:page_size], )
63 
64   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
65 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb
137 def to_s
138   '#<Twilio.Api.V2010.CredentialList>'
139 end