twilio.rest.supersim.v1 package

Submodules

twilio.rest.supersim.v1.command module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/supersim/v1/command.py:docstring of twilio.rest.supersim.v1.command, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.supersim.v1.command.CommandContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

fetch()[source]

Fetch the CommandInstance

Returns:The fetched CommandInstance
Return type:twilio.rest.supersim.v1.command.CommandInstance
class twilio.rest.supersim.v1.command.CommandInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

class Direction[source]

Bases: object

FROM_SIM = 'from_sim'
TO_SIM = 'to_sim'
class Status[source]

Bases: object

DELIVERED = 'delivered'
FAILED = 'failed'
QUEUED = 'queued'
RECEIVED = 'received'
SENT = 'sent'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
command
Returns:The message body of the command sent to or from the SIM
Return type:unicode
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
direction
Returns:The direction of the Command
Return type:CommandInstance.Direction
fetch()[source]

Fetch the CommandInstance

Returns:The fetched CommandInstance
Return type:twilio.rest.supersim.v1.command.CommandInstance
sid
Returns:The unique string that identifies the resource
Return type:unicode
sim_sid
Returns:The SID of the SIM that this Command was sent to or from
Return type:unicode
status
Returns:The status of the Command
Return type:CommandInstance.Status
url
Returns:The absolute URL of the Command resource
Return type:unicode
class twilio.rest.supersim.v1.command.CommandList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

create(sim, command, callback_method=<object object>, callback_url=<object object>)[source]

Create the CommandInstance

Parameters:
  • sim (unicode) – The sid or unique_name of the SIM to send the Command to
  • command (unicode) – The message body of the command
  • callback_method (unicode) – The HTTP method we should use to call callback_url
  • callback_url (unicode) – The URL we should call after we have sent the command
Returns:

The created CommandInstance

Return type:

twilio.rest.supersim.v1.command.CommandInstance

get(sid)[source]

Constructs a CommandContext

Parameters:sid – The SID that identifies the resource to fetch
Returns:twilio.rest.supersim.v1.command.CommandContext
Return type:twilio.rest.supersim.v1.command.CommandContext
get_page(target_url)[source]

Retrieve a specific page of CommandInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of CommandInstance
Return type:twilio.rest.supersim.v1.command.CommandPage
list(sim=<object object>, status=<object object>, direction=<object object>, limit=None, page_size=None)[source]

Lists CommandInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • sim (unicode) – The SID or unique name of the Sim that Command was sent to or from.
  • status (CommandInstance.Status) – The status of the Command
  • direction (CommandInstance.Direction) – The direction of the Command
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.command.CommandInstance]

page(sim=<object object>, status=<object object>, direction=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of CommandInstance records from the API. Request is executed immediately

Parameters:
  • sim (unicode) – The SID or unique name of the Sim that Command was sent to or from.
  • status (CommandInstance.Status) – The status of the Command
  • direction (CommandInstance.Direction) – The direction of the Command
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of CommandInstance

Return type:

twilio.rest.supersim.v1.command.CommandPage

stream(sim=<object object>, status=<object object>, direction=<object object>, limit=None, page_size=None)[source]

Streams CommandInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • sim (unicode) – The SID or unique name of the Sim that Command was sent to or from.
  • status (CommandInstance.Status) – The status of the Command
  • direction (CommandInstance.Direction) – The direction of the Command
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.command.CommandInstance]

class twilio.rest.supersim.v1.command.CommandPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_instance(payload)[source]

Build an instance of CommandInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.supersim.v1.command.CommandInstance
Return type:twilio.rest.supersim.v1.command.CommandInstance

twilio.rest.supersim.v1.fleet module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/supersim/v1/fleet.py:docstring of twilio.rest.supersim.v1.fleet, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.supersim.v1.fleet.FleetContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

fetch()[source]

Fetch the FleetInstance

Returns:The fetched FleetInstance
Return type:twilio.rest.supersim.v1.fleet.FleetInstance
update(unique_name=<object object>, network_access_profile=<object object>, commands_url=<object object>, commands_method=<object object>, sms_commands_url=<object object>, sms_commands_method=<object object>)[source]

Update the FleetInstance

