twilio.rest.preview.deployed_devices.fleet package¶
Submodules¶
twilio.rest.preview.deployed_devices.fleet.certificate module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.deployed_devices.fleet.certificate.
CertificateContext
(version, fleet_sid, 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 CertificateInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CertificateInstance
Returns: The fetched CertificateInstance Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
-
update
(friendly_name=<object object>, device_sid=<object object>)[source]¶ Update the CertificateInstance
Parameters: - friendly_name (unicode) – The human readable description for this Certificate.
- device_sid (unicode) – The unique identifier of a Device to be authenticated.
Returns: The updated CertificateInstance
Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
-
-
class
twilio.rest.preview.deployed_devices.fleet.certificate.
CertificateInstance
(version, payload, fleet_sid, 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 unique SID that identifies this Account. Return type: unicode
-
date_created
¶ Returns: The date this Certificate was created. Return type: datetime
-
date_updated
¶ Returns: The date this Certificate was updated. Return type: datetime
-
delete
()[source]¶ Deletes the CertificateInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
device_sid
¶ Returns: The unique identifier of a mapped Device. Return type: unicode
-
fetch
()[source]¶ Fetch the CertificateInstance
Returns: The fetched CertificateInstance Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
-
fleet_sid
¶ Returns: The unique identifier of the Fleet. Return type: unicode
-
friendly_name
¶ Returns: A human readable description for this Certificate. Return type: unicode
-
sid
¶ Returns: A string that uniquely identifies this Certificate. Return type: unicode
-
thumbprint
¶ Returns: A Certificate unique payload hash. Return type: unicode
-
update
(friendly_name=<object object>, device_sid=<object object>)[source]¶ Update the CertificateInstance
Parameters: - friendly_name (unicode) – The human readable description for this Certificate.
- device_sid (unicode) – The unique identifier of a Device to be authenticated.
Returns: The updated CertificateInstance
Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
-
url
¶ Returns: URL of this Certificate. Return type: unicode
-
-
class
twilio.rest.preview.deployed_devices.fleet.certificate.
CertificateList
(version, fleet_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.
-
create
(certificate_data, friendly_name=<object object>, device_sid=<object object>)[source]¶ Create the CertificateInstance
Parameters: - certificate_data (unicode) – The public certificate data.
- friendly_name (unicode) – The human readable description for this Certificate.
- device_sid (unicode) – The unique identifier of a Device to be authenticated.
Returns: The created CertificateInstance
Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
-
get
(sid)[source]¶ Constructs a CertificateContext
Parameters: sid – A string that uniquely identifies the Certificate. Returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CertificateInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CertificateInstance Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificatePage
-
list
(device_sid=<object object>, limit=None, page_size=None)[source]¶ Lists CertificateInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - device_sid (unicode) – Find all Certificates authenticating specified Device.
- 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.deployed_devices.fleet.certificate.CertificateInstance]
-
page
(device_sid=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CertificateInstance records from the API. Request is executed immediately
Parameters: Returns: Page of CertificateInstance
Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificatePage
-
stream
(device_sid=<object object>, limit=None, page_size=None)[source]¶ Streams CertificateInstance 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_sid (unicode) – Find all Certificates authenticating specified Device.
- 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.deployed_devices.fleet.certificate.CertificateInstance]
-
-
class
twilio.rest.preview.deployed_devices.fleet.certificate.
CertificatePage
(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 CertificateInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
-
twilio.rest.preview.deployed_devices.fleet.deployment module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.deployed_devices.fleet.deployment.
DeploymentContext
(version, fleet_sid, 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 DeploymentInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the DeploymentInstance
Returns: The fetched DeploymentInstance Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentInstance
-
update
(friendly_name=<object object>, sync_service_sid=<object object>)[source]¶ Update the DeploymentInstance
Parameters: - friendly_name (unicode) – A human readable description for this Deployment.
- sync_service_sid (unicode) – The unique identifier of the Sync service instance.
Returns: The updated DeploymentInstance
Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentInstance
-
-
class
twilio.rest.preview.deployed_devices.fleet.deployment.
DeploymentInstance
(version, payload, fleet_sid, 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 unique SID that identifies this Account. Return type: unicode
-
date_created
¶ Returns: The date this Deployment was created. Return type: datetime
-
date_updated
¶ Returns: The date this Deployment was updated. Return type: datetime
-
delete
()[source]¶ Deletes the DeploymentInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the DeploymentInstance
Returns: The fetched DeploymentInstance Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentInstance
-
fleet_sid
¶ Returns: The unique identifier of the Fleet. Return type: unicode
-
friendly_name
¶ Returns: A human readable description for this Deployment Return type: unicode
-
sid
¶ Returns: A string that uniquely identifies this Deployment. Return type: unicode
-
sync_service_sid
¶ Returns: The unique identifier of the Sync service instance. Return type: unicode
-
update
(friendly_name=<object object>, sync_service_sid=<object object>)[source]¶ Update the DeploymentInstance
Parameters: - friendly_name (unicode) – A human readable description for this Deployment.
- sync_service_sid (unicode) – The unique identifier of the Sync service instance.
Returns: The updated DeploymentInstance
Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentInstance
-
url
¶ Returns: URL of this Deployment. Return type: unicode
-
-
class
twilio.rest.preview.deployed_devices.fleet.deployment.
DeploymentList
(version, fleet_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.
-
create
(friendly_name=<object object>, sync_service_sid=<object object>)[source]¶ Create the DeploymentInstance
Parameters: - friendly_name (unicode) – A human readable description for this Deployment.
- sync_service_sid (unicode) – The unique identifier of the Sync service instance.
Returns: The created DeploymentInstance
Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentInstance
-
get
(sid)[source]¶ Constructs a DeploymentContext
Parameters: sid – A string that uniquely identifies the Deployment. Returns: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentContext Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of DeploymentInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of DeploymentInstance Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentPage
-
list
(limit=None, page_size=None)[source]¶ Lists DeploymentInstance 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.deployed_devices.fleet.deployment.DeploymentInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of DeploymentInstance records from the API. Request is executed immediately
Parameters: Returns: Page of DeploymentInstance
Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentPage
-
stream
(limit=None, page_size=None)[source]¶ Streams DeploymentInstance 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.deployed_devices.fleet.deployment.DeploymentInstance]
-
-
class
twilio.rest.preview.deployed_devices.fleet.deployment.
DeploymentPage
(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 DeploymentInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentInstance Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentInstance
-
twilio.rest.preview.deployed_devices.fleet.device module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.deployed_devices.fleet.device.
DeviceContext
(version, fleet_sid, 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 DeviceInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the DeviceInstance
Returns: The fetched DeviceInstance Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceInstance
-
update
(friendly_name=<object object>, identity=<object object>, deployment_sid=<object object>, enabled=<object object>)[source]¶ Update the DeviceInstance
Parameters: - friendly_name (unicode) – A human readable description for this Device.
- identity (unicode) – An identifier of the Device user.
- deployment_sid (unicode) – The unique SID of the Deployment group.
- enabled (bool) – The enabled
Returns: The updated DeviceInstance
Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceInstance
-
-
class
twilio.rest.preview.deployed_devices.fleet.device.
DeviceInstance
(version, payload, fleet_sid, 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 unique SID that identifies this Account. Return type: unicode
-
date_authenticated
¶ Returns: The date this Device was authenticated. Return type: datetime
-
date_created
¶ Returns: The date this Device was created. Return type: datetime
-
date_updated
¶ Returns: The date this Device was updated. Return type: datetime
-
delete
()[source]¶ Deletes the DeviceInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
deployment_sid
¶ Returns: The unique SID of the Deployment group. Return type: unicode
-
fetch
()[source]¶ Fetch the DeviceInstance
Returns: The fetched DeviceInstance Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceInstance
-
fleet_sid
¶ Returns: The unique identifier of the Fleet. Return type: unicode
-
friendly_name
¶ Returns: A human readable description for this Device Return type: unicode
-
identity
¶ Returns: An identifier of the Device user. Return type: unicode
-
sid
¶ Returns: A string that uniquely identifies this Device. Return type: unicode
-
unique_name
¶ Returns: A unique, addressable name of this Device. Return type: unicode
-
update
(friendly_name=<object object>, identity=<object object>, deployment_sid=<object object>, enabled=<object object>)[source]¶ Update the DeviceInstance
Parameters: - friendly_name (unicode) – A human readable description for this Device.
- identity (unicode) – An identifier of the Device user.
- deployment_sid (unicode) – The unique SID of the Deployment group.
- enabled (bool) – The enabled
Returns: The updated DeviceInstance
Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceInstance
-
url
¶ Returns: URL of this Device. Return type: unicode
-
-
class
twilio.rest.preview.deployed_devices.fleet.device.
DeviceList
(version, fleet_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.
-
create
(unique_name=<object object>, friendly_name=<object object>, identity=<object object>, deployment_sid=<object object>, enabled=<object object>)[source]¶ Create the DeviceInstance
Parameters: - unique_name (unicode) – A unique, addressable name of this Device.
- friendly_name (unicode) – A human readable description for this Device.
- identity (unicode) – An identifier of the Device user.
- deployment_sid (unicode) – The unique SID of the Deployment group.
- enabled (bool) – The enabled
Returns: The created DeviceInstance
Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceInstance
-
get
(sid)[source]¶ Constructs a DeviceContext
Parameters: sid – A string that uniquely identifies the Device. Returns: twilio.rest.preview.deployed_devices.fleet.device.DeviceContext Return type: twilio.rest.preview.deployed_devices.fleet.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.preview.deployed_devices.fleet.device.DevicePage
-
list
(deployment_sid=<object object>, 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: - deployment_sid (unicode) – Find all Devices grouped under the specified Deployment.
- 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.deployed_devices.fleet.device.DeviceInstance]
-
page
(deployment_sid=<object object>, 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: Returns: Page of DeviceInstance
Return type: twilio.rest.preview.deployed_devices.fleet.device.DevicePage
-
stream
(deployment_sid=<object object>, 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: - deployment_sid (unicode) – Find all Devices grouped under the specified Deployment.
- 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.deployed_devices.fleet.device.DeviceInstance]
-
-
class
twilio.rest.preview.deployed_devices.fleet.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.preview.deployed_devices.fleet.device.DeviceInstance Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceInstance
-
twilio.rest.preview.deployed_devices.fleet.key module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.deployed_devices.fleet.key.
KeyContext
(version, fleet_sid, 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 KeyInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the KeyInstance
Returns: The fetched KeyInstance Return type: twilio.rest.preview.deployed_devices.fleet.key.KeyInstance
-
update
(friendly_name=<object object>, device_sid=<object object>)[source]¶ Update the KeyInstance
Parameters: - friendly_name (unicode) – The human readable description for this Key.
- device_sid (unicode) – The unique identifier of a Key to be authenticated.
Returns: The updated KeyInstance
Return type:
-
-
class
twilio.rest.preview.deployed_devices.fleet.key.
KeyInstance
(version, payload, fleet_sid, 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 unique SID that identifies this Account. Return type: unicode
-
date_created
¶ Returns: The date this Key credential was created. Return type: datetime
-
date_updated
¶ Returns: The date this Key credential was updated. Return type: datetime
-
delete
()[source]¶ Deletes the KeyInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
device_sid
¶ Returns: The unique identifier of a mapped Device. Return type: unicode
-
fetch
()[source]¶ Fetch the KeyInstance
Returns: The fetched KeyInstance Return type: twilio.rest.preview.deployed_devices.fleet.key.KeyInstance
-
fleet_sid
¶ Returns: The unique identifier of the Fleet. Return type: unicode
-
friendly_name
¶ Returns: A human readable description for this Key. Return type: unicode
-
secret
¶ Returns: The key secret. Return type: unicode
-
sid
¶ Returns: A string that uniquely identifies this Key. Return type: unicode
-
update
(friendly_name=<object object>, device_sid=<object object>)[source]¶ Update the KeyInstance
Parameters: - friendly_name (unicode) – The human readable description for this Key.
- device_sid (unicode) – The unique identifier of a Key to be authenticated.
Returns: The updated KeyInstance
Return type:
-
url
¶ Returns: URL of this Key. Return type: unicode
-
-
class
twilio.rest.preview.deployed_devices.fleet.key.
KeyList
(version, fleet_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.
-
create
(friendly_name=<object object>, device_sid=<object object>)[source]¶ Create the KeyInstance
Parameters: - friendly_name (unicode) – The human readable description for this Key.
- device_sid (unicode) – The unique identifier of a Key to be authenticated.
Returns: The created KeyInstance
Return type:
-
get
(sid)[source]¶ Constructs a KeyContext
Parameters: sid – A string that uniquely identifies the Key. Returns: twilio.rest.preview.deployed_devices.fleet.key.KeyContext Return type: twilio.rest.preview.deployed_devices.fleet.key.KeyContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of KeyInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of KeyInstance Return type: twilio.rest.preview.deployed_devices.fleet.key.KeyPage
-
list
(device_sid=<object object>, limit=None, page_size=None)[source]¶ Lists KeyInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - device_sid (unicode) – Find all Keys authenticating specified Device.
- 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.deployed_devices.fleet.key.KeyInstance]
-
page
(device_sid=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of KeyInstance records from the API. Request is executed immediately
Parameters: Returns: Page of KeyInstance
Return type:
-
stream
(device_sid=<object object>, limit=None, page_size=None)[source]¶ Streams KeyInstance 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_sid (unicode) – Find all Keys authenticating specified Device.
- 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.deployed_devices.fleet.key.KeyInstance]
-
-
class
twilio.rest.preview.deployed_devices.fleet.key.
KeyPage
(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 KeyInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.deployed_devices.fleet.key.KeyInstance Return type: twilio.rest.preview.deployed_devices.fleet.key.KeyInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.deployed_devices.fleet.
FleetContext
(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.
-
certificates
¶ Access the certificates
Returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateList Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateList
-
delete
()[source]¶ Deletes the FleetInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
deployments
¶ Access the deployments
Returns: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentList Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentList
-
devices
¶ Access the devices
Returns: twilio.rest.preview.deployed_devices.fleet.device.DeviceList Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceList
-
fetch
()[source]¶ Fetch the FleetInstance
Returns: The fetched FleetInstance Return type: twilio.rest.preview.deployed_devices.fleet.FleetInstance
-
keys
¶ Access the keys
Returns: twilio.rest.preview.deployed_devices.fleet.key.KeyList Return type: twilio.rest.preview.deployed_devices.fleet.key.KeyList
-
update
(friendly_name=<object object>, default_deployment_sid=<object object>)[source]¶ Update the FleetInstance
Parameters: - friendly_name (unicode) – A human readable description for this Fleet.
- default_deployment_sid (unicode) – A default Deployment SID.
Returns: The updated FleetInstance
Return type:
-
-
class
twilio.rest.preview.deployed_devices.fleet.
FleetInstance
(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 unique SID that identifies this Account. Return type: unicode
-
certificates
¶ Access the certificates
Returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateList Return type: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateList
-
date_created
¶ Returns: The date this Fleet was created. Return type: datetime
-
date_updated
¶ Returns: The date this Fleet was updated. Return type: datetime
-
default_deployment_sid
¶ Returns: The unique SID that identifies this Fleet’s default Deployment. Return type: unicode
-
delete
()[source]¶ Deletes the FleetInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
deployments
¶ Access the deployments
Returns: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentList Return type: twilio.rest.preview.deployed_devices.fleet.deployment.DeploymentList
-
devices
¶ Access the devices
Returns: twilio.rest.preview.deployed_devices.fleet.device.DeviceList Return type: twilio.rest.preview.deployed_devices.fleet.device.DeviceList
-
fetch
()[source]¶ Fetch the FleetInstance
Returns: The fetched FleetInstance Return type: twilio.rest.preview.deployed_devices.fleet.FleetInstance
-
friendly_name
¶ Returns: A human readable description for this Fleet. Return type: unicode
-
keys
¶ Access the keys
Returns: twilio.rest.preview.deployed_devices.fleet.key.KeyList Return type: twilio.rest.preview.deployed_devices.fleet.key.KeyList
-
links
¶ Returns: Nested resource URLs. Return type: unicode
-
sid
¶ Returns: A string that uniquely identifies this Fleet. Return type: unicode
-
unique_name
¶ Returns: A unique, addressable name of this Fleet. Return type: unicode
-
update
(friendly_name=<object object>, default_deployment_sid=<object object>)[source]¶ Update the FleetInstance
Parameters: - friendly_name (unicode) – A human readable description for this Fleet.
- default_deployment_sid (unicode) – A default Deployment SID.
Returns: The updated FleetInstance
Return type:
-
url
¶ Returns: URL of this Fleet. Return type: unicode
-
-
class
twilio.rest.preview.deployed_devices.fleet.
FleetList
(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
(friendly_name=<object object>)[source]¶ Create the FleetInstance
Parameters: friendly_name (unicode) – A human readable description for this Fleet. Returns: The created FleetInstance Return type: twilio.rest.preview.deployed_devices.fleet.FleetInstance
-
get
(sid)[source]¶ Constructs a FleetContext
Parameters: sid – A string that uniquely identifies the Fleet. Returns: twilio.rest.preview.deployed_devices.fleet.FleetContext Return type: twilio.rest.preview.deployed_devices.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.preview.deployed_devices.fleet.FleetPage
-
list
(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: - 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.deployed_devices.fleet.FleetInstance]
-
page
(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: Returns: Page of FleetInstance
Return type:
-
stream
(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: - 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.deployed_devices.fleet.FleetInstance]
-
-
class
twilio.rest.preview.deployed_devices.fleet.
FleetPage
(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 FleetInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.deployed_devices.fleet.FleetInstance Return type: twilio.rest.preview.deployed_devices.fleet.FleetInstance
-