Class: Twilio::REST::Supersim::V1::IpCommandList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Supersim::V1::IpCommandList
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/ip_command.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#create(sim: nil, payload: nil, device_port: nil, payload_type: :unset, callback_url: :unset, callback_method: :unset) ⇒ IpCommandInstance
Create the IpCommandInstance.
-
#each ⇒ Object
When passed a block, yields IpCommandInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of IpCommandInstance records from the API.
-
#initialize(version) ⇒ IpCommandList
constructor
Initialize the IpCommandList.
-
#list(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Array
Lists IpCommandInstance records from the API as a list.
-
#page(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of IpCommandInstance records from the API.
-
#stream(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams IpCommandInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ IpCommandList
Initialize the IpCommandList
20 21 22 23 24 25 26 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 20 def initialize(version) super(version) # Path Solution @solution = {} @uri = "/IpCommands" end |
Instance Method Details
#create(sim: nil, payload: nil, device_port: nil, payload_type: :unset, callback_url: :unset, callback_method: :unset) ⇒ IpCommandInstance
Create the IpCommandInstance
43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 43 def create(sim: nil, payload: nil, device_port: nil, payload_type: :unset, callback_url: :unset, callback_method: :unset) data = Twilio::Values.of({ 'Sim' => sim, 'Payload' => payload, 'DevicePort' => device_port, 'PayloadType' => payload_type, 'CallbackUrl' => callback_url, 'CallbackMethod' => callback_method, }) payload = @version.create('POST', @uri, data: data) IpCommandInstance.new(@version, payload, ) end |
#each ⇒ Object
When passed a block, yields IpCommandInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
133 134 135 136 137 138 139 140 141 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 133 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 IpCommandInstance records from the API. Request is executed immediately.
183 184 185 186 187 188 189 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 183 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) IpCommandPage.new(@version, response, @solution) end |
#list(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Array
Lists IpCommandInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
81 82 83 84 85 86 87 88 89 90 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 81 def list(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) self.stream( sim: sim, sim_iccid: sim_iccid, status: status, direction: direction, limit: limit, page_size: page_size ).entries end |
#page(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of IpCommandInstance records from the API. Request is executed immediately.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 162 def page(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Sim' => sim, 'SimIccid' => sim_iccid, 'Status' => status, 'Direction' => direction, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) IpCommandPage.new(@version, response, @solution) end |
#stream(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams IpCommandInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 115 def stream(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( sim: sim, sim_iccid: sim_iccid, status: status, direction: direction, 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
193 194 195 |
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 193 def to_s '#<Twilio.Supersim.V1.IpCommandList>' end |