Class default

Index

Constructors

Properties

Methods

_addWebSocketSubscription _alarmDevices _alarms _capabilities _deleteWebSocketSubscription _details _doorbellDetails _doorbells _getWebSocketSubscriptions _houseActivities _houseDetails _houses _houseTemperature _locks _pins _setAlarmState _status _subscribe _user _wakeupDoorbell addSimpleProps addWebSocketSubscription alarmDevices alarms authorize capabilities delete deleteWebSocketSubscription destroy details doorbellDetails doorbells end fetch get getWebSocketSubscriptions houseActivities houseDetails houses houseTemperature lock lockAsync locks pins post put setAlarmState status statusAsync subscribe unlatch unlatchAsync unlock unlockAsync user validate wakeupDoorbell addSimpleProps addWebSocketSubscription alarmDevices alarms authorize capabilities deleteWebSocketSubscription details doorbellDetails doorbells getWebSocketSubscriptions houseActivities houseDetails houses houseTemperature lock lockAsync locks pins setAlarmState status statusAsync subscribe unlatch unlatchAsync unlock unlockAsync user validate wakeupDoorbell

Constructors

constructor

new default(config: config): default
Parameters
- config: config
Returns default
- Defined in index.ts:42

Properties

config

config: config

token

token: any

Methods

_addWebSocketSubscription

_addWebSocketSubscription(): Promise<any>
Returns Promise<any>
- Defined in index.ts:216

_alarmDevices

_alarmDevices(alarmId: string): Promise<any>
Parameters
- alarmId: string
Returns Promise<any>
- Defined in index.ts:316

_alarms

_alarms(): Promise<any>
Returns Promise<any>
- Defined in index.ts:308

_capabilities

_capabilities(serialNumber: string): Promise<any>
Parameters
- serialNumber: string
Returns Promise<any>
- Defined in index.ts:341

_deleteWebSocketSubscription

_deleteWebSocketSubscription(subscriberId: string): Promise<any>
Parameters
- subscriberId: string
Returns Promise<any>
- Defined in index.ts:232

_details

_details(lockId: string): Promise<AugustLockDetails[]>
Parameters
- lockId: string
Returns Promise<AugustLockDetails[]>
- Defined in index.ts:167

_doorbellDetails

