Class SeamHttpAcsEntrances

constructor

• new SeamHttpAcsEntrances(apiKeyOrOptions?): SeamHttpAcsEntrances

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsEntrances

client

Readonly defaults

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_entrance: {
          acs_entrance_id: string;
          acs_system_id: string;
          created_at: string;
          display_name: string;
          latch_metadata: null | {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          visionline_metadata: null | {
              door_category: "common" | "entrance" | "guest" | "elevator reader" | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: string;
                  visionline_door_profile_type: (...) | (...) | (...);
              }[];
          };
      };
  }>, "acs_entrance">, "acs_entrance">

• Parameters

  • Optional body: {
        acs_entrance_id: string;
    }

    • acs_entrance_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_entrance: {
          acs_entrance_id: string;
          acs_system_id: string;
          created_at: string;
          display_name: string;
          latch_metadata: null | {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          visionline_metadata: null | {
              door_category: "common" | "entrance" | "guest" | "elevator reader" | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: string;
                  visionline_door_profile_type: (...) | (...) | (...);
              }[];
          };
      };
  }>, "acs_entrance">, "acs_entrance">

grantAccess

• grantAccess(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optional body: {
        acs_entrance_id: string;
        acs_user_id: string;
    }

    • acs_entrance_id: string

    • acs_user_id: string

  Returns SeamHttpRequest<void, undefined>

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          created_at: string;
          display_name: string;
          latch_metadata: null | {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          visionline_metadata: null | {
              door_category: "common" | "entrance" | "guest" | "elevator reader" | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

• Parameters

  • Optional body: {
        acs_credential_id?: string;
        acs_system_id?: string;
    }

    • Optional acs_credential_id?: string

    • Optional acs_system_id?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          created_at: string;
          display_name: string;
          latch_metadata: null | {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          visionline_metadata: null | {
              door_category: "common" | "entrance" | "guest" | "elevator reader" | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

listCredentialsWithAccess

• listCredentialsWithAccess(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_credentials: {
          access_method: "code" | "card" | "mobile_key";
          acs_credential_id: string;
          acs_credential_pool_id?: string;
          acs_system_id: string;
          acs_user_id?: string;
          code?: null | string;
          created_at: string;
          display_name: string;
          ends_at?: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
          external_type_display_name?: string;
          is_multi_phone_sync_credential?: boolean;
          parent_acs_credential_id?: string;
          starts_at?: string;
          visionline_metadata?: {
              common_acs_entrance_ids?: string[];
              guest_acs_entrance_ids?: string[];
              joiner_acs_credential_ids?: string[];
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "acs_credentials">, "acs_credentials">

• Parameters

  • Optional body: {
        acs_entrance_id: string;
        include_if?: "visionline_metadata.is_valid"[];
    }

    • acs_entrance_id: string

    • Optional include_if?: "visionline_metadata.is_valid"[]

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_credentials: {
          access_method: "code" | "card" | "mobile_key";
          acs_credential_id: string;
          acs_credential_pool_id?: string;
          acs_system_id: string;
          acs_user_id?: string;
          code?: null | string;
          created_at: string;
          display_name: string;
          ends_at?: string;
          errors: {
              error_code: string;
              message: string;
          }[];
          external_type?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card";
          external_type_display_name?: string;
          is_multi_phone_sync_credential?: boolean;
          parent_acs_credential_id?: string;
          starts_at?: string;
          visionline_metadata?: {
              common_acs_entrance_ids?: string[];
              guest_acs_entrance_ids?: string[];
              joiner_acs_credential_ids?: string[];
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "acs_credentials">, "acs_credentials">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

Static fromClient

• fromClient(client, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpAcsEntrances>

• Parameters

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

  Returns Promise<SeamHttpAcsEntrances>