Class default

Index

Constructors

Properties

Constructors

constructor

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

Properties

config

config: config

token

token: any

Methods

_details

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

_locks

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

_status

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

_subscribe

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

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

authorize

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

details

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

end

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

fetch

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

get

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

lock

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

locks

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

post

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

put

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

status

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

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

unlock

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

validate

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

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

`Static`authorize

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

`Static`details

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

`Static`lock

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

`Static`locks

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

`Static`status

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

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

`Static`unlock

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

`Static`validate

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