Parameters:
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • network_access_profile (unicode) – The SID or unique name of the Network Access Profile of the Fleet
  • commands_url (unicode) – 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
  • commands_method (unicode) – A string representing the HTTP method to use when making a request to commands_url
  • sms_commands_url (unicode) – 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
  • sms_commands_method (unicode) – A string representing the HTTP method to use when making a request to sms_commands_url
Returns:

The updated FleetInstance

Return type:

twilio.rest.supersim.v1.fleet.FleetInstance

class twilio.rest.supersim.v1.fleet.FleetInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

class DataMetering[source]

Bases: object

PAYG = 'payg'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
commands_enabled
Returns:Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
Return type:bool
commands_method
Returns:A string representing the HTTP method to use when making a request to commands_url
Return type:unicode
commands_url
Returns: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
Return type:unicode
data_enabled
Returns:Defines whether SIMs in the Fleet are capable of using data connectivity
Return type:bool
data_limit
Returns:The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume
Return type:unicode
data_metering
Returns:The model by which a SIM is metered and billed
Return type:FleetInstance.DataMetering
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
fetch()[source]

Fetch the FleetInstance

Returns:The fetched FleetInstance
Return type:twilio.rest.supersim.v1.fleet.FleetInstance
network_access_profile_sid
Returns:The SID of the Network Access Profile of the Fleet
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
sms_commands_enabled
Returns:Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
Return type:bool
sms_commands_method
Returns:A string representing the HTTP method to use when making a request to sms_commands_url
Return type:unicode
sms_commands_url
Returns: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
Return type:unicode
unique_name
Returns:An application-defined string that uniquely identifies the resource
Return type:unicode
update(unique_name=<object object>, network_access_profile=<object object>, commands_url=<object object>, commands_method=<object object>, sms_commands_url=<object object>, sms_commands_method=<object object>)[source]

Update the FleetInstance

Parameters:
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • network_access_profile (unicode) – The SID or unique name of the Network Access Profile of the Fleet
  • commands_url (unicode) – 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
  • commands_method (unicode) – A string representing the HTTP method to use when making a request to commands_url
  • sms_commands_url (unicode) – 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
  • sms_commands_method (unicode) – A string representing the HTTP method to use when making a request to sms_commands_url
Returns:

The updated FleetInstance

Return type:

twilio.rest.supersim.v1.fleet.FleetInstance

url
Returns:The absolute URL of the Fleet resource
Return type:unicode
class twilio.rest.supersim.v1.fleet.FleetList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

create(network_access_profile, unique_name=<object object>, data_enabled=<object object>, data_limit=<object object>, commands_enabled=<object object>, commands_url=<object object>, commands_method=<object object>, sms_commands_enabled=<object object>, sms_commands_url=<object object>, sms_commands_method=<object object>)[source]

Create the FleetInstance

Parameters:
  • network_access_profile (unicode) – The SID or unique name of the Network Access Profile of the Fleet
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • data_enabled (bool) – Defines whether SIMs in the Fleet are capable of using data connectivity
  • data_limit (unicode) – The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume
  • commands_enabled (bool) – Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
  • commands_url (unicode) – 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
  • commands_method (unicode) – A string representing the HTTP method to use when making a request to commands_url
  • sms_commands_enabled (bool) – Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
  • sms_commands_url (unicode) – 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
  • sms_commands_method (unicode) – A string representing the HTTP method to use when making a request to sms_commands_url
Returns:

The created FleetInstance

Return type:

twilio.rest.supersim.v1.fleet.FleetInstance

get(sid)[source]

Constructs a FleetContext

Parameters:sid – The SID that identifies the resource to fetch
Returns:twilio.rest.supersim.v1.fleet.FleetContext
Return type:twilio.rest.supersim.v1.fleet.FleetContext
get_page(target_url)[source]

Retrieve a specific page of FleetInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of FleetInstance
Return type:twilio.rest.supersim.v1.fleet.FleetPage
list(network_access_profile=<object object>, limit=None, page_size=None)[source]

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 (unicode) – The SID or unique name of the Network Access Profile of the Fleet
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.fleet.FleetInstance]

