Class: Twilio::REST::Preview::Marketplace::AvailableAddOnContext::AvailableAddOnExtensionList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Preview::Marketplace::AvailableAddOnContext::AvailableAddOnExtensionList
- Defined in:
- lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb
Overview
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields AvailableAddOnExtensionInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of AvailableAddOnExtensionInstance records from the API.
-
#initialize(version, available_add_on_sid: nil) ⇒ AvailableAddOnExtensionList
constructor
Initialize the AvailableAddOnExtensionList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists AvailableAddOnExtensionInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of AvailableAddOnExtensionInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams AvailableAddOnExtensionInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, available_add_on_sid: nil) ⇒ AvailableAddOnExtensionList
Initialize the AvailableAddOnExtensionList
23 24 25 26 27 28 29 |
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 23 def initialize(version, available_add_on_sid: nil) super(version) # Path Solution @solution = {available_add_on_sid: available_add_on_sid} @uri = "/AvailableAddOns/#{@solution[:available_add_on_sid]}/Extensions" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields AvailableAddOnExtensionInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
69 70 71 72 73 74 75 76 77 |
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 69 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 AvailableAddOnExtensionInstance records from the API. Request is executed immediately.
103 104 105 106 107 108 109 |
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 103 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) AvailableAddOnExtensionPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists AvailableAddOnExtensionInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
42 43 44 |
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 42 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 AvailableAddOnExtensionInstance records from the API. Request is executed immediately.
86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 86 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) AvailableAddOnExtensionPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams AvailableAddOnExtensionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
57 58 59 60 61 62 63 |
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 57 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
113 114 115 |
# File 'lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb', line 113 def to_s '#<Twilio.Preview.Marketplace.AvailableAddOnExtensionList>' end |