twilio.rest.preview.wireless package¶
Subpackages¶
Submodules¶
twilio.rest.preview.wireless.command module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.wireless.command.
CommandContext
(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 CommandInstance
Returns: The fetched CommandInstance Return type: twilio.rest.preview.wireless.command.CommandInstance
-
-
class
twilio.rest.preview.wireless.command.
CommandInstance
(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
-
command
¶ Returns: The command Return type: unicode
-
command_mode
¶ Returns: The command_mode Return type: unicode
-
date_created
¶ Returns: The date_created Return type: datetime
-
date_updated
¶ Returns: The date_updated Return type: datetime
-
device_sid
¶ Returns: The device_sid Return type: unicode
-
direction
¶ Returns: The direction Return type: unicode
-
fetch
()[source]¶ Fetch the CommandInstance
Returns: The fetched CommandInstance Return type: twilio.rest.preview.wireless.command.CommandInstance
-
sid
¶ Returns: The sid Return type: unicode
-
sim_sid
¶ Returns: The sim_sid Return type: unicode
-
status
¶ Returns: The status Return type: unicode
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.preview.wireless.command.
CommandList
(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.
-
create
(command, device=<object object>, sim=<object object>, callback_method=<object object>, callback_url=<object object>, command_mode=<object object>, include_sid=<object object>)[source]¶ Create the CommandInstance
Parameters: - command (unicode) – The command
- device (unicode) – The device
- sim (unicode) – The sim
- callback_method (unicode) – The callback_method
- callback_url (unicode) – The callback_url
- command_mode (unicode) – The command_mode
- include_sid (unicode) – The include_sid
Returns: The created CommandInstance
Return type:
-
get
(sid)[source]¶ Constructs a CommandContext
Parameters: sid – The sid Returns: twilio.rest.preview.wireless.command.CommandContext Return type: twilio.rest.preview.wireless.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.preview.wireless.command.CommandPage
-
list
(device=<object object>, 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: - device (unicode) – The device
- sim (unicode) – The sim
- status (unicode) – The status
- direction (unicode) – The direction
- 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
(device=<object object>, 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: - device (unicode) – The device
- sim (unicode) – The sim
- status (unicode) – The status
- direction (unicode) – The direction
- 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:
-
stream
(device=<object object>, 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: - device (unicode) – The device
- sim (unicode) – The sim
- status (unicode) – The status
- direction (unicode) – The direction
- 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.preview.wireless.command.
CommandPage
(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 CommandInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.wireless.command.CommandInstance Return type: twilio.rest.preview.wireless.command.CommandInstance
-
twilio.rest.preview.wireless.rate_plan module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.wireless.rate_plan.
RatePlanContext
(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.
-
delete
()[source]¶ Deletes the RatePlanInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the RatePlanInstance
Returns: The fetched RatePlanInstance Return type: twilio.rest.preview.wireless.rate_plan.RatePlanInstance
-
-
class
twilio.rest.preview.wireless.rate_plan.
RatePlanInstance
(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
-
data_limit
¶ Returns: The data_limit Return type: unicode
-
data_metering
¶ Returns: The data_metering Return type: unicode
-
date_created
¶ Returns: The date_created Return type: datetime
-
date_updated
¶ Returns: The date_updated Return type: datetime
-
delete
()[source]¶ Deletes the RatePlanInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the RatePlanInstance
Returns: The fetched RatePlanInstance Return type: twilio.rest.preview.wireless.rate_plan.RatePlanInstance
-
friendly_name
¶ Returns: The friendly_name Return type: unicode
-
sid
¶ Returns: The sid Return type: unicode
-
unique_name
¶ Returns: The unique_name Return type: unicode
-
update
(unique_name=<object object>, friendly_name=<object object>)[source]¶ Update the RatePlanInstance
Parameters: - unique_name (unicode) – The unique_name
- friendly_name (unicode) – The friendly_name
Returns: The updated RatePlanInstance
Return type:
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.preview.wireless.rate_plan.
RatePlanList
(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.
-
create
(unique_name=<object object>, friendly_name=<object object>, data_enabled=<object object>, data_limit=<object object>, data_metering=<object object>, messaging_enabled=<object object>, voice_enabled=<object object>, commands_enabled=<object object>, national_roaming_enabled=<object object>, international_roaming=<object object>)[source]¶ Create the RatePlanInstance
Parameters: - unique_name (unicode) – The unique_name
- friendly_name (unicode) – The friendly_name
- data_enabled (bool) – The data_enabled
- data_limit (unicode) – The data_limit
- data_metering (unicode) – The data_metering
- messaging_enabled (bool) – The messaging_enabled
- voice_enabled (bool) – The voice_enabled
- commands_enabled (bool) – The commands_enabled
- national_roaming_enabled (bool) – The national_roaming_enabled
- international_roaming (list[unicode]) – The international_roaming
Returns: The created RatePlanInstance
Return type:
-
get
(sid)[source]¶ Constructs a RatePlanContext
Parameters: sid – The sid Returns: twilio.rest.preview.wireless.rate_plan.RatePlanContext Return type: twilio.rest.preview.wireless.rate_plan.RatePlanContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of RatePlanInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of RatePlanInstance Return type: twilio.rest.preview.wireless.rate_plan.RatePlanPage
-
list
(limit=None, page_size=None)[source]¶ Lists RatePlanInstance 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.preview.wireless.rate_plan.RatePlanInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of RatePlanInstance records from the API. Request is executed immediately
Parameters: Returns: Page of RatePlanInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams RatePlanInstance 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.preview.wireless.rate_plan.RatePlanInstance]
-
-
class
twilio.rest.preview.wireless.rate_plan.
RatePlanPage
(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 RatePlanInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.wireless.rate_plan.RatePlanInstance Return type: twilio.rest.preview.wireless.rate_plan.RatePlanInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.wireless.
Wireless
(domain)[source]¶ Bases:
twilio.base.version.Version
-
commands
¶ Return type: twilio.rest.preview.wireless.command.CommandList
-
rate_plans
¶ Return type: twilio.rest.preview.wireless.rate_plan.RatePlanList
-
sims
¶ Return type: twilio.rest.preview.wireless.sim.SimList
-