twilio.rest.supersim.v1 package

Submodules

twilio.rest.supersim.v1.esim_profile module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.supersim.v1.esim_profile.EsimProfileContext(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 EsimProfileInstance

Returns:The fetched EsimProfileInstance
Return type:twilio.rest.supersim.v1.esim_profile.EsimProfileInstance
class twilio.rest.supersim.v1.esim_profile.EsimProfileInstance(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 Status[source]

Bases: object

AVAILABLE = 'available'
DOWNLOADED = 'downloaded'
FAILED = 'failed'
INSTALLED = 'installed'
NEW = 'new'
RESERVING = 'reserving'
account_sid
Returns:The SID of the Account to which the eSIM Profile resource belongs
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
eid
Returns:Identifier of the eUICC that can claim the eSIM Profile
Return type:unicode
error_code
Returns:Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state
Return type:unicode
error_message
Returns:Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state
Return type:unicode
fetch()[source]

Fetch the EsimProfileInstance

Returns:The fetched EsimProfileInstance
Return type:twilio.rest.supersim.v1.esim_profile.EsimProfileInstance
iccid
Returns:The ICCID associated with the Sim resource
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
sim_sid
Returns:The SID of the Sim resource that this eSIM Profile controls
Return type:unicode
smdp_plus_address
Returns:Address of the SM-DP+ server from which the Profile will be downloaded
Return type:unicode
status
Returns:The status of the eSIM Profile
Return type:EsimProfileInstance.Status
url
Returns:The absolute URL of the eSIM Profile resource
Return type:unicode
class twilio.rest.supersim.v1.esim_profile.EsimProfileList(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(callback_url=<object object>, callback_method=<object object>, eid=<object object>)[source]

Create the EsimProfileInstance

Parameters:
  • callback_url (unicode) – The URL we should call after we have sent when the status of the eSIM Profile changes
  • callback_method (unicode) – The HTTP method we should use to call callback_url
  • eid (unicode) – Identifier of the eUICC that will claim the eSIM Profile
Returns:

The created EsimProfileInstance

Return type:

twilio.rest.supersim.v1.esim_profile.EsimProfileInstance

get(sid)[source]

Constructs a EsimProfileContext

Parameters:sid – The SID of the eSIM Profile resource to fetch
Returns:twilio.rest.supersim.v1.esim_profile.EsimProfileContext
Return type:twilio.rest.supersim.v1.esim_profile.EsimProfileContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of EsimProfileInstance
Return type:twilio.rest.supersim.v1.esim_profile.EsimProfilePage
list(eid=<object object>, sim_sid=<object object>, status=<object object>, limit=None, page_size=None)[source]

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

Parameters:
  • eid (unicode) – List the eSIM Profiles that have been associated with an EId
  • sim_sid (unicode) – Find the eSIM Profile resource related to a Sim resource by providing the SIM SID
  • status (EsimProfileInstance.Status) – List the eSIM Profiles that are in a given status
  • 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.esim_profile.EsimProfileInstance]

page(eid=<object object>, sim_sid=<object object>, status=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • eid (unicode) – List the eSIM Profiles that have been associated with an EId
  • sim_sid (unicode) – Find the eSIM Profile resource related to a Sim resource by providing the SIM SID
  • status (EsimProfileInstance.Status) – List the eSIM Profiles that are in a given status
  • 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 EsimProfileInstance

Return type:

twilio.rest.supersim.v1.esim_profile.EsimProfilePage

stream(eid=<object object>, sim_sid=<object object>, status=<object object>, limit=None, page_size=None)[source]

Streams EsimProfileInstance 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:
  • eid (unicode) – List the eSIM Profiles that have been associated with an EId
  • sim_sid (unicode) – Find the eSIM Profile resource related to a Sim resource by providing the SIM SID
  • status (EsimProfileInstance.Status) – List the eSIM Profiles that are in a given status
  • 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.esim_profile.EsimProfileInstance]

class twilio.rest.supersim.v1.esim_profile.EsimProfilePage(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 EsimProfileInstance

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

twilio.rest.supersim.v1.fleet module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
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>, ip_commands_url=<object object>, ip_commands_method=<object object>, sms_commands_url=<object object>, sms_commands_method=<object object>, data_limit=<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
  • ip_commands_url (unicode) – The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device
  • ip_commands_method (unicode) – A string representing the HTTP method to use when making a request to ip_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
  • data_limit (unicode) – The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume
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
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 Super SIM assigned to the Fleet 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
ip_commands_method
Returns:A string representing the HTTP method to use when making a request to ip_commands_url
Return type:unicode
ip_commands_url
Returns:The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device
Return type:unicode
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>, ip_commands_url=<object object>, ip_commands_method=<object object>, sms_commands_url=<object object>, sms_commands_method=<object object>, data_limit=<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
  • ip_commands_url (unicode) – The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device
  • ip_commands_method (unicode) – A string representing the HTTP method to use when making a request to ip_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
  • data_limit (unicode) – The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume
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>, ip_commands_url=<object object>, ip_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 Super SIM resource assigned to the Fleet can consume
  • ip_commands_url (unicode) – The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device
  • ip_commands_method (unicode) – A string representing the HTTP method to use when making a request to ip_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.ip_command module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.supersim.v1.ip_command.IpCommandContext(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 IpCommandInstance

Returns:The fetched IpCommandInstance
Return type:twilio.rest.supersim.v1.ip_command.IpCommandInstance
class twilio.rest.supersim.v1.ip_command.IpCommandInstance(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 PayloadType[source]

Bases: object

BINARY = 'binary'
TEXT = 'text'
class Status[source]

Bases: object

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
device_ip
Returns:The IP address of the device that the IP Command was sent to or received from
Return type:unicode
device_port
Returns:The port that the IP Command either originated from or was sent to
Return type:unicode
direction
Returns:The direction of the IP Command
Return type:IpCommandInstance.Direction
fetch()[source]

Fetch the IpCommandInstance

Returns:The fetched IpCommandInstance
Return type:twilio.rest.supersim.v1.ip_command.IpCommandInstance
payload
Returns:The payload of the IP Command sent to or from the Super SIM
Return type:unicode
payload_type
Returns:The payload type of the IP Command
Return type:IpCommandInstance.PayloadType
sid
Returns:The unique string that identifies the resource
Return type:unicode
sim_iccid
Returns:The ICCID of the Super SIM that this IP Command was sent to or from
Return type:unicode
sim_sid
Returns:The SID of the Super SIM that this IP Command was sent to or from
Return type:unicode
status
Returns:The status of the IP Command
Return type:IpCommandInstance.Status
url
Returns:The absolute URL of the IP Command resource
Return type:unicode
class twilio.rest.supersim.v1.ip_command.IpCommandList(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, device_port, payload_type=<object object>, callback_url=<object object>, callback_method=<object object>)[source]

Create the IpCommandInstance

Parameters:
  • sim (unicode) – The sid or unique_name of the Super SIM to send the IP Command to
  • payload (unicode) – The payload to be delivered to the device
  • device_port (unicode) – The device port to which the IP Command will be sent
  • payload_type (IpCommandInstance.PayloadType) – Indicates how the payload is encoded
  • callback_url (unicode) – The URL we should call after we have sent the IP Command
  • callback_method (unicode) – The HTTP method we should use to call callback_url
Returns:

The created IpCommandInstance

Return type:

twilio.rest.supersim.v1.ip_command.IpCommandInstance

get(sid)[source]

Constructs a IpCommandContext

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

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

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

Lists IpCommandInstance 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 IP Command was sent to or from.
  • sim_iccid (unicode) – The ICCID of the Sim resource that IP Command was sent to or from.
  • status (IpCommandInstance.Status) – The status of the IP Command
  • direction (IpCommandInstance.Direction) – The direction of the IP 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.ip_command.IpCommandInstance]

page(sim=<object object>, sim_iccid=<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 IpCommandInstance records from the API. Request is executed immediately

Parameters:
  • sim (unicode) – The SID or unique name of the Sim resource that IP Command was sent to or from.
  • sim_iccid (unicode) – The ICCID of the Sim resource that IP Command was sent to or from.
  • status (IpCommandInstance.Status) – The status of the IP Command
  • direction (IpCommandInstance.Direction) – The direction of the IP 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 IpCommandInstance

Return type:

twilio.rest.supersim.v1.ip_command.IpCommandPage

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

Streams IpCommandInstance 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 IP Command was sent to or from.
  • sim_iccid (unicode) – The ICCID of the Sim resource that IP Command was sent to or from.
  • status (IpCommandInstance.Status) – The status of the IP Command
  • direction (IpCommandInstance.Direction) – The direction of the IP 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.ip_command.IpCommandInstance]

class twilio.rest.supersim.v1.ip_command.IpCommandPage(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 IpCommandInstance

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

twilio.rest.supersim.v1.network module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
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 / /
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 / /
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
billed_unit
Returns:The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. USD, EUR, JPY).
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_total_billed
Returns:Total amount in the billed_unit that was charged for the data uploaded or downloaded.
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 (exclusive).
  • 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 (exclusive).
  • 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 (exclusive).
  • 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 / /
class twilio.rest.supersim.v1.V1(domain)[source]

Bases: twilio.base.version.Version

esim_profiles
Return type:twilio.rest.supersim.v1.esim_profile.EsimProfileList
fleets
Return type:twilio.rest.supersim.v1.fleet.FleetList
ip_commands
Return type:twilio.rest.supersim.v1.ip_command.IpCommandList
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