Class Device

Hierarchy

UrlSection
- Device

Index

Constructors

constructor

Methods

Constructors

constructor

new Device(prv: PathSegment, id?: string, service?: any): Device

Overrides UrlSection.constructor
- Defined in paths/Device.ts:8
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Device

Methods

get

get(): Promise<GetDeviceInfoResponse>

- Defined in paths/Device.ts:29
Since 1.0.9 (Release 6.1)
Returns account device(s) by their ID(s).
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
Usage Plan Group
Light

Returns Promise<GetDeviceInfoResponse>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

list

list(): Promise<GetAccountDevicesResponse>

- Defined in paths/Device.ts:16
Since 1.0.12 (Release 6.4)
Returns all the devices for a particular extension.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
Usage Plan Group
Light

Returns Promise<GetAccountDevicesResponse>

put

put(body: AccountDeviceUpdate): Promise<DeviceResource>

- Defined in paths/Device.ts:39
Parameters
- body: AccountDeviceUpdate
Returns Promise<DeviceResource>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc