Class SeamHttpAccessMethods

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessMethods

client

Readonlydefaults

unmanaged

• get unmanaged(): SeamHttpAccessMethodsUnmanaged

  Client for the Seam API /access_methods/unmanaged routes.

  Returns SeamHttpAccessMethodsUnmanaged

assignCard

• assignCard(
      parameters: AccessMethodsAssignCardParameters,
      options?: AccessMethodsAssignCardOptions,
  ): AccessMethodsAssignCardRequest

  Assigns a pre-registered card credential, identified by card_number, to a card-mode access method. Use this endpoint for access systems that use pre-registered cards, where a physical card must be associated with an access method before it can be used for access. Assigning a card credential also triggers issuance of the access method.

  Parameters

  • parameters: AccessMethodsAssignCardParameters
  • options: AccessMethodsAssignCardOptions = {}

  Returns AccessMethodsAssignCardRequest

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>

delete

• delete(
      parameters?: AccessMethodsDeleteParameters,
      options?: AccessMethodsDeleteOptions,
  ): AccessMethodsDeleteRequest

  Deletes an access method.

  Parameters

  • Optionalparameters: AccessMethodsDeleteParameters
  • options: AccessMethodsDeleteOptions = {}

  Returns AccessMethodsDeleteRequest

encode

• encode(
      parameters: AccessMethodsEncodeParameters,
      options?: AccessMethodsEncodeOptions,
  ): AccessMethodsEncodeRequest

  Encodes an existing access method onto a plastic card placed on the specified encoder.

  Parameters

  • parameters: AccessMethodsEncodeParameters
  • options: AccessMethodsEncodeOptions = {}

  Returns AccessMethodsEncodeRequest

get

• get(
      parameters: AccessMethodsGetParameters,
      options?: AccessMethodsGetOptions,
  ): AccessMethodsGetRequest

  Gets an access method.

  Parameters

  • parameters: AccessMethodsGetParameters
  • options: AccessMethodsGetOptions = {}

  Returns AccessMethodsGetRequest

getRelated

• getRelated(
      parameters: AccessMethodsGetRelatedParameters,
      options?: AccessMethodsGetRelatedOptions,
  ): AccessMethodsGetRelatedRequest

  Gets all related resources for one or more Access Methods.

  Parameters

  • parameters: AccessMethodsGetRelatedParameters
  • options: AccessMethodsGetRelatedOptions = {}

  Returns AccessMethodsGetRelatedRequest

list

• list(
      parameters?: AccessMethodsListParameters,
      options?: AccessMethodsListOptions,
  ): AccessMethodsListRequest

  Lists all access methods, usually filtered by Access Grant.

  Parameters

  • Optionalparameters: AccessMethodsListParameters
  • options: AccessMethodsListOptions = {}

  Returns AccessMethodsListRequest

unlockDoor

• unlockDoor(
      parameters: AccessMethodsUnlockDoorParameters,
      options?: AccessMethodsUnlockDoorOptions,
  ): AccessMethodsUnlockDoorRequest

  Remotely unlocks a specified entrance using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.

  Parameters

  • parameters: AccessMethodsUnlockDoorParameters
  • options: AccessMethodsUnlockDoorOptions = {}

  Returns AccessMethodsUnlockDoorRequest

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

  Creates a new SeamHttpAccessMethods authenticated with an API key.

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClient

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

  Creates a new SeamHttpAccessMethods from an existing HTTP client.

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClientSessionToken

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

  Creates a new SeamHttpAccessMethods authenticated with a client session token.

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPublishableKey

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

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