Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb
Instance Method Summary collapse
-
#create(installed_add_on_sid: nil) ⇒ AssignedAddOnInstance
Create the AssignedAddOnInstance.
-
#each ⇒ Object
When passed a block, yields AssignedAddOnInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of AssignedAddOnInstance records from the API.
-
#initialize(version, account_sid: nil, resource_sid: nil) ⇒ AssignedAddOnList
constructor
Initialize the AssignedAddOnList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists AssignedAddOnInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of AssignedAddOnInstance 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, resource_sid: nil) ⇒ AssignedAddOnList
Initialize the AssignedAddOnList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 28 def initialize(version, account_sid: nil, resource_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid, resource_sid: resource_sid } @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:resource_sid]}/AssignedAddOns.json" end |
Instance Method Details
#create(installed_add_on_sid: nil) ⇒ AssignedAddOnInstance
Create the AssignedAddOnInstance
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 39 def create( installed_add_on_sid: nil ) data = Twilio::Values.of({ 'InstalledAddOnSid' => installed_add_on_sid, }) payload = @version.create('POST', @uri, data: data) AssignedAddOnInstance.new( @version, payload, account_sid: @solution[:account_sid], resource_sid: @solution[:resource_sid], ) end |
#each ⇒ Object
When passed a block, yields AssignedAddOnInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
99 100 101 102 103 104 105 106 107 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 99 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 AssignedAddOnInstance records from the API. Request is executed immediately.
133 134 135 136 137 138 139 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 133 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) AssignedAddOnPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists AssignedAddOnInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
68 69 70 71 72 73 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 68 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 AssignedAddOnInstance records from the API. Request is executed immediately.
116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 116 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) AssignedAddOnPage.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.
86 87 88 89 90 91 92 93 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 86 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
144 145 146 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 144 def to_s '#<Twilio.Api.V2010.AssignedAddOnList>' end |