page(network_access_profile=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of FleetInstance records from the API. Request is executed immediately

Parameters:
  • network_access_profile (unicode) – The SID or unique name of the Network Access Profile of the Fleet
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of FleetInstance

Return type:

twilio.rest.supersim.v1.fleet.FleetPage

stream(network_access_profile=<object object>, limit=None, page_size=None)[source]

Streams FleetInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • network_access_profile (unicode) – The SID or unique name of the Network Access Profile of the Fleet
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.fleet.FleetInstance]

class twilio.rest.supersim.v1.fleet.FleetPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_instance(payload)[source]

Build an instance of FleetInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.supersim.v1.fleet.FleetInstance
Return type:twilio.rest.supersim.v1.fleet.FleetInstance

twilio.rest.supersim.v1.network module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/supersim/v1/network.py:docstring of twilio.rest.supersim.v1.network, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.supersim.v1.network.NetworkContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

fetch()[source]

Fetch the NetworkInstance

Returns:The fetched NetworkInstance
Return type:twilio.rest.supersim.v1.network.NetworkInstance
class twilio.rest.supersim.v1.network.NetworkInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

fetch()[source]

Fetch the NetworkInstance

Returns:The fetched NetworkInstance
Return type:twilio.rest.supersim.v1.network.NetworkInstance
friendly_name
Returns:A human readable identifier of this resource
Return type:unicode
identifiers
Returns:The MCC/MNCs included in the Network resource
Return type:list[dict]
iso_country
Returns:The ISO country code of the Network resource
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
url
Returns:The absolute URL of the Network resource
Return type:unicode
class twilio.rest.supersim.v1.network.NetworkList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get(sid)[source]

Constructs a NetworkContext

Parameters:sid – The SID of the Network resource to fetch
Returns:twilio.rest.supersim.v1.network.NetworkContext
Return type:twilio.rest.supersim.v1.network.NetworkContext
get_page(target_url)[source]

Retrieve a specific page of NetworkInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of NetworkInstance
Return type:twilio.rest.supersim.v1.network.NetworkPage
list(iso_country=<object object>, mcc=<object object>, mnc=<object object>, limit=None, page_size=None)[source]

Lists NetworkInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • iso_country (unicode) – The ISO country code of the Network resources to read
  • mcc (unicode) – The MCC of Network resource identifiers to be read
  • mnc (unicode) – The MNC of Network resource identifiers to be read
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.network.NetworkInstance]

page(iso_country=<object object>, mcc=<object object>, mnc=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of NetworkInstance records from the API. Request is executed immediately

Parameters:
  • iso_country (unicode) – The ISO country code of the Network resources to read
  • mcc (unicode) – The MCC of Network resource identifiers to be read
  • mnc (unicode) – The MNC of Network resource identifiers to be read
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of NetworkInstance

Return type:

twilio.rest.supersim.v1.network.NetworkPage

stream(iso_country=<object object>, mcc=<object object>, mnc=<object object>, limit=None, page_size=None)[source]

Streams NetworkInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • iso_country (unicode) – The ISO country code of the Network resources to read
  • mcc (unicode) – The MCC of Network resource identifiers to be read
  • mnc (unicode) – The MNC of Network resource identifiers to be read
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.network.NetworkInstance]

class twilio.rest.supersim.v1.network.NetworkPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_instance(payload)[source]

Build an instance of NetworkInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.supersim.v1.network.NetworkInstance
Return type:twilio.rest.supersim.v1.network.NetworkInstance

twilio.rest.supersim.v1.sms_command module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/supersim/v1/sms_command.py:docstring of twilio.rest.supersim.v1.sms_command, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.supersim.v1.sms_command.SmsCommandContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

fetch()[source]

Fetch the SmsCommandInstance

Returns:The fetched SmsCommandInstance
Return type:twilio.rest.supersim.v1.sms_command.SmsCommandInstance
class twilio.rest.supersim.v1.sms_command.SmsCommandInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

class Direction[source]

Bases: object

FROM_SIM = 'from_sim'
TO_SIM = 'to_sim'
class Status[source]

Bases: object

DELIVERED = 'delivered'
FAILED = 'failed'
QUEUED = 'queued'
RECEIVED = 'received'
SENT = 'sent'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
direction
Returns:The direction of the SMS Command
Return type:SmsCommandInstance.Direction
fetch()[source]

Fetch the SmsCommandInstance

