DeviceGroups | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- DeviceGroups

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DeviceGroups(options: DeviceGroupsOptions, http: Client): DeviceGroups

Overrides ThBaseHandler.constructor
- Defined in src/v0/device_groups.ts:49
Parameters
- options: DeviceGroupsOptions
- http: Client
Returns DeviceGroups

Properties

endpoint

endpoint: string

http

http: Client

options

options: DeviceGroupsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(deviceGroup: DeviceGroup): Promise<DeviceGroupResponse>

- Defined in src/v0/device_groups.ts:120
Parameters
- deviceGroup: DeviceGroup
Returns Promise<DeviceGroupResponse>

delete

delete(deviceGroupId: string): Promise<DeviceGroupResponse>

- Defined in src/v0/device_groups.ts:134
Parameters
- deviceGroupId: string
Returns Promise<DeviceGroupResponse>

get

get(deviceGroupId: string): Promise<DeviceGroupResponse>

- Defined in src/v0/device_groups.ts:88
Parameters
- deviceGroupId: string
Returns Promise<DeviceGroupResponse>

getAll

getAll(query?: DeviceGroupsQuery): Promise<DeviceGroupsResponse>

- Defined in src/v0/device_groups.ts:64
Parameters
- Optional query: DeviceGroupsQuery
Returns Promise<DeviceGroupsResponse>

put

put(deviceGroupId: string, deviceGroup: DeviceGroup): Promise<DeviceGroupResponse>

- Defined in src/v0/device_groups.ts:106
Parameters
- deviceGroupId: string
- deviceGroup: DeviceGroup
Returns Promise<DeviceGroupResponse>

Generated using TypeDoc