_doorbellDetails(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:291

_doorbells

_doorbells(): Promise<any>
Returns Promise<any>
- Defined in index.ts:283

_getWebSocketSubscriptions

_getWebSocketSubscriptions(subscriberId?: string): Promise<any>
Parameters
- OptionalsubscriberId: string
Returns Promise<any>
- Defined in index.ts:224

_houseActivities

_houseActivities(houseId: string, limit?: number): Promise<any>
Parameters
- houseId: string
- Optionallimit: number
Returns Promise<any>
- Defined in index.ts:257

_houseDetails

_houseDetails(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:249

_houses

_houses(): Promise<any>
Returns Promise<any>
- Defined in index.ts:241

_houseTemperature

_houseTemperature(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:265

_locks

_locks(): Promise<any>
Returns Promise<any>
- Defined in index.ts:158

_pins

_pins(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:333

_setAlarmState

_setAlarmState(
    alarmId: string,
    armState: string,
    areaIds?: string[],
): Promise<any>
Parameters
- alarmId: string
- armState: string
- OptionalareaIds: string[]
Returns Promise<any>
- Defined in index.ts:324

_status

_status(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:176

_subscribe

_subscribe(lockId: any, callback: any): Promise<() => void>
Parameters
- lockId: any
- callback: any
Returns Promise<() => void>
- Defined in index.ts:350

_user

_user(): Promise<any>
Returns Promise<any>
- Defined in index.ts:274

_wakeupDoorbell

_wakeupDoorbell(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:299

addSimpleProps

addSimpleProps(
    obj: {
        doorState?: any;
        info?: any;
        lockID?: any;
        state?: any;
        status?: any;
    },
): void
Parameters
- obj: { doorState?: any; info?: any; lockID?: any; state?: any; status?: any }
Returns void
- Defined in index.ts:354

addWebSocketSubscription

addWebSocketSubscription(): Promise<any>
Returns Promise<any>
- Defined in index.ts:212

alarmDevices

alarmDevices(alarmId: string): Promise<any>
Parameters
- alarmId: string
Returns Promise<any>
- Defined in index.ts:312

alarms

alarms(): Promise<any>
Returns Promise<any>
- Defined in index.ts:304

authorize

authorize(): Promise<boolean>
Returns Promise<boolean>
- Defined in index.ts:145

capabilities

capabilities(serialNumber: string): Promise<any>
Parameters
- serialNumber: string
Returns Promise<any>
- Defined in index.ts:337

delete

delete(endpoint: any): Promise<TinyResult>
Parameters
- endpoint: any
Returns Promise<TinyResult>
- Defined in index.ts:119

deleteWebSocketSubscription

deleteWebSocketSubscription(subscriberId: string): Promise<any>
Parameters
- subscriberId: string
Returns Promise<any>
- Defined in index.ts:228

destroy

destroy(): void
Fully tear down this August instance: clears the session token and destroys any PubNub subscription. Call this when you're done with the instance and want to release all resources (WebSocket connection, listeners, timers).

Unlike end(), which is called internally after most API calls and only clears the HTTP auth token, destroy() also tears down the PubNub connection used by subscribe(). After destroy(), any active subscriptions on this instance are stopped.

Returns void
- Defined in index.ts:139

details

details(lockId: string): Promise<AugustLockDetails[]>
Parameters
- lockId: string
Returns Promise<AugustLockDetails[]>
- Defined in index.ts:163

doorbellDetails

doorbellDetails(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:287

doorbells

doorbells(): Promise<any>
Returns Promise<any>
- Defined in index.ts:279

end

end(): void
Returns void
- Defined in index.ts:123

fetch

fetch(__namedParameters: FetchOptions): Promise<TinyResult>
Parameters
- __namedParameters: FetchOptions
Returns Promise<TinyResult>
- Defined in index.ts:46

get

get(endpoint: any): Promise<TinyResult>
Parameters
- endpoint: any
Returns Promise<TinyResult>
- Defined in index.ts:107

getWebSocketSubscriptions

getWebSocketSubscriptions(subscriberId?: string): Promise<any>
Parameters
- OptionalsubscriberId: string
Returns Promise<any>
- Defined in index.ts:220

houseActivities

houseActivities(houseId: string, limit?: number): Promise<any>
Parameters
- houseId: string
- Optionallimit: number
Returns Promise<any>
- Defined in index.ts:253

houseDetails

houseDetails(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:245

houses

houses(): Promise<any>
Returns Promise<any>
- Defined in index.ts:237

houseTemperature

houseTemperature(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:261

lock

lock(lockId: string): Promise<AugustLockStatus>
Parameters
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:182

lockAsync

lockAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:195

locks

locks(): Promise<any>
Returns Promise<any>
- Defined in index.ts:154

pins

pins(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:329

post

post(endpoint: any, data: any): Promise<TinyResult>
Parameters
- endpoint: any
- data: any
Returns Promise<TinyResult>
- Defined in index.ts:111

put

put(endpoint: any, data: any): Promise<TinyResult>
Parameters
- endpoint: any
- data: any
Returns Promise<TinyResult>
- Defined in index.ts:115

setAlarmState

setAlarmState(
    alarmId: string,
    armState: string,
    areaIds?: string[],
): Promise<any>
Parameters
- alarmId: string
- armState: string
- OptionalareaIds: string[]
Returns Promise<any>
- Defined in index.ts:320

status

status(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:172

statusAsync

statusAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:207

subscribe(lockId: any, callback: any): Promise<() => void>
Parameters
- lockId: any
- callback: any
Returns Promise<() => void>
- Defined in index.ts:346

unlatch

unlatch(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:190

unlatchAsync

unlatchAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:203

unlock

unlock(lockId: string): Promise<AugustLockStatus>
Parameters
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:186

unlockAsync

unlockAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:199

user

user(): Promise<any>
Returns Promise<any>
- Defined in index.ts:270

validate

validate(code: string): Promise<boolean>
Parameters
- code: string
Returns Promise<boolean>
- Defined in index.ts:149

wakeupDoorbell

wakeupDoorbell(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:295

`Static`addSimpleProps

addSimpleProps(
    config: config,
    obj: {
        doorState?: any;
        info?: any;
        lockID?: any;
        state?: any;
        status?: any;
    },
): void
Parameters
- config: config
- obj: { doorState?: any; info?: any; lockID?: any; state?: any; status?: any }
Returns void
- Defined in index.ts:380

`Static`addWebSocketSubscription

addWebSocketSubscription(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:438

`Static`alarmDevices

alarmDevices(config: config, alarmId: string): Promise<any>
Parameters
- config: config
- alarmId: string
Returns Promise<any>
- Defined in index.ts:490

`Static`alarms

alarms(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:486

`Static`authorize

authorize(config: config): Promise<boolean>
Parameters
- config: config
Returns Promise<boolean>
- Defined in index.ts:384

`Static`capabilities

capabilities(config: config, serialNumber: string): Promise<any>
Parameters
- config: config
- serialNumber: string
Returns Promise<any>
- Defined in index.ts:503

`Static`deleteWebSocketSubscription

deleteWebSocketSubscription(config: config, subscriberId: string): Promise<any>
Parameters
- config: config
- subscriberId: string
Returns Promise<any>
- Defined in index.ts:446

`Static`details

details(config: config, lockId: string): Promise<AugustLockDetails[]>
Parameters
- config: config
- lockId: string
Returns Promise<AugustLockDetails[]>
- Defined in index.ts:396

`Static`doorbellDetails

doorbellDetails(config: config, doorbellId: string): Promise<any>
Parameters
- config: config
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:477

`Static`doorbells

doorbells(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:473

`Static`getWebSocketSubscriptions

getWebSocketSubscriptions(config: config, subscriberId?: string): Promise<any>
Parameters
- config: config
- OptionalsubscriberId: string
Returns Promise<any>
- Defined in index.ts:442

`Static`houseActivities

houseActivities(config: config, houseId: string, limit?: number): Promise<any>
Parameters
- config: config
- houseId: string
- Optionallimit: number
Returns Promise<any>
- Defined in index.ts:459

`Static`houseDetails

houseDetails(config: config, houseId: string): Promise<any>
Parameters
- config: config
- houseId: string
Returns Promise<any>
- Defined in index.ts:455

`Static`houses

houses(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:451

`Static`houseTemperature

houseTemperature(config: config, houseId: string): Promise<any>
Parameters
- config: config
- houseId: string
Returns Promise<any>
- Defined in index.ts:463

`Static`lock

lock(config: config, lockId: string): Promise<AugustLockStatus>
Parameters
- config: config
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:404

`Static`lockAsync

lockAsync(config: config, lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:421

`Static`locks

locks(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:392

`Static`pins

pins(config: config, lockId: string): Promise<any>
Parameters
- config: config
- lockId: string
Returns Promise<any>
- Defined in index.ts:499

`Static`setAlarmState

setAlarmState(
    config: config,
    alarmId: string,
    armState: string,
    areaIds?: string[],
): Promise<any>
Parameters
- config: config
- alarmId: string
- armState: string
- OptionalareaIds: string[]
Returns Promise<any>
- Defined in index.ts:494

`Static`status

status(config: config, lockId: string): Promise<any>
Parameters
- config: config
- lockId: string
Returns Promise<any>
- Defined in index.ts:400

`Static`statusAsync

statusAsync(config: config, lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:433

`Static`subscribe

subscribe(config: config, lockId: string, callback?: any): Promise<() => void>
Parameters
- config: config
- lockId: string
- Optionalcallback: any
Returns Promise<() => void>
- Defined in index.ts:416

`Static`unlatch

unlatch(config: config, lockId: string): Promise<any>
Parameters
- config: config
- lockId: string
Returns Promise<any>
- Defined in index.ts:412

`Static`unlatchAsync

unlatchAsync(
    config: config,
    lockId: string,
    hyperBridge?: boolean,
): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:429

`Static`unlock

unlock(config: config, lockId: string): Promise<AugustLockStatus>
Parameters
- config: config
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:408

`Static`unlockAsync

unlockAsync(config: config, lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:425

`Static`user

user(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:468

`Static`validate

validate(config: config, code: string): Promise<boolean>
Parameters
- config: config
- code: string
Returns Promise<boolean>
- Defined in index.ts:388

`Static`wakeupDoorbell

wakeupDoorbell(config: config, doorbellId: string): Promise<any>
Parameters
- config: config
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:481