Class SeamHttpSeamMobileSdkV1AcsCredentials

constructor

• new SeamHttpSeamMobileSdkV1AcsCredentials(apiKeyOrOptions?): SeamHttpSeamMobileSdkV1AcsCredentials

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamMobileSdkV1AcsCredentials

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>

list

• list(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: {}

  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?): SeamHttpSeamMobileSdkV1AcsCredentials

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1AcsCredentials

StaticfromClient

• fromClient(client, options?): SeamHttpSeamMobileSdkV1AcsCredentials

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1AcsCredentials

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamMobileSdkV1AcsCredentials

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1AcsCredentials

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1AcsCredentials

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSeamMobileSdkV1AcsCredentials

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamMobileSdkV1AcsCredentials>