august-yale
    Preparing search index...

    Class default

    Index

    Constructors

    Properties

    config: config
    token: any

    Methods

    • Returns Promise<any>

    • Parameters

      • alarmId: string

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • serialNumber: string

      Returns Promise<any>

    • Parameters

      • subscriberId: string

      Returns Promise<any>

    • Parameters

      • lockId: string

      Returns Promise<AugustLockDetails[]>

    • Parameters

      • doorbellId: string

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • OptionalsubscriberId: string

      Returns Promise<any>

    • Parameters

      • houseId: string
      • Optionallimit: number

      Returns Promise<any>

    • Parameters

      • houseId: string

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • houseId: string

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • lockId: string

      Returns Promise<any>

    • Parameters

      • alarmId: string
      • armState: string
      • OptionalareaIds: string[]

      Returns Promise<any>

    • Parameters

      • lockId: string

      Returns Promise<any>

    • Parameters

      • lockId: any
      • callback: any

      Returns Promise<() => void>

    • Returns Promise<any>

    • Parameters

      • doorbellId: string

      Returns Promise<any>

    • Parameters

      • obj: { doorState?: any; info?: any; lockID?: any; state?: any; status?: any }

      Returns void

    • Returns Promise<any>

    • Parameters

      • alarmId: string

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<boolean>

    • Parameters

      • serialNumber: string

      Returns Promise<any>

    • Parameters

      • endpoint: any

      Returns Promise<ApiResponse>

    • Parameters

      • subscriberId: string

      Returns Promise<any>

    • 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

    • Parameters

      • lockId: string

      Returns Promise<AugustLockDetails[]>

    • Parameters

      • doorbellId: string

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • __namedParameters: FetchOptions

      Returns Promise<ApiResponse>

    • Parameters

      • endpoint: any

      Returns Promise<ApiResponse>

    • Parameters

      • OptionalsubscriberId: string

      Returns Promise<any>

    • Parameters

      • houseId: string
      • Optionallimit: number

      Returns Promise<any>

    • Parameters

      • houseId: string

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • houseId: string

      Returns Promise<any>

    • Parameters

      • lockId: string

      Returns Promise<AugustLockStatus>

    • Parameters

      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Returns Promise<any>

    • Register a callback for PubNub status events. The callback receives the full PubNub status object — branch on status.category (e.g. PNReconnectedCategory, PNNetworkDownCategory).

      Returns an unsubscribe function. Safe to call before subscribe() — the listener will be wired to the PubNub instance the first time subscribe() creates it.

      Use case: connectivity-recovery detection. PubNub's WebSocket reconnects seconds before HTTP polling would notice that an outage has ended, so this is the fastest signal a homebridge plugin can use to decide it's safe to resume API calls.

      Parameters

      • callback: (status: any) => void

      Returns () => void

    • Parameters

      • lockId: string

      Returns Promise<any>

    post

    • post(endpoint: any, data: any): Promise<ApiResponse>

      Parameters

      • endpoint: any
      • data: any

      Returns Promise<ApiResponse>

    • Parameters

      • endpoint: any
      • data: any

      Returns Promise<ApiResponse>

    • Throw away the current dispatcher and create a fresh one.

      Use case: connectivity recovery in long-lived consumers (e.g. homebridge plugins). After a network outage, the existing Agent may be holding stale half-open sockets that will fail-and-retry forever even after the network recovers. Calling resetTransport() gives the next request a clean connection pool without losing auth state, session token, or configuration — distinct from destroy() + new August() which discards everything.

      Idempotent. Safe to call from any state. Does not affect PubNub subscriptions (those use their own August instances created via August.subscribe()).

      Returns void

    • Parameters

      • alarmId: string
      • armState: string
      • OptionalareaIds: string[]

      Returns Promise<any>

    • Parameters

      • lockId: string

      Returns Promise<any>

    • Parameters

      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Parameters

      • lockId: any
      • callback: any

      Returns Promise<() => void>

    • Parameters

      • lockId: string

      Returns Promise<any>

    • Parameters

      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Parameters

      • lockId: string

      Returns Promise<AugustLockStatus>

    • Parameters

      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • code: string

      Returns Promise<boolean>

    • Parameters

      • doorbellId: string

      Returns Promise<any>

    • Parameters

      • config: config
      • obj: { doorState?: any; info?: any; lockID?: any; state?: any; status?: any }

      Returns void

    • Parameters

      • config: config

      Returns Promise<any>

    • Parameters

      • config: config
      • alarmId: string

      Returns Promise<any>

    • Parameters

      • config: config

      Returns Promise<any>

    • Parameters

      • config: config

      Returns Promise<boolean>

    • Parameters

      • config: config
      • serialNumber: string

      Returns Promise<any>

    • Parameters

      • config: config
      • subscriberId: string

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string

      Returns Promise<AugustLockDetails[]>

    • Parameters

      • config: config
      • doorbellId: string

      Returns Promise<any>

    • Parameters

      • config: config

      Returns Promise<any>

    • Parameters

      • config: config
      • OptionalsubscriberId: string

      Returns Promise<any>

    • Parameters

      • config: config
      • houseId: string
      • Optionallimit: number

      Returns Promise<any>

    • Parameters

      • config: config
      • houseId: string

      Returns Promise<any>

    • Parameters

      • config: config

      Returns Promise<any>

    • Parameters

      • config: config
      • houseId: string

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string

      Returns Promise<AugustLockStatus>

    • Parameters

      • config: config
      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Parameters

      • config: config

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string

      Returns Promise<any>

    • Parameters

      • config: config
      • alarmId: string
      • armState: string
      • OptionalareaIds: string[]

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string
      • Optionalcallback: any

      Returns Promise<() => void>

    • Parameters

      • config: config
      • lockId: string

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Parameters

      • config: config
      • lockId: string

      Returns Promise<AugustLockStatus>

    • Parameters

      • config: config
      • lockId: string
      • OptionalhyperBridge: boolean

      Returns Promise<any>

    • Parameters

      • config: config

      Returns Promise<any>

    • Parameters

      • config: config
      • code: string

      Returns Promise<boolean>

    • Parameters

      • config: config
      • doorbellId: string

      Returns Promise<any>