twilio.rest.microvisor.v1.device package

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.microvisor.v1.device.DeviceContext(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 DeviceInstance

Returns:The fetched DeviceInstance
Return type:twilio.rest.microvisor.v1.device.DeviceInstance
update(unique_name=<object object>, target_app=<object object>, logging_enabled=<object object>)[source]

Update the DeviceInstance

Parameters:
  • unique_name (unicode) – A unique, developer-assigned name for this Device.
  • target_app (unicode) – The target App SID or unique name.
  • logging_enabled (bool) – Whether to enable logging.
Returns:

The updated DeviceInstance

Return type:

twilio.rest.microvisor.v1.device.DeviceInstance

class twilio.rest.microvisor.v1.device.DeviceInstance(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:Account SID.
Return type:unicode
app
Returns:Information about the target App and the App reported by this Device.
Return type:dict
date_created
Returns:The date that this Device was created.
Return type:datetime
date_updated
Returns:The date that this Device was last updated.
Return type:datetime
fetch()[source]

Fetch the DeviceInstance

Returns:The fetched DeviceInstance
Return type:twilio.rest.microvisor.v1.device.DeviceInstance
Returns:The absolute URLs of related resources
Return type:unicode
logging
Returns:Object specifying whether application logging is enabled for this Device.
Return type:dict
sid
Returns:A string that uniquely identifies this Device.
Return type:unicode
unique_name
Returns:A developer-defined string that uniquely identifies the Device.
Return type:unicode
update(unique_name=<object object>, target_app=<object object>, logging_enabled=<object object>)[source]

Update the DeviceInstance

Parameters:
  • unique_name (unicode) – A unique, developer-assigned name for this Device.
  • target_app (unicode) – The target App SID or unique name.
  • logging_enabled (bool) – Whether to enable logging.
Returns:

The updated DeviceInstance

Return type:

twilio.rest.microvisor.v1.device.DeviceInstance

url
Returns:The URL of this resource.
Return type:unicode
class twilio.rest.microvisor.v1.device.DeviceList(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 DeviceContext

Parameters:sid – A string that uniquely identifies this Device.
Returns:twilio.rest.microvisor.v1.device.DeviceContext
Return type:twilio.rest.microvisor.v1.device.DeviceContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of DeviceInstance
Return type:twilio.rest.microvisor.v1.device.DevicePage
list(limit=None, page_size=None)[source]

Lists DeviceInstance 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.microvisor.v1.device.DeviceInstance]

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

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

Parameters:
  • 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 DeviceInstance

Return type:

twilio.rest.microvisor.v1.device.DevicePage

stream(limit=None, page_size=None)[source]

Streams DeviceInstance 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.microvisor.v1.device.DeviceInstance]

class twilio.rest.microvisor.v1.device.DevicePage(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 DeviceInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.microvisor.v1.device.DeviceInstance
Return type:twilio.rest.microvisor.v1.device.DeviceInstance