Class SeamHttpEndpoints

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpEndpoints

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

/access_codes/create

• get "/access_codes/create"(): (
      parameters?: {
          allow_external_modification?: boolean;
          attempt_for_offline_device?: boolean;
          code?: string;
          common_code_key?: string;
          device_id: string;
          ends_at?: string;
          is_external_modification_allowed?: boolean;
          is_offline_access_code?: boolean;
          is_one_time_use?: boolean;
          max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
          name?: string;
          prefer_native_scheduling?: boolean;
          preferred_code_length?: number;
          starts_at?: string;
          sync?: boolean;
          use_backup_access_code_pool?: boolean;
          use_offline_access_code?: boolean;
      },
      options?: AccessCodesCreateOptions,
  ) => AccessCodesCreateRequest

  Returns (
      parameters?: {
          allow_external_modification?: boolean;
          attempt_for_offline_device?: boolean;
          code?: string;
          common_code_key?: string;
          device_id: string;
          ends_at?: string;
          is_external_modification_allowed?: boolean;
          is_offline_access_code?: boolean;
          is_one_time_use?: boolean;
          max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
          name?: string;
          prefer_native_scheduling?: boolean;
          preferred_code_length?: number;
          starts_at?: string;
          sync?: boolean;
          use_backup_access_code_pool?: boolean;
          use_offline_access_code?: boolean;
      },
      options?: AccessCodesCreateOptions,
  ) => AccessCodesCreateRequest

/access_codes/create_multiple

• get "/access_codes/create_multiple"(): (
      parameters?: {
          allow_external_modification?: boolean;
          attempt_for_offline_device?: boolean;
          behavior_when_code_cannot_be_shared?: "throw" | "create_random_code";
          code?: string;
          device_ids: string[];
          ends_at?: string;
          is_external_modification_allowed?: boolean;
          is_offline_access_code?: boolean;
          is_one_time_use?: boolean;
          max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
          name?: string;
          prefer_native_scheduling?: boolean;
          preferred_code_length?: number;
          starts_at?: string;
          use_backup_access_code_pool?: boolean;
          use_offline_access_code?: boolean;
      },
      options?: AccessCodesCreateMultipleOptions,
  ) => AccessCodesCreateMultipleRequest

  Returns (
      parameters?: {
          allow_external_modification?: boolean;
          attempt_for_offline_device?: boolean;
          behavior_when_code_cannot_be_shared?: "throw" | "create_random_code";
          code?: string;
          device_ids: string[];
          ends_at?: string;
          is_external_modification_allowed?: boolean;
          is_offline_access_code?: boolean;
          is_one_time_use?: boolean;
          max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
          name?: string;
          prefer_native_scheduling?: boolean;
          preferred_code_length?: number;
          starts_at?: string;
          use_backup_access_code_pool?: boolean;
          use_offline_access_code?: boolean;
      },
      options?: AccessCodesCreateMultipleOptions,
  ) => AccessCodesCreateMultipleRequest

/access_codes/delete

• get "/access_codes/delete"(): (
      parameters?: {
          access_code_id: string;
          device_id?: string;
          sync?: boolean;
      },
      options?: AccessCodesDeleteOptions,
  ) => AccessCodesDeleteRequest

  Returns (
      parameters?: {
          access_code_id: string;
          device_id?: string;
          sync?: boolean;
      },
      options?: AccessCodesDeleteOptions,
  ) => AccessCodesDeleteRequest

/access_codes/generate_code

• get "/access_codes/generate_code"(): (
      parameters?: { device_id: string },
      options?: AccessCodesGenerateCodeOptions,
  ) => AccessCodesGenerateCodeRequest

  Returns (
      parameters?: { device_id: string },
      options?: AccessCodesGenerateCodeOptions,
  ) => AccessCodesGenerateCodeRequest

/access_codes/get

• get "/access_codes/get"(): (
      parameters?: {
          access_code_id?: string;
          code?: string;
          device_id?: string;
      },
      options?: AccessCodesGetOptions,
  ) => AccessCodesGetRequest

  Returns (
      parameters?: {
          access_code_id?: string;
          code?: string;
          device_id?: string;
      },
      options?: AccessCodesGetOptions,
  ) => AccessCodesGetRequest

/access_codes/list

• get "/access_codes/list"(): (
      parameters?: {
          access_code_ids?: string[];
          customer_key?: string;
          device_id?: string;
          limit?: number;
          page_cursor?: null | string;
          user_identifier_key?: string;
      },
      options?: AccessCodesListOptions,
  ) => AccessCodesListRequest

  Returns (
      parameters?: {
          access_code_ids?: string[];
          customer_key?: string;
          device_id?: string;
          limit?: number;
          page_cursor?: null | string;
          user_identifier_key?: string;
      },
      options?: AccessCodesListOptions,
  ) => AccessCodesListRequest

