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 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:200

_alarmDevices

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

_alarms

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

_capabilities

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

_deleteWebSocketSubscription

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

_details

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

_doorbellDetails

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

_doorbells

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

_getWebSocketSubscriptions

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

_houseActivities

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

_houseDetails

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

_houses

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

_houseTemperature

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

_locks

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

_pins

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

_setAlarmState

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

_status

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

_subscribe

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

_user

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

_wakeupDoorbell

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

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:338

addWebSocketSubscription

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

alarmDevices

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

alarms

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

authorize

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

capabilities

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

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:212

details

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

doorbellDetails

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

doorbells

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

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:204

houseActivities

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

houseDetails

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

houses

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

houseTemperature

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

lock

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

lockAsync

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

locks

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

pins

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

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:304

status

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

statusAsync

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

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

unlatch

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

unlatchAsync

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

unlock

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

unlockAsync

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

user

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

validate

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

wakeupDoorbell

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

`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:364

`Static`addWebSocketSubscription

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

`Static`alarmDevices

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

`Static`alarms

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

`Static`authorize

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

`Static`capabilities

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

`Static`deleteWebSocketSubscription

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

`Static`details

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

`Static`doorbellDetails

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

`Static`doorbells

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

`Static`getWebSocketSubscriptions

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

`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:443

`Static`houseDetails

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

`Static`houses

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

`Static`houseTemperature

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

`Static`lock

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

`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:405

`Static`locks

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

`Static`pins

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

`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:478

`Static`status

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

`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:417

`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:400

`Static`unlatch

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

`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:413

`Static`unlock

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

`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:409

`Static`user

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

`Static`validate

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

`Static`wakeupDoorbell

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