Class SeamHttpLocksSimulate

constructor

• new SeamHttpLocksSimulate(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpLocksSimulate

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpLocksSimulate

client

Readonlydefaults

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

keypadCodeEntry

• keypadCodeEntry(
      parameters: LocksSimulateKeypadCodeEntryParameters,
      options?: LocksSimulateKeypadCodeEntryOptions,
  ): LocksSimulateKeypadCodeEntryRequest

  Simulates the entry of a code on a keypad. You can only perform this action for August devices within sandbox workspaces.

  Parameters

  • parameters: LocksSimulateKeypadCodeEntryParameters
  • options: LocksSimulateKeypadCodeEntryOptions = {}

  Returns LocksSimulateKeypadCodeEntryRequest

manualLockViaKeypad

• manualLockViaKeypad(
      parameters: LocksSimulateManualLockViaKeypadParameters,
      options?: LocksSimulateManualLockViaKeypadOptions,
  ): LocksSimulateManualLockViaKeypadRequest

  Simulates a manual lock action using a keypad. You can only perform this action for August devices within sandbox workspaces.

  Parameters

  • parameters: LocksSimulateManualLockViaKeypadParameters
  • options: LocksSimulateManualLockViaKeypadOptions = {}

  Returns LocksSimulateManualLockViaKeypadRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpLocksSimulate

  Creates a new SeamHttpLocksSimulate authenticated with an API key.

  Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpLocksSimulate

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpLocksSimulate

  Creates a new SeamHttpLocksSimulate from an existing HTTP client.

  Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpLocksSimulate

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpLocksSimulate

  Creates a new SeamHttpLocksSimulate authenticated with a client session token.

  Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpLocksSimulate

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpLocksSimulate

  Creates a new SeamHttpLocksSimulate authenticated with a console session token and scoped to a workspace.

  Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpLocksSimulate

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpLocksSimulate

  Creates a new SeamHttpLocksSimulate authenticated with a personal access token and scoped to a workspace.

  Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpLocksSimulate

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpLocksSimulate>

  Creates a new SeamHttpLocksSimulate authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpLocksSimulate>