Class: Twilio::REST::Supersim::V1::FleetList

Inherits:
ListResource show all
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

Constructor Details

#initialize(version) ⇒ FleetList

Initialize the FleetList

Parameters:

  • version (Version)

    Version that contains the resource


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

Parameters:

  • network_access_profile (String) (defaults to: nil)

    The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.

  • unique_name (String) (defaults to: :unset)

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.

  • data_enabled (Boolean) (defaults to: :unset)

    Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`.

  • data_limit (String) (defaults to: :unset)

    The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).

  • ip_commands_url (String) (defaults to: :unset)

    The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

  • ip_commands_method (String) (defaults to: :unset)

    A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.

  • sms_commands_enabled (Boolean) (defaults to: :unset)

    Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`.

  • sms_commands_url (String) (defaults to: :unset)

    The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

  • sms_commands_method (String) (defaults to: :unset)

    A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.

Returns:


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

#eachObject

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.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of FleetInstance


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.

Parameters:

  • network_access_profile (String) (defaults to: :unset)

    The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array)

    Array of up to limit results


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.

Parameters:

  • network_access_profile (String) (defaults to: :unset)

    The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of FleetInstance


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.

Parameters:

  • network_access_profile (String) (defaults to: :unset)

    The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


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_sObject

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