Class: Twilio::REST::Supersim::V1::FleetList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Supersim::V1::FleetList
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/fleet.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset) ⇒ FleetInstance
Create the FleetInstance.
-
#each ⇒ Object
When passed a block, yields FleetInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of FleetInstance records from the API.
-
#initialize(version) ⇒ FleetList
constructor
Initialize the FleetList.
-
#list(network_access_profile: :unset, limit: nil, page_size: nil) ⇒ Array
Lists FleetInstance records from the API as a list.
-
#page(network_access_profile: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of FleetInstance records from the API.
-
#stream(network_access_profile: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams FleetInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ FleetList
Initialize the FleetList
20 21 22 23 24 25 26 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 20 def initialize(version) super(version) # Path Solution @solution = {} @uri = "/Fleets" end |
Instance Method Details
#create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset) ⇒ FleetInstance
Create the FleetInstance
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 60 def create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset) data = Twilio::Values.of({ 'NetworkAccessProfile' => network_access_profile, 'UniqueName' => unique_name, 'DataEnabled' => data_enabled, 'DataLimit' => data_limit, 'IpCommandsUrl' => ip_commands_url, 'IpCommandsMethod' => ip_commands_method, 'SmsCommandsEnabled' => sms_commands_enabled, 'SmsCommandsUrl' => sms_commands_url, 'SmsCommandsMethod' => sms_commands_method, }) payload = @version.create('POST', @uri, data: data) FleetInstance.new(@version, payload, ) end |
#each ⇒ Object
When passed a block, yields FleetInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
126 127 128 129 130 131 132 133 134 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 126 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 FleetInstance records from the API. Request is executed immediately.
164 165 166 167 168 169 170 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 164 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) FleetPage.new(@version, response, @solution) end |
#list(network_access_profile: :unset, limit: nil, page_size: nil) ⇒ Array
Lists FleetInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
92 93 94 95 96 97 98 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 92 def list(network_access_profile: :unset, limit: nil, page_size: nil) self.stream( network_access_profile: network_access_profile, limit: limit, page_size: page_size ).entries end |
#page(network_access_profile: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of FleetInstance records from the API. Request is executed immediately.
146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 146 def page(network_access_profile: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'NetworkAccessProfile' => network_access_profile, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) FleetPage.new(@version, response, @solution) end |
#stream(network_access_profile: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams FleetInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
114 115 116 117 118 119 120 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 114 def stream(network_access_profile: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(network_access_profile: network_access_profile, 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
174 175 176 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 174 def to_s '#<Twilio.Supersim.V1.FleetList>' end |