twilio.rest.preview.wireless.sim package

Submodules

twilio.rest.preview.wireless.sim.usage module

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

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

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/preview/wireless/sim/usage.py:docstring of twilio.rest.preview.wireless.sim.usage, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.preview.wireless.sim.usage.UsageContext(version, sim_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

fetch(end=<object object>, start=<object object>)[source]

Fetch the UsageInstance

Parameters:
  • end (unicode) – The end
  • start (unicode) – The start
Returns:

The fetched UsageInstance

Return type:

twilio.rest.preview.wireless.sim.usage.UsageInstance

class twilio.rest.preview.wireless.sim.usage.UsageInstance(version, payload, sim_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

account_sid
Returns:The account_sid
Return type:unicode
commands_costs
Returns:The commands_costs
Return type:dict
commands_usage
Returns:The commands_usage
Return type:dict
data_costs
Returns:The data_costs
Return type:dict
data_usage
Returns:The data_usage
Return type:dict
fetch(end=<object object>, start=<object object>)[source]

Fetch the UsageInstance

Parameters:
  • end (unicode) – The end
  • start (unicode) – The start
Returns:

The fetched UsageInstance

Return type:

twilio.rest.preview.wireless.sim.usage.UsageInstance

period
Returns:The period
Return type:dict
sim_sid
Returns:The sim_sid
Return type:unicode
sim_unique_name
Returns:The sim_unique_name
Return type:unicode
url
Returns:The url
Return type:unicode
class twilio.rest.preview.wireless.sim.usage.UsageList(version, sim_sid)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

get()[source]

Constructs a UsageContext

Returns:twilio.rest.preview.wireless.sim.usage.UsageContext
Return type:twilio.rest.preview.wireless.sim.usage.UsageContext
class twilio.rest.preview.wireless.sim.usage.UsagePage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

get_instance(payload)[source]

Build an instance of UsageInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.preview.wireless.sim.usage.UsageInstance
Return type:twilio.rest.preview.wireless.sim.usage.UsageInstance

Module contents

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

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

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

Inline substitution_reference start-string without end-string.
class twilio.rest.preview.wireless.sim.SimContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

fetch()[source]

Fetch the SimInstance

Returns:The fetched SimInstance
Return type:twilio.rest.preview.wireless.sim.SimInstance
update(unique_name=<object object>, callback_method=<object object>, callback_url=<object object>, friendly_name=<object object>, rate_plan=<object object>, status=<object object>, commands_callback_method=<object object>, commands_callback_url=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>)[source]

Update the SimInstance

Parameters:
  • unique_name (unicode) – The unique_name
  • callback_method (unicode) – The callback_method
  • callback_url (unicode) – The callback_url
  • friendly_name (unicode) – The friendly_name
  • rate_plan (unicode) – The rate_plan
  • status (unicode) – The status
  • commands_callback_method (unicode) – The commands_callback_method
  • commands_callback_url (unicode) – The commands_callback_url
  • sms_fallback_method (unicode) – The sms_fallback_method
  • sms_fallback_url (unicode) – The sms_fallback_url
  • sms_method (unicode) – The sms_method
  • sms_url (unicode) – The sms_url
  • voice_fallback_method (unicode) – The voice_fallback_method
  • voice_fallback_url (unicode) – The voice_fallback_url
  • voice_method (unicode) – The voice_method
  • voice_url (unicode) – The voice_url
Returns:

The updated SimInstance

Return type:

twilio.rest.preview.wireless.sim.SimInstance

usage

Access the usage

Returns:twilio.rest.preview.wireless.sim.usage.UsageList
Return type:twilio.rest.preview.wireless.sim.usage.UsageList
class twilio.rest.preview.wireless.sim.SimInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

account_sid
Returns:The account_sid
Return type:unicode
commands_callback_method
Returns:The commands_callback_method
Return type:unicode
commands_callback_url
Returns:The commands_callback_url
Return type:unicode
date_created
Returns:The date_created
Return type:datetime
date_updated
Returns:The date_updated
Return type:datetime
e_id
Returns:The e_id
Return type:unicode
fetch()[source]

Fetch the SimInstance

Returns:The fetched SimInstance
Return type:twilio.rest.preview.wireless.sim.SimInstance
friendly_name
Returns:The friendly_name
Return type:unicode
iccid
Returns:The iccid
Return type:unicode
Returns:The links
Return type:unicode
rate_plan_sid
Returns:The rate_plan_sid
Return type:unicode
sid
Returns:The sid
Return type:unicode
sms_fallback_method
Returns:The sms_fallback_method
Return type:unicode
sms_fallback_url
Returns:The sms_fallback_url
Return type:unicode
sms_method
Returns:The sms_method
Return type:unicode
sms_url
Returns:The sms_url
Return type:unicode
status
Returns:The status
Return type:unicode
unique_name
Returns:The unique_name
Return type:unicode
update(unique_name=<object object>, callback_method=<object object>, callback_url=<object object>, friendly_name=<object object>, rate_plan=<object object>, status=<object object>, commands_callback_method=<object object>, commands_callback_url=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>)[source]

Update the SimInstance

Parameters:
  • unique_name (unicode) – The unique_name
  • callback_method (unicode) – The callback_method
  • callback_url (unicode) – The callback_url
  • friendly_name (unicode) – The friendly_name
  • rate_plan (unicode) – The rate_plan
  • status (unicode) – The status
  • commands_callback_method (unicode) – The commands_callback_method
  • commands_callback_url (unicode) – The commands_callback_url
  • sms_fallback_method (unicode) – The sms_fallback_method
  • sms_fallback_url (unicode) – The sms_fallback_url
  • sms_method (unicode) – The sms_method
  • sms_url (unicode) – The sms_url
  • voice_fallback_method (unicode) – The voice_fallback_method
  • voice_fallback_url (unicode) – The voice_fallback_url
  • voice_method (unicode) – The voice_method
  • voice_url (unicode) – The voice_url
Returns:

The updated SimInstance

Return type:

twilio.rest.preview.wireless.sim.SimInstance

url
Returns:The url
Return type:unicode
usage

Access the usage

Returns:twilio.rest.preview.wireless.sim.usage.UsageList
Return type:twilio.rest.preview.wireless.sim.usage.UsageList
voice_fallback_method
Returns:The voice_fallback_method
Return type:unicode
voice_fallback_url
Returns:The voice_fallback_url
Return type:unicode
voice_method
Returns:The voice_method
Return type:unicode
voice_url
Returns:The voice_url
Return type:unicode
class twilio.rest.preview.wireless.sim.SimList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

get(sid)[source]

Constructs a SimContext

Parameters:sid – The sid
Returns:twilio.rest.preview.wireless.sim.SimContext
Return type:twilio.rest.preview.wireless.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.preview.wireless.sim.SimPage
list(status=<object object>, iccid=<object object>, rate_plan=<object object>, e_id=<object object>, sim_registration_code=<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 (unicode) – The status
  • iccid (unicode) – The iccid
  • rate_plan (unicode) – The rate_plan
  • e_id (unicode) – The e_id
  • sim_registration_code (unicode) – The sim_registration_code
  • 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.preview.wireless.sim.SimInstance]

page(status=<object object>, iccid=<object object>, rate_plan=<object object>, e_id=<object object>, sim_registration_code=<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 (unicode) – The status
  • iccid (unicode) – The iccid
  • rate_plan (unicode) – The rate_plan
  • e_id (unicode) – The e_id
  • sim_registration_code (unicode) – The sim_registration_code
  • 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:

twilio.rest.preview.wireless.sim.SimPage

stream(status=<object object>, iccid=<object object>, rate_plan=<object object>, e_id=<object object>, sim_registration_code=<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 (unicode) – The status
  • iccid (unicode) – The iccid
  • rate_plan (unicode) – The rate_plan
  • e_id (unicode) – The e_id
  • sim_registration_code (unicode) – The sim_registration_code
  • 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.preview.wireless.sim.SimInstance]

class twilio.rest.preview.wireless.sim.SimPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

get_instance(payload)[source]

Build an instance of SimInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.preview.wireless.sim.SimInstance
Return type:twilio.rest.preview.wireless.sim.SimInstance