/access_codes/pull_backup_access_code

• get "/access_codes/pull_backup_access_code"(): (
      parameters?: { access_code_id: string },
      options?: AccessCodesPullBackupAccessCodeOptions,
  ) => AccessCodesPullBackupAccessCodeRequest

  Returns (
      parameters?: { access_code_id: string },
      options?: AccessCodesPullBackupAccessCodeOptions,
  ) => AccessCodesPullBackupAccessCodeRequest

/access_codes/report_device_constraints

• get "/access_codes/report_device_constraints"(): (
      parameters?: {
          device_id: string;
          max_code_length?: number;
          min_code_length?: number;
          supported_code_lengths?: number[];
      },
      options?: AccessCodesReportDeviceConstraintsOptions,
  ) => AccessCodesReportDeviceConstraintsRequest

  Returns (
      parameters?: {
          device_id: string;
          max_code_length?: number;
          min_code_length?: number;
          supported_code_lengths?: number[];
      },
      options?: AccessCodesReportDeviceConstraintsOptions,
  ) => AccessCodesReportDeviceConstraintsRequest

/access_codes/simulate/create_unmanaged_access_code

• get "/access_codes/simulate/create_unmanaged_access_code"(): (
      parameters?: { code: string; device_id: string; name: string },
      options?: AccessCodesSimulateCreateUnmanagedAccessCodeOptions,
  ) => AccessCodesSimulateCreateUnmanagedAccessCodeRequest

  Returns (
      parameters?: { code: string; device_id: string; name: string },
      options?: AccessCodesSimulateCreateUnmanagedAccessCodeOptions,
  ) => AccessCodesSimulateCreateUnmanagedAccessCodeRequest

/access_codes/unmanaged/convert_to_managed

• get "/access_codes/unmanaged/convert_to_managed"(): (
      parameters?: {
          access_code_id: string;
          allow_external_modification?: boolean;
          force?: boolean;
          is_external_modification_allowed?: boolean;
          sync?: boolean;
      },
      options?: AccessCodesUnmanagedConvertToManagedOptions,
  ) => AccessCodesUnmanagedConvertToManagedRequest

  Returns (
      parameters?: {
          access_code_id: string;
          allow_external_modification?: boolean;
          force?: boolean;
          is_external_modification_allowed?: boolean;
          sync?: boolean;
      },
      options?: AccessCodesUnmanagedConvertToManagedOptions,
  ) => AccessCodesUnmanagedConvertToManagedRequest

/access_codes/unmanaged/delete

• get "/access_codes/unmanaged/delete"(): (
      parameters?: { access_code_id: string; sync?: boolean },
      options?: AccessCodesUnmanagedDeleteOptions,
  ) => AccessCodesUnmanagedDeleteRequest

  Returns (
      parameters?: { access_code_id: string; sync?: boolean },
      options?: AccessCodesUnmanagedDeleteOptions,
  ) => AccessCodesUnmanagedDeleteRequest

/access_codes/unmanaged/get

• get "/access_codes/unmanaged/get"(): (
      parameters?: {
          access_code_id?: string;
          code?: string;
          device_id?: string;
      },
      options?: AccessCodesUnmanagedGetOptions,
  ) => AccessCodesUnmanagedGetRequest

  Returns (
      parameters?: {
          access_code_id?: string;
          code?: string;
          device_id?: string;
      },
      options?: AccessCodesUnmanagedGetOptions,
  ) => AccessCodesUnmanagedGetRequest

/access_codes/unmanaged/list

• get "/access_codes/unmanaged/list"(): (
      parameters?: {
          device_id: string;
          limit?: number;
          page_cursor?: null | string;
          user_identifier_key?: string;
      },
      options?: AccessCodesUnmanagedListOptions,
  ) => AccessCodesUnmanagedListRequest

  Returns (
      parameters?: {
          device_id: string;
          limit?: number;
          page_cursor?: null | string;
          user_identifier_key?: string;
      },
      options?: AccessCodesUnmanagedListOptions,
  ) => AccessCodesUnmanagedListRequest

/access_codes/unmanaged/update

• get "/access_codes/unmanaged/update"(): (
      parameters?: {
          access_code_id: string;
          allow_external_modification?: boolean;
          force?: boolean;
          is_external_modification_allowed?: boolean;
          is_managed: boolean;
      },
      options?: AccessCodesUnmanagedUpdateOptions,
  ) => AccessCodesUnmanagedUpdateRequest

  Returns (
      parameters?: {
          access_code_id: string;
          allow_external_modification?: boolean;
          force?: boolean;
          is_external_modification_allowed?: boolean;
          is_managed: boolean;
      },
      options?: AccessCodesUnmanagedUpdateOptions,
  ) => AccessCodesUnmanagedUpdateRequest

