twilio.rest.supersim.v1.sim package¶
Submodules¶
twilio.rest.supersim.v1.sim.billing_period module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.supersim.v1.sim.billing_period.
BillingPeriodInstance
(version, payload, sim_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account the Super SIM belongs to 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
-
end_time
¶ Returns: The end time of the Billing Period Return type: datetime
-
period_type
¶ Returns: The type of the Billing Period Return type: BillingPeriodInstance.BpType
-
sid
¶ Returns: The SID of the Billing Period Return type: unicode
-
sim_sid
¶ Returns: The SID of the Super SIM the Billing Period belongs to Return type: unicode
-
start_time
¶ Returns: The start time of the Billing Period Return type: datetime
-
-
class
twilio.rest.supersim.v1.sim.billing_period.
BillingPeriodList
(version, sim_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get_page
(target_url)[source]¶ Retrieve a specific page of BillingPeriodInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of BillingPeriodInstance Return type: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodPage
-
list
(limit=None, page_size=None)[source]¶ Lists BillingPeriodInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - 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.sim.billing_period.BillingPeriodInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of BillingPeriodInstance records from the API. Request is executed immediately
Parameters: Returns: Page of BillingPeriodInstance
Return type: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodPage
-
stream
(limit=None, page_size=None)[source]¶ Streams BillingPeriodInstance 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: - 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.sim.billing_period.BillingPeriodInstance]
-
-
class
twilio.rest.supersim.v1.sim.billing_period.
BillingPeriodPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of BillingPeriodInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodInstance Return type: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodInstance
-
twilio.rest.supersim.v1.sim.sim_ip_address module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.supersim.v1.sim.sim_ip_address.
SimIpAddressInstance
(version, payload, sim_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
ip_address
¶ Returns: IP address assigned to the given Super SIM Return type: unicode
-
ip_address_version
¶ Returns: IP address version Return type: SimIpAddressInstance.IpAddressVersion
-
-
class
twilio.rest.supersim.v1.sim.sim_ip_address.
SimIpAddressList
(version, sim_sid)[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 SimIpAddressInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of SimIpAddressInstance Return type: twilio.rest.supersim.v1.sim.sim_ip_address.SimIpAddressPage
-
list
(limit=None, page_size=None)[source]¶ Lists SimIpAddressInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - 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.sim.sim_ip_address.SimIpAddressInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of SimIpAddressInstance records from the API. Request is executed immediately
Parameters: Returns: Page of SimIpAddressInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams SimIpAddressInstance 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: - 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.sim.sim_ip_address.SimIpAddressInstance]
-
-
class
twilio.rest.supersim.v1.sim.sim_ip_address.
SimIpAddressPage
(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 SimIpAddressInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.supersim.v1.sim.sim_ip_address.SimIpAddressInstance Return type: twilio.rest.supersim.v1.sim.sim_ip_address.SimIpAddressInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.supersim.v1.sim.
SimContext
(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.
-
billing_periods
¶ Access the billing_periods
Returns: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodList Return type: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodList
-
fetch
()[source]¶ Fetch the SimInstance
Returns: The fetched SimInstance Return type: twilio.rest.supersim.v1.sim.SimInstance
-
sim_ip_addresses
¶ Access the sim_ip_addresses
Returns: twilio.rest.supersim.v1.sim.sim_ip_address.SimIpAddressList Return type: twilio.rest.supersim.v1.sim.sim_ip_address.SimIpAddressList
-
update
(unique_name=<object object>, status=<object object>, fleet=<object object>, callback_url=<object object>, callback_method=<object object>, account_sid=<object object>)[source]¶ Update the SimInstance
Parameters: - unique_name (unicode) – An application-defined string that uniquely identifies the resource
- status (SimInstance.StatusUpdate) – The new status of the Super SIM
- fleet (unicode) – The SID or unique name of the Fleet to which the SIM resource should be assigned
- callback_url (unicode) – The URL we should call after the update has finished
- callback_method (unicode) – The HTTP method we should use to call callback_url
- account_sid (unicode) – The SID of the Account to which the Sim resource should belong
Returns: The updated SimInstance
Return type:
-
-
class
twilio.rest.supersim.v1.sim.
SimInstance
(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
-
ACTIVE
= 'active'¶
-
INACTIVE
= 'inactive'¶
-
NEW
= 'new'¶
-
READY
= 'ready'¶
-
SCHEDULED
= 'scheduled'¶
-
-
class
StatusUpdate
[source]¶ Bases:
object
-
ACTIVE
= 'active'¶
-
INACTIVE
= 'inactive'¶
-
READY
= 'ready'¶
-
-
account_sid
¶ Returns: The SID of the Account that the Super SIM belongs to Return type: unicode
-
billing_periods
¶ Access the billing_periods
Returns: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodList Return type: twilio.rest.supersim.v1.sim.billing_period.BillingPeriodList
-
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 SimInstance
Returns: The fetched SimInstance Return type: twilio.rest.supersim.v1.sim.SimInstance
-
fleet_sid
¶ Returns: The unique ID of the Fleet configured for this SIM Return type: unicode
-
iccid
¶ Returns: The ICCID associated with the SIM Return type: unicode
-
links
¶ Returns: The links Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
sim_ip_addresses
¶ Access the sim_ip_addresses
Returns: twilio.rest.supersim.v1.sim.sim_ip_address.SimIpAddressList Return type: twilio.rest.supersim.v1.sim.sim_ip_address.SimIpAddressList
-
status
¶ Returns: The status of the Super SIM Return type: SimInstance.Status
-
unique_name
¶ Returns: An application-defined string that uniquely identifies the resource Return type: unicode
-
update
(unique_name=<object object>, status=<object object>, fleet=<object object>, callback_url=<object object>, callback_method=<object object>, account_sid=<object object>)[source]¶ Update the SimInstance
Parameters: - unique_name (unicode) – An application-defined string that uniquely identifies the resource
- status (SimInstance.StatusUpdate) – The new status of the Super SIM
- fleet (unicode) – The SID or unique name of the Fleet to which the SIM resource should be assigned
- callback_url (unicode) – The URL we should call after the update has finished
- callback_method (unicode) – The HTTP method we should use to call callback_url
- account_sid (unicode) – The SID of the Account to which the Sim resource should belong
Returns: The updated SimInstance
Return type:
-
url
¶ Returns: The absolute URL of the Sim Resource Return type: unicode
-
class
-
class
twilio.rest.supersim.v1.sim.
SimList
(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
(iccid, registration_code)[source]¶ Create the SimInstance
Parameters: - iccid (unicode) – The ICCID of the Super SIM to be added to your Account
- registration_code (unicode) – The 10-digit code required to claim the Super SIM for your Account
Returns: The created SimInstance
Return type:
-
get
(sid)[source]¶ Constructs a SimContext
Parameters: sid – The SID that identifies the resource to fetch Returns: twilio.rest.supersim.v1.sim.SimContext Return type: twilio.rest.supersim.v1.sim.SimContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of SimInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of SimInstance Return type: twilio.rest.supersim.v1.sim.SimPage
-
list
(status=<object object>, fleet=<object object>, iccid=<object object>, limit=None, page_size=None)[source]¶ Lists SimInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - status (SimInstance.Status) – The status of the Sim resources to read
- fleet (unicode) – The SID or unique name of the Fleet to which a list of Sims are assigned
- iccid (unicode) – The ICCID associated with a Super SIM to filter the list by
- 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:
-
page
(status=<object object>, fleet=<object object>, iccid=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of SimInstance records from the API. Request is executed immediately
Parameters: - status (SimInstance.Status) – The status of the Sim resources to read
- fleet (unicode) – The SID or unique name of the Fleet to which a list of Sims are assigned
- iccid (unicode) – The ICCID associated with a Super SIM to filter the list by
- 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 SimInstance
Return type:
-
stream
(status=<object object>, fleet=<object object>, iccid=<object object>, limit=None, page_size=None)[source]¶ Streams SimInstance 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: - status (SimInstance.Status) – The status of the Sim resources to read
- fleet (unicode) – The SID or unique name of the Fleet to which a list of Sims are assigned
- iccid (unicode) – The ICCID associated with a Super SIM to filter the list by
- 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:
-
-
class
twilio.rest.supersim.v1.sim.
SimPage
(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 SimInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.supersim.v1.sim.SimInstance Return type: twilio.rest.supersim.v1.sim.SimInstance
-