Class SeamHttpAcsEntrances

constructor

• new SeamHttpAcsEntrances(apiKeyOrOptions?): SeamHttpAcsEntrances

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsEntrances

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_entrance: {
          acs_entrance_id: string;
          acs_system_id: string;
          assa_abloy_vostio_metadata?: {
              door_name: string;
              door_number?: number;
              door_type:
                  | "CommonDoor"
                  | "EntranceDoor"
                  | "GuestDoor"
                  | "Elevator";
              pms_id?: string;
              stand_open?: boolean;
          };
          created_at: string;
          display_name: string;
          dormakaba_community_metadata?: {
              access_point_name: string;
          };
          errors: {
              error_code: string;
              message: string;
          }[];
          latch_metadata?: {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          salto_ks_metadata?: {
              battery_level: string;
              door_name: string;
              intrusion_alarm?: boolean;
              left_open_alarm?: boolean;
              lock_type: string;
              locked_state: string;
              online?: boolean;
              privacy_mode?: boolean;
          };
          salto_space_metadata?: {
              door_description?: string;
              door_name: string;
              ext_door_id: string;
          };
          visionline_metadata?: {
              door_category:
                  | "common"
                  | "guest"
                  | "entrance"
                  | "elevator reader"
                  | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: string;
                  visionline_door_profile_type: (...) | (...) | (...);
              }[];
          };
      };
  }>, "acs_entrance">, "acs_entrance">

• Parameters

  • Optionalparams: {
        acs_entrance_id: string;
    }

    • acs_entrance_id: string

      ID of the entrance that you want to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_entrance: {
          acs_entrance_id: string;
          acs_system_id: string;
          assa_abloy_vostio_metadata?: {
              door_name: string;
              door_number?: number;
              door_type:
                  | "CommonDoor"
                  | "EntranceDoor"
                  | "GuestDoor"
                  | "Elevator";
              pms_id?: string;
              stand_open?: boolean;
          };
          created_at: string;
          display_name: string;
          dormakaba_community_metadata?: {
              access_point_name: string;
          };
          errors: {
              error_code: string;
              message: string;
          }[];
          latch_metadata?: {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          salto_ks_metadata?: {
              battery_level: string;
              door_name: string;
              intrusion_alarm?: boolean;
              left_open_alarm?: boolean;
              lock_type: string;
              locked_state: string;
              online?: boolean;
              privacy_mode?: boolean;
          };
          salto_space_metadata?: {
              door_description?: string;
              door_name: string;
              ext_door_id: string;
          };
          visionline_metadata?: {
              door_category:
                  | "common"
                  | "guest"
                  | "entrance"
                  | "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

  • Optionalbody: {
        acs_entrance_id: string;
        acs_user_id?: string;
        user_identity_id?: string;
    }

    • acs_entrance_id: string

      ID of the entrance to which you want to grant an access system user access.

    • Optionalacs_user_id?: string

      ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same email_address or phone_number as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.

  Returns SeamHttpRequest<void, undefined>

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          assa_abloy_vostio_metadata?: {
              door_name: string;
              door_number?: number;
              door_type:
                  | "CommonDoor"
                  | "EntranceDoor"
                  | "GuestDoor"
                  | "Elevator";
              pms_id?: string;
              stand_open?: boolean;
          };
          created_at: string;
          display_name: string;
          dormakaba_community_metadata?: {
              access_point_name: string;
          };
          errors: {
              error_code: string;
              message: string;
          }[];
          latch_metadata?: {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          salto_ks_metadata?: {
              battery_level: string;
              door_name: string;
              intrusion_alarm?: boolean;
              left_open_alarm?: boolean;
              lock_type: string;
              locked_state: string;
              online?: boolean;
              privacy_mode?: boolean;
          };
          salto_space_metadata?: {
              door_description?: string;
              door_name: string;
              ext_door_id: string;
          };
          visionline_metadata?: {
              door_category:
                  | "common"
                  | "guest"
                  | "entrance"
                  | "elevator reader"
                  | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

• Parameters

  • Optionalparams: {
        acs_credential_id?: string;
        acs_system_id?: string;
        location_id?: null | string;
        space_id?: string;
    }

    • Optionalacs_credential_id?: string

      ID of the credential for which you want to retrieve all entrances.

    • Optionalacs_system_id?: string

      ID of the access system for which you want to retrieve all entrances.

    • Optionallocation_id?: null | string

      Deprecated

      Use space_id.

    • Optionalspace_id?: string

      ID of the space for which you want to list entrances.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_entrances: {
          acs_entrance_id: string;
          acs_system_id: string;
          assa_abloy_vostio_metadata?: {
              door_name: string;
              door_number?: number;
              door_type:
                  | "CommonDoor"
                  | "EntranceDoor"
                  | "GuestDoor"
                  | "Elevator";
              pms_id?: string;
              stand_open?: boolean;
          };
          created_at: string;
          display_name: string;
          dormakaba_community_metadata?: {
              access_point_name: string;
          };
          errors: {
              error_code: string;
              message: string;
          }[];
          latch_metadata?: {
              accessibility_type: string;
              door_name: string;
              door_type: string;
              is_connected: boolean;
          };
          salto_ks_metadata?: {
              battery_level: string;
              door_name: string;
              intrusion_alarm?: boolean;
              left_open_alarm?: boolean;
              lock_type: string;
              locked_state: string;
              online?: boolean;
              privacy_mode?: boolean;
          };
          salto_space_metadata?: {
              door_description?: string;
              door_name: string;
              ext_door_id: string;
          };
          visionline_metadata?: {
              door_category:
                  | "common"
                  | "guest"
                  | "entrance"
                  | "elevator reader"
                  | "common (PMS)";
              door_name: string;
              profiles?: {
                  visionline_door_profile_id: ...;
                  visionline_door_profile_type: ...;
              }[];
          };
      }[];
  }>, "acs_entrances">, "acs_entrances">

listCredentialsWithAccess

• listCredentialsWithAccess(params?): 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;
          assa_abloy_vostio_metadata?: {
              auto_join?: boolean;
              door_names?: string[];
              endpoint_id?: string;
              key_id?: string;
              key_issuing_request_id?: string;
              override_guest_acs_entrance_ids?: string[];
          };
          card_number?: null | 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"
              | "salto_ks_credential"
              | "assa_abloy_vostio_key"
              | "salto_space_key"
              | "latch_access";
          external_type_display_name?: string;
          is_issued?: boolean;
          is_latest_desired_state_synced_with_provider?: null | boolean;
          is_managed: true;
          is_multi_phone_sync_credential?: boolean;
          is_one_time_use?: boolean;
          issued_at?: null | string;
          latest_desired_state_synced_with_provider_at?: null | string;
          parent_acs_credential_id?: string;
          starts_at?: string;
          visionline_metadata?: {
              auto_join?: boolean;
              card_function_type: "guest" | "staff";
              card_id?: string;
              common_acs_entrance_ids?: string[];
              credential_id?: string;
              guest_acs_entrance_ids?: string[];
              is_valid?: boolean;
              joiner_acs_credential_ids?: string[];
          };
          warnings: (
              | {
                  created_at: string;
                  message: string;
                  warning_code: "waiting_to_be_issued";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "schedule_externally_modified";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "schedule_modified";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "being_deleted";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_credential";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "needs_to_be_reissued";
              })[];
          workspace_id: string;
      }[];
  }>, "acs_credentials">, "acs_credentials">

• Parameters

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

    • acs_entrance_id: string

      ID of the entrance for which you want to list all credentials that grant access.

    • Optionalinclude_if?: "visionline_metadata.is_valid"[]

      Conditions that credentials must meet to be included in the returned list.

  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;
          assa_abloy_vostio_metadata?: {
              auto_join?: boolean;
              door_names?: string[];
              endpoint_id?: string;
              key_id?: string;
              key_issuing_request_id?: string;
              override_guest_acs_entrance_ids?: string[];
          };
          card_number?: null | 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"
              | "salto_ks_credential"
              | "assa_abloy_vostio_key"
              | "salto_space_key"
              | "latch_access";
          external_type_display_name?: string;
          is_issued?: boolean;
          is_latest_desired_state_synced_with_provider?: null | boolean;
          is_managed: true;
          is_multi_phone_sync_credential?: boolean;
          is_one_time_use?: boolean;
          issued_at?: null | string;
          latest_desired_state_synced_with_provider_at?: null | string;
          parent_acs_credential_id?: string;
          starts_at?: string;
          visionline_metadata?: {
              auto_join?: boolean;
              card_function_type: "guest" | "staff";
              card_id?: string;
              common_acs_entrance_ids?: string[];
              credential_id?: string;
              guest_acs_entrance_ids?: string[];
              is_valid?: boolean;
              joiner_acs_credential_ids?: string[];
          };
          warnings: (
              | {
                  created_at: string;
                  message: string;
                  warning_code: "waiting_to_be_issued";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "schedule_externally_modified";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "schedule_modified";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "being_deleted";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "unknown_issue_with_acs_credential";
              }
              | {
                  created_at: string;
                  message: string;
                  warning_code: "needs_to_be_reissued";
              })[];
          workspace_id: string;
      }[];
  }>, "acs_credentials">, "acs_credentials">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromClient

• fromClient(client, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsEntrances

• Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAcsEntrances>