Class SeamHttpAccessMethods

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessMethods

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

unmanaged

• get unmanaged(): SeamHttpAccessMethodsUnmanaged

  Returns SeamHttpAccessMethodsUnmanaged

assignCard

• assignCard(
      parameters?: { access_method_id: string; card_number: string },
      options?: AccessMethodsAssignCardOptions,
  ): AccessMethodsAssignCardRequest

  Parameters

  • Optionalparameters: { access_method_id: string; card_number: string }

    • access_method_id: string

      ID of the card-mode access_method to assign the card to.

    • card_number: string

      Card number of the card credential to assign.

  • options: AccessMethodsAssignCardOptions = {}

  Returns AccessMethodsAssignCardRequest

createPaginator

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

  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

  Parameters

  • Optionalparameters: AccessMethodsDeleteParameters
  • options: AccessMethodsDeleteOptions = {}

  Returns AccessMethodsDeleteRequest

encode

• encode(
      parameters?: { access_method_id: string; acs_encoder_id: string },
      options?: AccessMethodsEncodeOptions,
  ): AccessMethodsEncodeRequest

  Parameters

  • Optionalparameters: { access_method_id: string; acs_encoder_id: string }

    • access_method_id: string

      ID of the access_method to encode onto a card.

    • acs_encoder_id: string

      ID of the acs_encoder to use to encode the access_method.

  • options: AccessMethodsEncodeOptions = {}

  Returns AccessMethodsEncodeRequest

get

• get(
      parameters?: { access_method_id: string },
      options?: AccessMethodsGetOptions,
  ): AccessMethodsGetRequest

  Parameters

  • Optionalparameters: { access_method_id: string }

    • access_method_id: string

      ID of access method to get.

  • options: AccessMethodsGetOptions = {}

  Returns AccessMethodsGetRequest

getRelated

• getRelated(
      parameters?: {
          access_method_ids: string[];
          exclude?: (
              | "client_sessions"
              | "access_grants"
              | "access_methods"
              | "acs_entrances"
              | "acs_credentials"
              | "devices"
              | "instant_keys"
              | "spaces"
          )[];
          include?: (
              | "client_sessions"
              | "access_grants"
              | "access_methods"
              | "acs_entrances"
              | "acs_credentials"
              | "devices"
              | "instant_keys"
              | "spaces"
          )[];
      },
      options?: AccessMethodsGetRelatedOptions,
  ): AccessMethodsGetRelatedRequest

  Parameters

  • Optionalparameters: {
        access_method_ids: string[];
        exclude?: (
            | "client_sessions"
            | "access_grants"
            | "access_methods"
            | "acs_entrances"
            | "acs_credentials"
            | "devices"
            | "instant_keys"
            | "spaces"
        )[];
        include?: (
            | "client_sessions"
            | "access_grants"
            | "access_methods"
            | "acs_entrances"
            | "acs_credentials"
            | "devices"
            | "instant_keys"
            | "spaces"
        )[];
    }

    • access_method_ids: string[]

      IDs of the access methods that you want to get along with their related resources.

    • Optionalexclude?: (
          | "client_sessions"
          | "access_grants"
          | "access_methods"
          | "acs_entrances"
          | "acs_credentials"
          | "devices"
          | "instant_keys"
          | "spaces"
      )[]

    • Optionalinclude?: (
          | "client_sessions"
          | "access_grants"
          | "access_methods"
          | "acs_entrances"
          | "acs_credentials"
          | "devices"
          | "instant_keys"
          | "spaces"
      )[]

  • options: AccessMethodsGetRelatedOptions = {}

  Returns AccessMethodsGetRelatedRequest

list

• list(
      parameters?: {
          access_code_id?: string;
          access_grant_id?: string;
          access_grant_key?: string;
          acs_entrance_id?: string;
          device_id?: string;
          space_id?: string;
      },
      options?: AccessMethodsListOptions,
  ): AccessMethodsListRequest

  Parameters

  • Optionalparameters: {
        access_code_id?: string;
        access_grant_id?: string;
        access_grant_key?: string;
        acs_entrance_id?: string;
        device_id?: string;
        space_id?: string;
    }

    • Optionalaccess_code_id?: string

      ID of the access code for which you want to retrieve all access methods.

    • Optionalaccess_grant_id?: string

      ID of Access Grant to list access methods for.

    • Optionalaccess_grant_key?: string

      Key of Access Grant to list access methods for.

    • Optionalacs_entrance_id?: string

      ID of the entrance for which you want to retrieve all access methods.

    • Optionaldevice_id?: string

      ID of the device for which you want to retrieve all access methods.

    • Optionalspace_id?: string

      ID of the space for which you want to retrieve all access methods.

  • options: AccessMethodsListOptions = {}

  Returns AccessMethodsListRequest

unlockDoor

• unlockDoor(
      parameters?: { access_method_id: string; acs_entrance_id: string },
      options?: AccessMethodsUnlockDoorOptions,
  ): AccessMethodsUnlockDoorRequest

  Parameters

  • Optionalparameters: { access_method_id: string; acs_entrance_id: string }

    • access_method_id: string

      ID of the cloud_key access_method to use for the unlock operation.

    • acs_entrance_id: string

      ID of the entrance to unlock.

  • options: AccessMethodsUnlockDoorOptions = {}

  Returns AccessMethodsUnlockDoorRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAccessMethods>