Skip to content

Latest commit

 

History

History
199 lines (129 loc) · 4.04 KB

devices.md

File metadata and controls

199 lines (129 loc) · 4.04 KB

Devices

devices_controller = client.devices

Class Name

DevicesController

Methods

Delete Device

Deletes a device.

def delete_device(self,
                 id)

Parameters

Parameter Type Tags Description
id string Query, Required Device Id.

Response Type

void

Example Usage

id = 'id0'

result = devices_controller.delete_device(id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Device not found. ProblemDetailsException

Get Device Info

Get info for a device.

def get_device_info(self,
                   id)

Parameters

Parameter Type Tags Description
id string Query, Required Device Id.

Response Type

DeviceInfo

Example Usage

id = 'id0'

result = devices_controller.get_device_info(id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Device not found. ProblemDetailsException

Get Device Options

Get options for a device.

def get_device_options(self,
                      id)

Parameters

Parameter Type Tags Description
id string Query, Required Device Id.

Response Type

DeviceOptions

Example Usage

id = 'id0'

result = devices_controller.get_device_options(id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Device not found. ProblemDetailsException

Get Devices

Get Devices.

def get_devices(self,
               supports_sync=None,
               user_id=None)

Parameters

Parameter Type Tags Description
supports_sync bool Query, Optional Gets or sets a value indicating whether [supports synchronize].
user_id uuid|string Query, Optional Gets or sets the user identifier.

Response Type

DeviceInfoQueryResult

Example Usage

result = devices_controller.get_devices()

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Update Device Options

Update device options.

def update_device_options(self,
                         id,
                         body)

Parameters

Parameter Type Tags Description
id string Query, Required Device Id.
body DeviceOptionsDto Body, Required Device Options.

Response Type

void

Example Usage

id = 'id0'
body = DeviceOptionsDto()

result = devices_controller.update_device_options(id, body)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException