Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainContext::AuthTypesList::AuthTypeRegistrationsList::AuthRegistrationsCredentialListMappingList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::SipList::DomainContext::AuthTypesList::AuthTypeRegistrationsList::AuthRegistrationsCredentialListMappingList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb
Instance Method Summary collapse
-
#create(credential_list_sid: nil) ⇒ AuthRegistrationsCredentialListMappingInstance
Create the AuthRegistrationsCredentialListMappingInstance.
-
#each ⇒ Object
When passed a block, yields AuthRegistrationsCredentialListMappingInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of AuthRegistrationsCredentialListMappingInstance records from the API.
-
#initialize(version, account_sid: nil, domain_sid: nil) ⇒ AuthRegistrationsCredentialListMappingList
constructor
Initialize the AuthRegistrationsCredentialListMappingList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists AuthRegistrationsCredentialListMappingInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of AuthRegistrationsCredentialListMappingInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, account_sid: nil, domain_sid: nil) ⇒ AuthRegistrationsCredentialListMappingList
Initialize the AuthRegistrationsCredentialListMappingList
31 32 33 34 35 36 37 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 31 def initialize(version, account_sid: nil, domain_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid, domain_sid: domain_sid } @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:domain_sid]}/Auth/Registrations/CredentialListMappings.json" end |
Instance Method Details
#create(credential_list_sid: nil) ⇒ AuthRegistrationsCredentialListMappingInstance
Create the AuthRegistrationsCredentialListMappingInstance
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 42 def create( credential_list_sid: nil ) data = Twilio::Values.of({ 'CredentialListSid' => credential_list_sid, }) payload = @version.create('POST', @uri, data: data) AuthRegistrationsCredentialListMappingInstance.new( @version, payload, account_sid: @solution[:account_sid], domain_sid: @solution[:domain_sid], ) end |
#each ⇒ Object
When passed a block, yields AuthRegistrationsCredentialListMappingInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
102 103 104 105 106 107 108 109 110 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 102 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 AuthRegistrationsCredentialListMappingInstance records from the API. Request is executed immediately.
136 137 138 139 140 141 142 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 136 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) AuthRegistrationsCredentialListMappingPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists AuthRegistrationsCredentialListMappingInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
71 72 73 74 75 76 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 71 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 AuthRegistrationsCredentialListMappingInstance records from the API. Request is executed immediately.
119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 119 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) AuthRegistrationsCredentialListMappingPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
89 90 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 89 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/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb', line 147 def to_s '#<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingList>' end |