Class SeamHttpLocks

constructor

• new SeamHttpLocks(apiKeyOrOptions?: string | SeamHttpOptions): SeamHttpLocks

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpLocks

client

Readonlydefaults

simulate

• get simulate(): SeamHttpLocksSimulate

  Client for the Seam API /locks/simulate routes.

  Returns SeamHttpLocksSimulate

configureAutoLock

• configureAutoLock(
      parameters: LocksConfigureAutoLockParameters,
      options?: LocksConfigureAutoLockOptions,
  ): LocksConfigureAutoLockRequest

  Configures the auto-lock setting for a specified lock.

  Parameters

  • parameters: LocksConfigureAutoLockParameters
  • options: LocksConfigureAutoLockOptions = {}

  Returns LocksConfigureAutoLockRequest

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>

get

• get(parameters: LocksGetParameters, options?: LocksGetOptions): LocksGetRequest

  Returns a specified lock.

  Parameters

  • parameters: LocksGetParameters
  • options: LocksGetOptions = {}

  Returns LocksGetRequest

  Deprecated

  Use /devices/get instead.

list

• list(
      parameters?: LocksListParameters,
      options?: LocksListOptions,
  ): LocksListRequest

  Returns a list of all locks.

  Parameters

  • Optionalparameters: LocksListParameters
  • options: LocksListOptions = {}

  Returns LocksListRequest

lockDoor

• lockDoor(
      parameters: LocksLockDoorParameters,
      options?: LocksLockDoorOptions,
  ): LocksLockDoorRequest

  Locks a lock. See also Locking and Unlocking Smart Locks.

  Parameters

  • parameters: LocksLockDoorParameters
  • options: LocksLockDoorOptions = {}

  Returns LocksLockDoorRequest

unlockDoor

• unlockDoor(
      parameters: LocksUnlockDoorParameters,
      options?: LocksUnlockDoorOptions,
  ): LocksUnlockDoorRequest

  Unlocks a lock. See also Locking and Unlocking Smart Locks.

  Parameters

  • parameters: LocksUnlockDoorParameters
  • options: LocksUnlockDoorOptions = {}

  Returns LocksUnlockDoorRequest

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">,
  ): SeamHttpLocks

  Creates a new SeamHttpLocks authenticated with an API key.

  Parameters

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

  Returns SeamHttpLocks

StaticfromClient

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

  Creates a new SeamHttpLocks from an existing HTTP client.

  Parameters

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

  Returns SeamHttpLocks

StaticfromClientSessionToken

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

  Creates a new SeamHttpLocks authenticated with a client session token.

  Parameters

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

  Returns SeamHttpLocks

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpLocks

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpLocks

StaticfromPublishableKey

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

  Creates a new SeamHttpLocks 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<SeamHttpLocks>