Class: Twilio::REST::Supersim::V1::EsimProfileList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Supersim::V1::EsimProfileList
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/esim_profile.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#create(callback_url: :unset, callback_method: :unset, eid: :unset) ⇒ EsimProfileInstance
Create the EsimProfileInstance.
-
#each ⇒ Object
When passed a block, yields EsimProfileInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of EsimProfileInstance records from the API.
-
#initialize(version) ⇒ EsimProfileList
constructor
Initialize the EsimProfileList.
-
#list(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists EsimProfileInstance records from the API as a list.
-
#page(eid: :unset, sim_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of EsimProfileInstance records from the API.
-
#stream(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams EsimProfileInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ EsimProfileList
Initialize the EsimProfileList
20 21 22 23 24 25 26 |
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 20 def initialize(version) super(version) # Path Solution @solution = {} @uri = "/ESimProfiles" end |
Instance Method Details
#create(callback_url: :unset, callback_method: :unset, eid: :unset) ⇒ EsimProfileInstance
Create the EsimProfileInstance
38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 38 def create(callback_url: :unset, callback_method: :unset, eid: :unset) data = Twilio::Values.of({ 'CallbackUrl' => callback_url, 'CallbackMethod' => callback_method, 'Eid' => eid, }) payload = @version.create('POST', @uri, data: data) EsimProfileInstance.new(@version, payload, ) end |
#each ⇒ Object
When passed a block, yields EsimProfileInstance 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/supersim/v1/esim_profile.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 EsimProfileInstance records from the API. Request is executed immediately.
146 147 148 149 150 151 152 |
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 146 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) EsimProfilePage.new(@version, response, @solution) end |
#list(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists EsimProfileInstance 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 |
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 68 def list(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil) self.stream(eid: eid, sim_sid: sim_sid, status: status, limit: limit, page_size: page_size).entries end |
#page(eid: :unset, sim_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of EsimProfileInstance records from the API. Request is executed immediately.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 126 def page(eid: :unset, sim_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Eid' => eid, 'SimSid' => sim_sid, 'Status' => status, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) EsimProfilePage.new(@version, response, @solution) end |
#stream(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams EsimProfileInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
90 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 90 def stream(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(eid: eid, sim_sid: sim_sid, status: status, 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
156 157 158 |
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 156 def to_s '#<Twilio.Supersim.V1.EsimProfileList>' end |