/access_codes/update

• get "/access_codes/update"(): (
      parameters?: {
          access_code_id: string;
          allow_external_modification?: boolean;
          attempt_for_offline_device?: boolean;
          code?: string;
          device_id?: string;
          ends_at?: string;
          is_external_modification_allowed?: boolean;
          is_managed?: boolean;
          is_offline_access_code?: boolean;
          is_one_time_use?: boolean;
          max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
          name?: string;
          prefer_native_scheduling?: boolean;
          preferred_code_length?: number;
          starts_at?: string;
          sync?: boolean;
          type?: "ongoing" | "time_bound";
          use_backup_access_code_pool?: boolean;
          use_offline_access_code?: boolean;
      },
      options?: AccessCodesUpdateOptions,
  ) => AccessCodesUpdateRequest

  Returns (
      parameters?: {
          access_code_id: string;
          allow_external_modification?: boolean;
          attempt_for_offline_device?: boolean;
          code?: string;
          device_id?: string;
          ends_at?: string;
          is_external_modification_allowed?: boolean;
          is_managed?: boolean;
          is_offline_access_code?: boolean;
          is_one_time_use?: boolean;
          max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
          name?: string;
          prefer_native_scheduling?: boolean;
          preferred_code_length?: number;
          starts_at?: string;
          sync?: boolean;
          type?: "ongoing" | "time_bound";
          use_backup_access_code_pool?: boolean;
          use_offline_access_code?: boolean;
      },
      options?: AccessCodesUpdateOptions,
  ) => AccessCodesUpdateRequest

/access_codes/update_multiple

• get "/access_codes/update_multiple"(): (
      parameters?: {
          common_code_key: string;
          ends_at?: string;
          name?: string;
          starts_at?: string;
      },
      options?: AccessCodesUpdateMultipleOptions,
  ) => AccessCodesUpdateMultipleRequest

  Returns (
      parameters?: {
          common_code_key: string;
          ends_at?: string;
          name?: string;
          starts_at?: string;
      },
      options?: AccessCodesUpdateMultipleOptions,
  ) => AccessCodesUpdateMultipleRequest

/access_grants/create

• get "/access_grants/create"(): (
      parameters?: AccessGrantsCreateParameters,
      options?: AccessGrantsCreateOptions,
  ) => AccessGrantsCreateRequest

  Returns (
      parameters?: AccessGrantsCreateParameters,
      options?: AccessGrantsCreateOptions,
  ) => AccessGrantsCreateRequest

/access_grants/delete

• get "/access_grants/delete"(): (
      parameters?: { access_grant_id: string },
      options?: AccessGrantsDeleteOptions,
  ) => AccessGrantsDeleteRequest

  Returns (
      parameters?: { access_grant_id: string },
      options?: AccessGrantsDeleteOptions,
  ) => AccessGrantsDeleteRequest

/access_grants/get

• get "/access_grants/get"(): (
      parameters?: AccessGrantsGetParameters,
      options?: AccessGrantsGetOptions,
  ) => AccessGrantsGetRequest

  Returns (
      parameters?: AccessGrantsGetParameters,
      options?: AccessGrantsGetOptions,
  ) => AccessGrantsGetRequest

/access_grants/get_related

• get "/access_grants/get_related"(): (
      parameters?: {
          access_grant_ids: string[];
          exclude?: (
              | "acs_access_groups"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
              | "user_identity"
          )[];
          include?: (
              | "acs_access_groups"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
              | "user_identity"
          )[];
      },
      options?: AccessGrantsGetRelatedOptions,
  ) => AccessGrantsGetRelatedRequest

  Returns (
      parameters?: {
          access_grant_ids: string[];
          exclude?: (
              | "acs_access_groups"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
              | "user_identity"
          )[];
          include?: (
              | "acs_access_groups"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
              | "user_identity"
          )[];
      },
      options?: AccessGrantsGetRelatedOptions,
  ) => AccessGrantsGetRelatedRequest

/access_grants/list

• get "/access_grants/list"(): (
      parameters?: {
          access_grant_key?: string;
          acs_entrance_id?: string;
          acs_system_id?: string;
          customer_key?: string;
          location_id?: string;
          space_id?: string;
          user_identity_id?: string;
      },
      options?: AccessGrantsListOptions,
  ) => AccessGrantsListRequest

  Returns (
      parameters?: {
          access_grant_key?: string;
          acs_entrance_id?: string;
          acs_system_id?: string;
          customer_key?: string;
          location_id?: string;
          space_id?: string;
          user_identity_id?: string;
      },
      options?: AccessGrantsListOptions,
  ) => AccessGrantsListRequest

/access_grants/update