Returns:The fetched SmsCommandInstance
Return type:twilio.rest.supersim.v1.sms_command.SmsCommandInstance
payload
Returns:The message body of the SMS Command sent to or from the SIM
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
sim_sid
Returns:The SID of the SIM that this SMS Command was sent to or from
Return type:unicode
status
Returns:The status of the SMS Command
Return type:SmsCommandInstance.Status
url
Returns:The absolute URL of the SMS Command resource
Return type:unicode
class twilio.rest.supersim.v1.sms_command.SmsCommandList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

create(sim, payload, callback_method=<object object>, callback_url=<object object>)[source]

Create the SmsCommandInstance

Parameters:
  • sim (unicode) – The sid or unique_name of the SIM to send the SMS Command to
  • payload (unicode) – The message body of the SMS Command
  • callback_method (unicode) – The HTTP method we should use to call callback_url
  • callback_url (unicode) – The URL we should call after we have sent the command
Returns:

The created SmsCommandInstance

Return type:

twilio.rest.supersim.v1.sms_command.SmsCommandInstance

get(sid)[source]

Constructs a SmsCommandContext

Parameters:sid – The SID that identifies the resource to fetch
Returns:twilio.rest.supersim.v1.sms_command.SmsCommandContext
Return type:twilio.rest.supersim.v1.sms_command.SmsCommandContext
get_page(target_url)[source]

Retrieve a specific page of SmsCommandInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of SmsCommandInstance
Return type:twilio.rest.supersim.v1.sms_command.SmsCommandPage
list(sim=<object object>, status=<object object>, direction=<object object>, limit=None, page_size=None)[source]

Lists SmsCommandInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • sim (unicode) – The SID or unique name of the Sim resource that SMS Command was sent to or from.
  • status (SmsCommandInstance.Status) – The status of the SMS Command
  • direction (SmsCommandInstance.Direction) – The direction of the SMS Command
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.sms_command.SmsCommandInstance]

page(sim=<object object>, status=<object object>, direction=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of SmsCommandInstance records from the API. Request is executed immediately

Parameters:
  • sim (unicode) – The SID or unique name of the Sim resource that SMS Command was sent to or from.
  • status (SmsCommandInstance.Status) – The status of the SMS Command
  • direction (SmsCommandInstance.Direction) – The direction of the SMS Command
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of SmsCommandInstance

Return type:

twilio.rest.supersim.v1.sms_command.SmsCommandPage

stream(sim=<object object>, status=<object object>, direction=<object object>, limit=None, page_size=None)[source]

Streams SmsCommandInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • sim (unicode) – The SID or unique name of the Sim resource that SMS Command was sent to or from.
  • status (SmsCommandInstance.Status) – The status of the SMS Command
  • direction (SmsCommandInstance.Direction) – The direction of the SMS Command
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.sms_command.SmsCommandInstance]

class twilio.rest.supersim.v1.sms_command.SmsCommandPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_instance(payload)[source]

Build an instance of SmsCommandInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.supersim.v1.sms_command.SmsCommandInstance
Return type:twilio.rest.supersim.v1.sms_command.SmsCommandInstance

twilio.rest.supersim.v1.usage_record module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/supersim/v1/usage_record.py:docstring of twilio.rest.supersim.v1.usage_record, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.supersim.v1.usage_record.UsageRecordInstance(version, payload)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

class Granularity[source]

Bases: object

ALL = 'all'
DAY = 'day'
HOUR = 'hour'
class Group[source]

Bases: object

FLEET = 'fleet'
ISOCOUNTRY = 'isoCountry'
NETWORK = 'network'
SIM = 'sim'
class SortBy[source]

Bases: object

TIME = 'time'
account_sid
Returns:The SID of the Account that incurred the usage.
Return type:unicode
data_download
Returns:Total data downloaded in bytes, aggregated by the query parameters.
Return type:unicode
data_total
Returns:Total of data_upload and data_download.
Return type:unicode
data_upload
Returns:Total data uploaded in bytes, aggregated by the query parameters.
Return type:unicode
fleet_sid
Returns:SID of the Fleet resource on which the usage occurred.
Return type:unicode
iso_country
Returns:Alpha-2 ISO Country Code of the country the usage occurred in.
Return type:unicode
network_sid
Returns:SID of the Network resource on which the usage occurred.
Return type:unicode
period
Returns:The time period for which the usage is reported.
Return type:dict
sim_sid
Returns:SID of a Sim resource to which the UsageRecord belongs.
Return type:unicode
class twilio.rest.supersim.v1.usage_record.UsageRecordList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_page(target_url)[source]

