Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnContext::AssignedAddOnExtensionList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnContext::AssignedAddOnExtensionList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields AssignedAddOnExtensionInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of AssignedAddOnExtensionInstance records from the API.
-
#initialize(version, account_sid: nil, resource_sid: nil, assigned_add_on_sid: nil) ⇒ AssignedAddOnExtensionList
constructor
Initialize the AssignedAddOnExtensionList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists AssignedAddOnExtensionInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of AssignedAddOnExtensionInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams AssignedAddOnExtensionInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, account_sid: nil, resource_sid: nil, assigned_add_on_sid: nil) ⇒ AssignedAddOnExtensionList
Initialize the AssignedAddOnExtensionList
30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 30 def initialize(version, account_sid: nil, resource_sid: nil, assigned_add_on_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid, resource_sid: resource_sid, assigned_add_on_sid: assigned_add_on_sid } @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:resource_sid]}/AssignedAddOns/#{@solution[:assigned_add_on_sid]}/Extensions.json" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields AssignedAddOnExtensionInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
80 81 82 83 84 85 86 87 88 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 80 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 AssignedAddOnExtensionInstance records from the API. Request is executed immediately.
114 115 116 117 118 119 120 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 114 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) AssignedAddOnExtensionPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists AssignedAddOnExtensionInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
53 54 55 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 53 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 AssignedAddOnExtensionInstance records from the API. Request is executed immediately.
97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 97 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) AssignedAddOnExtensionPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams AssignedAddOnExtensionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
68 69 70 71 72 73 74 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 68 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
124 125 126 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb', line 124 def to_s '#<Twilio.Api.V2010.AssignedAddOnExtensionList>' end |