• get "/access_grants/update"(): (
      parameters?: {
          access_grant_id: string;
          ends_at?: null | string;
          name?: null | string;
          starts_at?: string;
      },
      options?: AccessGrantsUpdateOptions,
  ) => AccessGrantsUpdateRequest

  Returns (
      parameters?: {
          access_grant_id: string;
          ends_at?: null | string;
          name?: null | string;
          starts_at?: string;
      },
      options?: AccessGrantsUpdateOptions,
  ) => AccessGrantsUpdateRequest

/access_methods/delete

• get "/access_methods/delete"(): (
      parameters?: { access_method_id: string },
      options?: AccessMethodsDeleteOptions,
  ) => AccessMethodsDeleteRequest

  Returns (
      parameters?: { access_method_id: string },
      options?: AccessMethodsDeleteOptions,
  ) => AccessMethodsDeleteRequest

/access_methods/encode

• get "/access_methods/encode"(): (
      parameters?: { access_method_id: string; acs_encoder_id: string },
      options?: AccessMethodsEncodeOptions,
  ) => AccessMethodsEncodeRequest

  Returns (
      parameters?: { access_method_id: string; acs_encoder_id: string },
      options?: AccessMethodsEncodeOptions,
  ) => AccessMethodsEncodeRequest

/access_methods/get

• get "/access_methods/get"(): (
      parameters?: { access_method_id: string },
      options?: AccessMethodsGetOptions,
  ) => AccessMethodsGetRequest

  Returns (
      parameters?: { access_method_id: string },
      options?: AccessMethodsGetOptions,
  ) => AccessMethodsGetRequest

/access_methods/get_related

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

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

/access_methods/list

• get "/access_methods/list"(): (
      parameters?: {
          access_grant_id: string;
          acs_entrance_id?: string;
          device_id?: string;
          space_id?: string;
      },
      options?: AccessMethodsListOptions,
  ) => AccessMethodsListRequest

  Returns (
      parameters?: {
          access_grant_id: string;
          acs_entrance_id?: string;
          device_id?: string;
          space_id?: string;
      },
      options?: AccessMethodsListOptions,
  ) => AccessMethodsListRequest

/acs/access_groups/add_user

• get "/acs/access_groups/add_user"(): (
      parameters?: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsAddUserOptions,
  ) => AcsAccessGroupsAddUserRequest

  Returns (
      parameters?: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsAddUserOptions,
  ) => AcsAccessGroupsAddUserRequest

/acs/access_groups/get

• get "/acs/access_groups/get"(): (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsGetOptions,
  ) => AcsAccessGroupsGetRequest

  Returns (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsGetOptions,
  ) => AcsAccessGroupsGetRequest

/acs/access_groups/list

• get "/acs/access_groups/list"(): (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsListOptions,
  ) => AcsAccessGroupsListRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsListOptions,
  ) => AcsAccessGroupsListRequest

/acs/access_groups/list_accessible_entrances

• get "/acs/access_groups/list_accessible_entrances"(): (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsListAccessibleEntrancesOptions,
  ) => AcsAccessGroupsListAccessibleEntrancesRequest

  Returns (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsListAccessibleEntrancesOptions,
  ) => AcsAccessGroupsListAccessibleEntrancesRequest

/acs/access_groups/list_users

• get "/acs/access_groups/list_users"(): (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsListUsersOptions,
  ) => AcsAccessGroupsListUsersRequest

  Returns (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsListUsersOptions,
  ) => AcsAccessGroupsListUsersRequest

/acs/access_groups/remove_user

• get "/acs/access_groups/remove_user"(): (
      parameters?: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsRemoveUserOptions,
  ) => AcsAccessGroupsRemoveUserRequest

  Returns (
      parameters?: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsAccessGroupsRemoveUserOptions,
  ) => AcsAccessGroupsRemoveUserRequest

/acs/access_groups/unmanaged/get

• get "/acs/access_groups/unmanaged/get"(): (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsUnmanagedGetOptions,
  ) => AcsAccessGroupsUnmanagedGetRequest

  Returns (
      parameters?: { acs_access_group_id: string },
      options?: AcsAccessGroupsUnmanagedGetOptions,
  ) => AcsAccessGroupsUnmanagedGetRequest

/acs/access_groups/unmanaged/list

• get "/acs/access_groups/unmanaged/list"(): (
      parameters?: { acs_system_id?: string; acs_user_id?: string },
      options?: AcsAccessGroupsUnmanagedListOptions,
  ) => AcsAccessGroupsUnmanagedListRequest

  Returns (
      parameters?: { acs_system_id?: string; acs_user_id?: string },
      options?: AcsAccessGroupsUnmanagedListOptions,
  ) => AcsAccessGroupsUnmanagedListRequest

/acs/credential_pools/list

