Class: FleetList

Twilio.Supersim.V1.FleetList(version)

new FleetList(version)

Initialize the FleetList PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Parameters:
Name Type Description
version Twilio.Supersim.V1 Version of the resource
Source:

Methods

create(opts, callbackopt) → {Promise}

create a FleetInstance
Parameters:
Name Type Attributes Description
opts object Options for request
Properties
Name Type Attributes Description
networkAccessProfile string The SID or unique name of the Network Access Profile of the Fleet
uniqueName string <optional>
 An application-defined string that uniquely identifies the resource
dataEnabled boolean <optional>
 Defines whether SIMs in the Fleet are capable of using data connectivity
dataLimit number <optional>
 The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume
commandsEnabled boolean <optional>
 Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
commandsUrl string <optional>
 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 Commands number
commandsMethod string <optional>
 A string representing the HTTP method to use when making a request to `commands_url`
smsCommandsEnabled boolean <optional>
 Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
smsCommandsUrl string <optional>
 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
smsCommandsMethod string <optional>
 A string representing the HTTP method to use when making a request to `sms_commands_url`
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed FleetInstance
Type
Promise

each(optsopt, callbackopt)

Streams FleetInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached. The results are passed into the callback function, so this operation is memory efficient. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
networkAccessProfile string <optional>
 The SID or unique name of the Network Access Profile of the Fleet
limit number <optional>
 Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit
pageSize number <optional>
 Number of records to fetch per request, when not set will use the default value of 50 records. If no pageSize is defined but a limit is defined, each() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
callback function <optional>
 Function to process each record. If this and a positional callback are passed, this one will be used
done function <optional>
 Function to be called upon completion of streaming
callback function <optional>
 Function to process each record
Source:

get(sid) → {Twilio.Supersim.V1.FleetContext}

Constructs a fleet
Parameters:
Name Type Description
sid string The SID that identifies the resource to fetch
Source:
Returns:
Type
Twilio.Supersim.V1.FleetContext

getPage(targetUrlopt, callbackopt) → {Promise}

Retrieve a single target page of FleetInstance records from the API. The request is executed immediately. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
targetUrl string <optional>
 API-generated URL for the requested results page
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

list(optsopt, callbackopt) → {Promise}

Lists FleetInstance records from the API as a list. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
networkAccessProfile string <optional>
 The SID or unique name of the Network Access Profile of the Fleet
limit number <optional>
 Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
pageSize number <optional>
 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, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

page(optsopt, callbackopt) → {Promise}

Retrieve a single page of FleetInstance records from the API. The request is executed immediately. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
networkAccessProfile string <optional>
 The SID or unique name of the Network Access Profile of the Fleet
pageToken string <optional>
 PageToken provided by the API
pageNumber number <optional>
 Page Number, this value is simply for client state
pageSize number <optional>
 Number of records to return, defaults to 50
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

toJSON()

Provide a user-friendly representation
Source:
Returns:
Object