Class SeamHttpAcsSystems

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsSystems

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

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>

get

• get(
      parameters?: { acs_system_id: string },
      options?: AcsSystemsGetOptions,
  ): AcsSystemsGetRequest

  Parameters

  • Optionalparameters: { acs_system_id: string }

    • acs_system_id: string

      ID of the access system that you want to get.

  • options: AcsSystemsGetOptions = {}

  Returns AcsSystemsGetRequest

list

• list(
      parameters?: {
          connected_account_id?: string;
          customer_key?: string;
          search?: string;
      },
      options?: AcsSystemsListOptions,
  ): AcsSystemsListRequest

  Parameters

  • Optionalparameters: { connected_account_id?: string; customer_key?: string; search?: string }

    • Optionalconnected_account_id?: string

      ID of the connected account by which you want to filter the list of access systems.

    • Optionalcustomer_key?: string

      Customer key for which you want to list access systems.

    • Optionalsearch?: string

      String for which to search. Filters returned access systems to include all records that satisfy a partial match using name or acs_system_id.

  • options: AcsSystemsListOptions = {}

  Returns AcsSystemsListRequest

listCompatibleCredentialManagerAcsSystems

• listCompatibleCredentialManagerAcsSystems(
      parameters?: { acs_system_id: string },
      options?: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions,
  ): AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest

  Parameters

  • Optionalparameters: { acs_system_id: string }

    • acs_system_id: string

      ID of the access system for which you want to retrieve all compatible credential manager systems.

  • options: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions = {}

  Returns AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest

reportDevices

• reportDevices(
      parameters?: {
          acs_encoders?: {
              hotek_metadata: { encoder_number: string };
              is_removed?: boolean;
          }[];
          acs_entrances?: {
              hotek_metadata: {
                  common_area_name?: string;
                  common_area_number?: string;
                  room_number?: string;
              };
              is_removed?: boolean;
          }[];
          acs_system_id: string;
      },
      options?: AcsSystemsReportDevicesOptions,
  ): AcsSystemsReportDevicesRequest

  Parameters

  • Optionalparameters: {
        acs_encoders?: {
            hotek_metadata: { encoder_number: string };
            is_removed?: boolean;
        }[];
        acs_entrances?: {
            hotek_metadata: {
                common_area_name?: string;
                common_area_number?: string;
                room_number?: string;
            };
            is_removed?: boolean;
        }[];
        acs_system_id: string;
    }

    • Optionalacs_encoders?: { hotek_metadata: { encoder_number: string }; is_removed?: boolean }[]

      Array of ACS encoders to report

    • Optionalacs_entrances?: {
          hotek_metadata: {
              common_area_name?: string;
              common_area_number?: string;
              room_number?: string;
          };
          is_removed?: boolean;
      }[]

      Array of ACS entrances to report

    • acs_system_id: string

      ID of the ACS system to report resources for

  • options: AcsSystemsReportDevicesOptions = {}

  Returns AcsSystemsReportDevicesRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAcsSystems

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAcsSystems

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAcsSystems

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAcsSystems

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAcsSystems

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAcsSystems>