Devices | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Devices

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Devices(options: DevicesOptions, http: Client): Devices

Overrides ThBaseHandler.constructor
- Defined in src/v0/devices.ts:69
Parameters
- options: DevicesOptions
- http: Client
Returns Devices

Properties

endpoint

endpoint: string

http

http: Client

options

options: DevicesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/devices'

Methods

bind

bind(deviceOrShortId: string, bindRequest: DeviceBindRequest): Promise<DeviceResponse>

- Defined in src/v0/devices.ts:199
Parameters
- deviceOrShortId: string
- bindRequest: DeviceBindRequest
Returns Promise<DeviceResponse>

contents

contents(deviceId: string): Promise<DeviceContentResponse>

- Defined in src/v0/devices.ts:156
Parameters
- deviceId: string
Returns Promise<DeviceContentResponse>

create

create(device: Device): Promise<DeviceResponse>

- Defined in src/v0/devices.ts:185
Parameters
- device: Device
Returns Promise<DeviceResponse>

delete

delete(deviceId: string): Promise<DeviceResponse>

- Defined in src/v0/devices.ts:213
Parameters
- deviceId: string
Returns Promise<DeviceResponse>

get

get(deviceId: string): Promise<DeviceResponse>

- Defined in src/v0/devices.ts:138
Parameters
- deviceId: string
Returns Promise<DeviceResponse>

getAll

getAll(queryOrOptions?: DevicesQuery): Promise<DevicesResponse>

- Defined in src/v0/devices.ts:81
Parameters
- Optional queryOrOptions: DevicesQuery
Returns Promise<DevicesResponse>

patch

patch(deviceId: string, device: Device): Promise<DeviceResponse>

- Defined in src/v0/devices.ts:171
Parameters
- deviceId: string
- device: Device
Returns Promise<DeviceResponse>

search

search(searchTerm: string): Promise<DevicesResponse>

- Defined in src/v0/devices.ts:120
Parameters
- searchTerm: string
Returns Promise<DevicesResponse>

Generated using TypeDoc