• get "/acs/credential_pools/list"(): (
      parameters?: { acs_system_id: string },
      options?: AcsCredentialPoolsListOptions,
  ) => AcsCredentialPoolsListRequest

  Returns (
      parameters?: { acs_system_id: string },
      options?: AcsCredentialPoolsListOptions,
  ) => AcsCredentialPoolsListRequest

/acs/credential_provisioning_automations/launch

• get "/acs/credential_provisioning_automations/launch"(): (
      parameters?: {
          acs_credential_pool_id?: string;
          create_credential_manager_user?: boolean;
          credential_manager_acs_system_id: string;
          credential_manager_acs_user_id?: string;
          user_identity_id: string;
      },
      options?: AcsCredentialProvisioningAutomationsLaunchOptions,
  ) => AcsCredentialProvisioningAutomationsLaunchRequest

  Returns (
      parameters?: {
          acs_credential_pool_id?: string;
          create_credential_manager_user?: boolean;
          credential_manager_acs_system_id: string;
          credential_manager_acs_user_id?: string;
          user_identity_id: string;
      },
      options?: AcsCredentialProvisioningAutomationsLaunchOptions,
  ) => AcsCredentialProvisioningAutomationsLaunchRequest

/acs/credentials/assign

• get "/acs/credentials/assign"(): (
      parameters?: {
          acs_credential_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsCredentialsAssignOptions,
  ) => AcsCredentialsAssignRequest

  Returns (
      parameters?: {
          acs_credential_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsCredentialsAssignOptions,
  ) => AcsCredentialsAssignRequest

/acs/credentials/create

• get "/acs/credentials/create"(): (
      parameters?: {
          access_method: "code" | "card" | "mobile_key";
          acs_system_id?: string;
          acs_user_id?: string;
          allowed_acs_entrance_ids?: string[];
          assa_abloy_vostio_metadata?: {
              auto_join?: boolean;
              join_all_guest_acs_entrances?: boolean;
              override_all_guest_acs_entrances?: boolean;
              override_guest_acs_entrance_ids?: string[];
          };
          code?: string;
          credential_manager_acs_system_id?: string;
          ends_at?: string;
          is_multi_phone_sync_credential?: boolean;
          salto_space_metadata?: {
              assign_new_key?: boolean;
              update_current_key?: boolean;
          };
          starts_at?: string;
          user_identity_id?: string;
          visionline_metadata?: {
              assa_abloy_credential_service_mobile_endpoint_id?: string;
              auto_join?: boolean;
              card_format?: "TLCode"
              | "rfid48";
              card_function_type?: "guest" | "staff";
              is_override_key?: boolean;
              joiner_acs_credential_ids?: string[];
              override?: boolean;
          };
      },
      options?: AcsCredentialsCreateOptions,
  ) => AcsCredentialsCreateRequest

  Returns (
      parameters?: {
          access_method: "code" | "card" | "mobile_key";
          acs_system_id?: string;
          acs_user_id?: string;
          allowed_acs_entrance_ids?: string[];
          assa_abloy_vostio_metadata?: {
              auto_join?: boolean;
              join_all_guest_acs_entrances?: boolean;
              override_all_guest_acs_entrances?: boolean;
              override_guest_acs_entrance_ids?: string[];
          };
          code?: string;
          credential_manager_acs_system_id?: string;
          ends_at?: string;
          is_multi_phone_sync_credential?: boolean;
          salto_space_metadata?: {
              assign_new_key?: boolean;
              update_current_key?: boolean;
          };
          starts_at?: string;
          user_identity_id?: string;
          visionline_metadata?: {
              assa_abloy_credential_service_mobile_endpoint_id?: string;
              auto_join?: boolean;
              card_format?: "TLCode"
              | "rfid48";
              card_function_type?: "guest" | "staff";
              is_override_key?: boolean;
              joiner_acs_credential_ids?: string[];
              override?: boolean;
          };
      },
      options?: AcsCredentialsCreateOptions,
  ) => AcsCredentialsCreateRequest

/acs/credentials/create_offline_code

• get "/acs/credentials/create_offline_code"(): (
      parameters?: {
          acs_user_id: string;
          allowed_acs_entrance_id: string;
          ends_at?: string;
          is_one_time_use?: boolean;
          starts_at?: string;
      },
      options?: AcsCredentialsCreateOfflineCodeOptions,
  ) => AcsCredentialsCreateOfflineCodeRequest

  Returns (
      parameters?: {
          acs_user_id: string;
          allowed_acs_entrance_id: string;
          ends_at?: string;
          is_one_time_use?: boolean;
          starts_at?: string;
      },
      options?: AcsCredentialsCreateOfflineCodeOptions,
  ) => AcsCredentialsCreateOfflineCodeRequest

/acs/credentials/delete

• get "/acs/credentials/delete"(): (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsDeleteOptions,
  ) => AcsCredentialsDeleteRequest

  Returns (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsDeleteOptions,
  ) => AcsCredentialsDeleteRequest

/acs/credentials/get

• get "/acs/credentials/get"(): (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsGetOptions,
  ) => AcsCredentialsGetRequest

  Returns (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsGetOptions,
  ) => AcsCredentialsGetRequest

/acs/credentials/list

• get "/acs/credentials/list"(): (
      parameters?: AcsCredentialsListParameters,
      options?: AcsCredentialsListOptions,
  ) => AcsCredentialsListRequest

  Returns (
      parameters?: AcsCredentialsListParameters,
      options?: AcsCredentialsListOptions,
  ) => AcsCredentialsListRequest

/acs/credentials/list_accessible_entrances

• get "/acs/credentials/list_accessible_entrances"(): (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsListAccessibleEntrancesOptions,
  ) => AcsCredentialsListAccessibleEntrancesRequest

  Returns (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsListAccessibleEntrancesOptions,
  ) => AcsCredentialsListAccessibleEntrancesRequest

/acs/credentials/unassign

• get "/acs/credentials/unassign"(): (
      parameters?: {
          acs_credential_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsCredentialsUnassignOptions,
  ) => AcsCredentialsUnassignRequest

  Returns (
      parameters?: {
          acs_credential_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsCredentialsUnassignOptions,
  ) => AcsCredentialsUnassignRequest

/acs/credentials/unmanaged/get

• get "/acs/credentials/unmanaged/get"(): (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsUnmanagedGetOptions,
  ) => AcsCredentialsUnmanagedGetRequest

  Returns (
      parameters?: { acs_credential_id: string },
      options?: AcsCredentialsUnmanagedGetOptions,
  ) => AcsCredentialsUnmanagedGetRequest

/acs/credentials/unmanaged/list

• get "/acs/credentials/unmanaged/list"(): (
      parameters?: AcsCredentialsUnmanagedListParameters,
      options?: AcsCredentialsUnmanagedListOptions,
  ) => AcsCredentialsUnmanagedListRequest

  Returns (
      parameters?: AcsCredentialsUnmanagedListParameters,
      options?: AcsCredentialsUnmanagedListOptions,
  ) => AcsCredentialsUnmanagedListRequest

/acs/credentials/update

• get "/acs/credentials/update"(): (
      parameters?: {
          acs_credential_id: string;
          code?: string;
          ends_at?: string;
      },
      options?: AcsCredentialsUpdateOptions,
  ) => AcsCredentialsUpdateRequest

  Returns (
      parameters?: {
          acs_credential_id: string;
          code?: string;
          ends_at?: string;
      },
      options?: AcsCredentialsUpdateOptions,
  ) => AcsCredentialsUpdateRequest

/acs/encoders/encode_credential

• get "/acs/encoders/encode_credential"(): (
      parameters?: {
          access_method_id?: string;
          acs_credential_id?: string;
          acs_encoder_id: string;
      },
      options?: AcsEncodersEncodeCredentialOptions,
  ) => AcsEncodersEncodeCredentialRequest

  Returns (
      parameters?: {
          access_method_id?: string;
          acs_credential_id?: string;
          acs_encoder_id: string;
      },
      options?: AcsEncodersEncodeCredentialOptions,
  ) => AcsEncodersEncodeCredentialRequest

/acs/encoders/get

• get "/acs/encoders/get"(): (
      parameters?: { acs_encoder_id: string },
      options?: AcsEncodersGetOptions,
  ) => AcsEncodersGetRequest

  Returns (
      parameters?: { acs_encoder_id: string },
      options?: AcsEncodersGetOptions,
  ) => AcsEncodersGetRequest

/acs/encoders/list

• get "/acs/encoders/list"(): (
      parameters?: AcsEncodersListParameters,
      options?: AcsEncodersListOptions,
  ) => AcsEncodersListRequest

  Returns (
      parameters?: AcsEncodersListParameters,
      options?: AcsEncodersListOptions,
  ) => AcsEncodersListRequest

/acs/encoders/scan_credential

• get "/acs/encoders/scan_credential"(): (
      parameters?: { acs_encoder_id: string },
      options?: AcsEncodersScanCredentialOptions,
  ) => AcsEncodersScanCredentialRequest

  Returns (
      parameters?: { acs_encoder_id: string },
      options?: AcsEncodersScanCredentialOptions,
  ) => AcsEncodersScanCredentialRequest

/acs/encoders/simulate/next_credential_encode_will_fail

• get "/acs/encoders/simulate/next_credential_encode_will_fail"(): (
      parameters?: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillFailRequest

  Returns (
      parameters?: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillFailRequest

/acs/encoders/simulate/next_credential_encode_will_succeed

• get "/acs/encoders/simulate/next_credential_encode_will_succeed"(): (
      parameters?: {
          acs_encoder_id: string;
          scenario?: "credential_is_issued";
      },
      options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest

  Returns (
      parameters?: {
          acs_encoder_id: string;
          scenario?: "credential_is_issued";
      },
      options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest

/acs/encoders/simulate/next_credential_scan_will_fail

• get "/acs/encoders/simulate/next_credential_scan_will_fail"(): (
      parameters?: AcsEncodersSimulateNextCredentialScanWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillFailRequest

  Returns (
      parameters?: AcsEncodersSimulateNextCredentialScanWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillFailRequest

/acs/encoders/simulate/next_credential_scan_will_succeed

• get "/acs/encoders/simulate/next_credential_scan_will_succeed"(): (
      parameters?: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillSucceedRequest

  Returns (
      parameters?: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillSucceedRequest

/acs/entrances/get

• get "/acs/entrances/get"(): (
      parameters?: { acs_entrance_id: string },
      options?: AcsEntrancesGetOptions,
  ) => AcsEntrancesGetRequest

  Returns (
      parameters?: { acs_entrance_id: string },
      options?: AcsEntrancesGetOptions,
  ) => AcsEntrancesGetRequest

/acs/entrances/grant_access

• get "/acs/entrances/grant_access"(): (
      parameters?: {
          acs_entrance_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsEntrancesGrantAccessOptions,
  ) => AcsEntrancesGrantAccessRequest

  Returns (
      parameters?: {
          acs_entrance_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsEntrancesGrantAccessOptions,
  ) => AcsEntrancesGrantAccessRequest

/acs/entrances/list

• get "/acs/entrances/list"(): (
      parameters?: {
          acs_credential_id?: string;
          acs_entrance_ids?: string[];
          acs_system_id?: string;
          connected_account_id?: string;
          customer_key?: string;
          limit?: number;
          location_id?: null | string;
          page_cursor?: null | string;
          search?: string;
          space_id?: string;
      },
      options?: AcsEntrancesListOptions,
  ) => AcsEntrancesListRequest

  Returns (
      parameters?: {
          acs_credential_id?: string;
          acs_entrance_ids?: string[];
          acs_system_id?: string;
          connected_account_id?: string;
          customer_key?: string;
          limit?: number;
          location_id?: null | string;
          page_cursor?: null | string;
          search?: string;
          space_id?: string;
      },
      options?: AcsEntrancesListOptions,
  ) => AcsEntrancesListRequest

/acs/entrances/list_credentials_with_access

• get "/acs/entrances/list_credentials_with_access"(): (
      parameters?: {
          acs_entrance_id: string;
          include_if?: "visionline_metadata.is_valid"[];
      },
      options?: AcsEntrancesListCredentialsWithAccessOptions,
  ) => AcsEntrancesListCredentialsWithAccessRequest

  Returns (
      parameters?: {
          acs_entrance_id: string;
          include_if?: "visionline_metadata.is_valid"[];
      },
      options?: AcsEntrancesListCredentialsWithAccessOptions,
  ) => AcsEntrancesListCredentialsWithAccessRequest

/acs/systems/get

• get "/acs/systems/get"(): (
      parameters?: { acs_system_id: string },
      options?: AcsSystemsGetOptions,
  ) => AcsSystemsGetRequest

  Returns (
      parameters?: { acs_system_id: string },
      options?: AcsSystemsGetOptions,
  ) => AcsSystemsGetRequest

/acs/systems/list

• get "/acs/systems/list"(): (
      parameters?: { connected_account_id?: string; customer_key?: string },
      options?: AcsSystemsListOptions,
  ) => AcsSystemsListRequest

  Returns (
      parameters?: { connected_account_id?: string; customer_key?: string },
      options?: AcsSystemsListOptions,
  ) => AcsSystemsListRequest

/acs/systems/list_compatible_credential_manager_acs_systems

• get "/acs/systems/list_compatible_credential_manager_acs_systems"(): (
      parameters?: { acs_system_id: string },
      options?: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions,
  ) => AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest

  Returns (
      parameters?: { acs_system_id: string },
      options?: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions,
  ) => AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest

/acs/users/add_to_access_group

• get "/acs/users/add_to_access_group"(): (
      parameters?: { acs_access_group_id: string; acs_user_id: string },
      options?: AcsUsersAddToAccessGroupOptions,
  ) => AcsUsersAddToAccessGroupRequest

  Returns (
      parameters?: { acs_access_group_id: string; acs_user_id: string },
      options?: AcsUsersAddToAccessGroupOptions,
  ) => AcsUsersAddToAccessGroupRequest

/acs/users/create

• get "/acs/users/create"(): (
      parameters?: {
          access_schedule?: { ends_at?: null | string; starts_at?: string };
          acs_access_group_ids?: string[];
          acs_system_id: string;
          email?: string;
          email_address?: string;
          full_name: string;
          phone_number?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersCreateOptions,
  ) => AcsUsersCreateRequest

  Returns (
      parameters?: {
          access_schedule?: { ends_at?: null | string; starts_at?: string };
          acs_access_group_ids?: string[];
          acs_system_id: string;
          email?: string;
          email_address?: string;
          full_name: string;
          phone_number?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersCreateOptions,
  ) => AcsUsersCreateRequest

/acs/users/delete

• get "/acs/users/delete"(): (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersDeleteOptions,
  ) => AcsUsersDeleteRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersDeleteOptions,
  ) => AcsUsersDeleteRequest

/acs/users/get

• get "/acs/users/get"(): (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersGetOptions,
  ) => AcsUsersGetRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersGetOptions,
  ) => AcsUsersGetRequest

/acs/users/list

• get "/acs/users/list"(): (
      parameters?: {
          acs_system_id?: string;
          created_before?: Date;
          limit?: number;
          page_cursor?: null | string;
          search?: string;
          user_identity_email_address?: string;
          user_identity_id?: string;
          user_identity_phone_number?: string;
      },
      options?: AcsUsersListOptions,
  ) => AcsUsersListRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          created_before?: Date;
          limit?: number;
          page_cursor?: null | string;
          search?: string;
          user_identity_email_address?: string;
          user_identity_id?: string;
          user_identity_phone_number?: string;
      },
      options?: AcsUsersListOptions,
  ) => AcsUsersListRequest

/acs/users/list_accessible_entrances

• get "/acs/users/list_accessible_entrances"(): (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersListAccessibleEntrancesOptions,
  ) => AcsUsersListAccessibleEntrancesRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersListAccessibleEntrancesOptions,
  ) => AcsUsersListAccessibleEntrancesRequest

/acs/users/remove_from_access_group

• get "/acs/users/remove_from_access_group"(): (
      parameters?: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersRemoveFromAccessGroupOptions,
  ) => AcsUsersRemoveFromAccessGroupRequest

  Returns (
      parameters?: {
          acs_access_group_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersRemoveFromAccessGroupOptions,
  ) => AcsUsersRemoveFromAccessGroupRequest

/acs/users/revoke_access_to_all_entrances

• get "/acs/users/revoke_access_to_all_entrances"(): (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersRevokeAccessToAllEntrancesOptions,
  ) => AcsUsersRevokeAccessToAllEntrancesRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersRevokeAccessToAllEntrancesOptions,
  ) => AcsUsersRevokeAccessToAllEntrancesRequest

/acs/users/suspend

• get "/acs/users/suspend"(): (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersSuspendOptions,
  ) => AcsUsersSuspendRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersSuspendOptions,
  ) => AcsUsersSuspendRequest

/acs/users/unmanaged/get

• get "/acs/users/unmanaged/get"(): (
      parameters?: { acs_user_id: string },
      options?: AcsUsersUnmanagedGetOptions,
  ) => AcsUsersUnmanagedGetRequest

  Returns (
      parameters?: { acs_user_id: string },
      options?: AcsUsersUnmanagedGetOptions,
  ) => AcsUsersUnmanagedGetRequest

/acs/users/unmanaged/list

• get "/acs/users/unmanaged/list"(): (
      parameters?: {
          acs_system_id?: string;
          limit?: number;
          user_identity_email_address?: string;
          user_identity_id?: string;
          user_identity_phone_number?: string;
      },
      options?: AcsUsersUnmanagedListOptions,
  ) => AcsUsersUnmanagedListRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          limit?: number;
          user_identity_email_address?: string;
          user_identity_id?: string;
          user_identity_phone_number?: string;
      },
      options?: AcsUsersUnmanagedListOptions,
  ) => AcsUsersUnmanagedListRequest

/acs/users/unsuspend

• get "/acs/users/unsuspend"(): (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersUnsuspendOptions,
  ) => AcsUsersUnsuspendRequest

  Returns (
      parameters?: {
          acs_system_id?: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersUnsuspendOptions,
  ) => AcsUsersUnsuspendRequest

/acs/users/update

• get "/acs/users/update"(): (
      parameters?: {
          access_schedule?: null | { ends_at: string; starts_at: string };
          acs_system_id?: string;
          acs_user_id?: string;
          email?: string;
          email_address?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          phone_number?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersUpdateOptions,
  ) => AcsUsersUpdateRequest

  Returns (
      parameters?: {
          access_schedule?: null | { ends_at: string; starts_at: string };
          acs_system_id?: string;
          acs_user_id?: string;
          email?: string;
          email_address?: string;
          full_name?: string;
          hid_acs_system_id?: string;
          phone_number?: string;
          user_identity_id?: string;
      },
      options?: AcsUsersUpdateOptions,
  ) => AcsUsersUpdateRequest

/action_attempts/get