Retrieve a specific page of UsageRecordInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of UsageRecordInstance
Return type:twilio.rest.supersim.v1.usage_record.UsageRecordPage
list(sim=<object object>, fleet=<object object>, network=<object object>, iso_country=<object object>, group=<object object>, granularity=<object object>, start_time=<object object>, end_time=<object object>, limit=None, page_size=None)[source]

Lists UsageRecordInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • sim (unicode) – SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
  • fleet (unicode) – SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
  • network (unicode) – SID of a Network resource. Only show UsageRecords representing usage on this network.
  • iso_country (unicode) – Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
  • group (UsageRecordInstance.Group) – Dimension over which to aggregate usage records.
  • granularity (UsageRecordInstance.Granularity) – Time-based grouping that UsageRecords should be aggregated by. Can be: hour, day, or all. Default is all.
  • start_time (datetime) – Only include usage that occurred at or after this time.
  • end_time (datetime) – Only include usage that occurred before this time.
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.usage_record.UsageRecordInstance]

page(sim=<object object>, fleet=<object object>, network=<object object>, iso_country=<object object>, group=<object object>, granularity=<object object>, start_time=<object object>, end_time=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of UsageRecordInstance records from the API. Request is executed immediately

Parameters:
  • sim (unicode) – SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
  • fleet (unicode) – SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
  • network (unicode) – SID of a Network resource. Only show UsageRecords representing usage on this network.
  • iso_country (unicode) – Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
  • group (UsageRecordInstance.Group) – Dimension over which to aggregate usage records.
  • granularity (UsageRecordInstance.Granularity) – Time-based grouping that UsageRecords should be aggregated by. Can be: hour, day, or all. Default is all.
  • start_time (datetime) – Only include usage that occurred at or after this time.
  • end_time (datetime) – Only include usage that occurred before this time.
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of UsageRecordInstance

Return type:

twilio.rest.supersim.v1.usage_record.UsageRecordPage

stream(sim=<object object>, fleet=<object object>, network=<object object>, iso_country=<object object>, group=<object object>, granularity=<object object>, start_time=<object object>, end_time=<object object>, limit=None, page_size=None)[source]

Streams UsageRecordInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • sim (unicode) – SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
  • fleet (unicode) – SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
  • network (unicode) – SID of a Network resource. Only show UsageRecords representing usage on this network.
  • iso_country (unicode) – Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
  • group (UsageRecordInstance.Group) – Dimension over which to aggregate usage records.
  • granularity (UsageRecordInstance.Granularity) – Time-based grouping that UsageRecords should be aggregated by. Can be: hour, day, or all. Default is all.
  • start_time (datetime) – Only include usage that occurred at or after this time.
  • end_time (datetime) – Only include usage that occurred before this time.
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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:

Generator that will yield up to limit results

Return type:

list[twilio.rest.supersim.v1.usage_record.UsageRecordInstance]

class twilio.rest.supersim.v1.usage_record.UsageRecordPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_instance(payload)[source]

Build an instance of UsageRecordInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.supersim.v1.usage_record.UsageRecordInstance
Return type:twilio.rest.supersim.v1.usage_record.UsageRecordInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/supersim/v1/__init__.py:docstring of twilio.rest.supersim.v1, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.supersim.v1.V1(domain)[source]

Bases: twilio.base.version.Version

commands
Return type:twilio.rest.supersim.v1.command.CommandList
fleets
Return type:twilio.rest.supersim.v1.fleet.FleetList
network_access_profiles
Return type:twilio.rest.supersim.v1.network_access_profile.NetworkAccessProfileList
networks
Return type:twilio.rest.supersim.v1.network.NetworkList
sims
Return type:twilio.rest.supersim.v1.sim.SimList
sms_commands
Return type:twilio.rest.supersim.v1.sms_command.SmsCommandList
usage_records
Return type:twilio.rest.supersim.v1.usage_record.UsageRecordList