Class Client

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(client_id: string, client_secret: string, username: string, password: string): Client

- Defined in client.ts:45
Parameters
- client_id: string
- client_secret: string
- username: string
- password: string
Returns Client

Properties

Private client

client: AxiosInstance

Private Optional currentToken

currentToken: Token

Private passwordTokenConfig

passwordTokenConfig: { client_id: string; client_secret: string; grant_type: string; password: string; scope: string; username: string }

Type declaration

client_id: string
client_secret: string
grant_type: string
password: string
scope: string
username: string

Private refreshTokenConfig

refreshTokenConfig: { client_id: string; client_secret: string; grant_type: string; scope: string }

Type declaration

client_id: string
client_secret: string
grant_type: string
scope: string

Private Static scopes

scopes: string[] = ...

Methods

getPrimaryStructure

getPrimaryStructure(): Promise<Structure>

- Defined in client.ts:285
Returns Promise<Structure>

getPuckReading

getPuckReading(puck: Puck): Promise<Puck>

- Defined in client.ts:203
Parameters
- puck: Puck
Returns Promise<Puck>

getPucks

getPucks(): Promise<[Puck]>

- Defined in client.ts:143
Returns Promise<[Puck]>

Private getRefreshToken

getRefreshToken(): Promise<Token>

- Defined in client.ts:79
Gets a refresh token and saves to memory

Returns Promise<Token>

getRoom

getRoom(room: Room): Promise<Room>

- Defined in client.ts:228
Parameters
- room: Room
Returns Promise<Room>

getRooms

getRooms(): Promise<[Room]>

- Defined in client.ts:214
Returns Promise<[Room]>

getStructure

getStructure(structure: Structure): Promise<Structure>

- Defined in client.ts:274
Parameters
- structure: Structure
Returns Promise<Structure>

getStructures

getStructures(): Promise<[Structure]>

- Defined in client.ts:260
Returns Promise<[Structure]>

getUsers

getUsers(): Promise<[User]>

- Defined in client.ts:130
Returns Promise<[User]>

Promise<[User]>

getVentReading

getVentReading(vent: Vent): Promise<Vent>

- Defined in client.ts:170
Parameters
- vent: Vent
Returns Promise<Vent>

getVents

getVents(): Promise<[Vent]>

- Defined in client.ts:156
Returns Promise<[Vent]>

setRoomSetPoint

setRoomSetPoint(room: Room, setPointC: number): Promise<Room>

- Defined in client.ts:241
Parameters
- room: Room
- setPointC: number
Returns Promise<Room>

setStructureHeatingCoolMode

setStructureHeatingCoolMode(structure: Structure, mode: StructureHeatCoolMode): Promise<Structure>

- Defined in client.ts:318
Parameters
- structure: Structure
- mode: StructureHeatCoolMode
Returns Promise<Structure>

setStructureMode

setStructureMode(structure: Structure, mode: FlairMode): Promise<Structure>

- Defined in client.ts:298
Parameters
- structure: Structure
- mode: FlairMode
Returns Promise<Structure>

setVentPercentOpen

setVentPercentOpen(vent: Vent, percentOpen: number): Promise<Vent>

- Defined in client.ts:183
Parameters
- vent: Vent
- percentOpen: number
Returns Promise<Vent>

Private updateAccessToken

updateAccessToken(): Promise<Token>

- Defined in client.ts:95
Updates the access token saved in memory if we have a refresh token otherwise gets a refresh token

Returns Promise<Token>

Promise

Private updateClient

updateClient(): Promise<void>

- Defined in client.ts:121
Updates the authClient

Returns Promise<void>

Generated using TypeDoc