Type Alias ActionAttempt

Type Declaration

• {
      action_attempt_id: string;
      action_type: "LOCK_DOOR";
      error: { message: string; type: string };
      result: { was_confirmed_by_device?: boolean };
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "LOCK_DOOR"

    Action attempt to track the status of locking a door.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: { was_confirmed_by_device?: boolean }

    Result of the action.

    • Optionalwas_confirmed_by_device?: boolean

      Indicates whether the device confirmed that the lock action occurred.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "UNLOCK_DOOR";
      error: { message: string; type: string };
      result: { was_confirmed_by_device?: boolean };
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "UNLOCK_DOOR"

    Action attempt to track the status of unlocking a door.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: { was_confirmed_by_device?: boolean }

    Result of the action.

    • Optionalwas_confirmed_by_device?: boolean

      Indicates whether the device confirmed that the unlock action occurred.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "SCAN_CREDENTIAL";
      error: {
          message: string;
          type:
              | "uncategorized_error"
              | "action_attempt_expired"
              | "no_credential_on_encoder"
              | "encoder_not_online"
              | "encoder_communication_timeout"
              | "bridge_disconnected";
      };
      result: {
          acs_credential_on_encoder: | {
              card_number: string
              | null;
              created_at: string | null;
              ends_at: string | null;
              is_issued: boolean | null;
              starts_at: string | null;
              visionline_metadata?: {
                  cancelled?: boolean;
                  card_format?: "TLCode" | "rfid48";
                  card_holder?: string;
                  card_id?: string;
                  common_acs_entrance_ids?: string[];
                  discarded?: boolean;
                  expired?: boolean;
                  guest_acs_entrance_ids?: string[];
                  number_of_issued_cards?: number;
                  overridden?: boolean;
                  overwritten?: boolean;
                  pending_auto_update?: boolean;
              };
          }
          | null;
          acs_credential_on_seam: {
              access_method: "code"
              | "card"
              | "mobile_key"
              | "cloud_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?: string
              | null;
              code?: string | null;
              connected_account_id: string;
              created_at: string;
              display_name: string;
              ends_at?: string;
              errors: { created_at: string; 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"
                  | "dormakaba_ambiance_credential"
                  | "hotek_card"
                  | "salto_ks_tag"
                  | "avigilon_alta_credential"
                  | "kisi_credential";
              external_type_display_name?: string;
              is_issued?: boolean;
              is_latest_desired_state_synced_with_provider?: boolean
              | null;
              is_managed: boolean;
              is_multi_phone_sync_credential?: boolean;
              is_one_time_use?: boolean;
              issued_at?: string | null;
              latest_desired_state_synced_with_provider_at?: string | null;
              parent_acs_credential_id?: string;
              starts_at?: string;
              user_identity_id?: 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"
                  | "schedule_externally_modified"
                  | "schedule_modified"
                  | "being_deleted"
                  | "unknown_issue_with_acs_credential"
                  | "needs_to_be_reissued";
              }[];
              workspace_id: string;
          };
          warnings: {
              warning_code: | "acs_credential_on_encoder_out_of_sync"
              | "acs_credential_on_seam_not_found";
              warning_message: string;
          }[];
      };
      status: "success"
      | "pending"
      | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "SCAN_CREDENTIAL"

    Action attempt to track the status of scanning a credential.

  • error: {
        message: string;
        type:
            | "uncategorized_error"
            | "action_attempt_expired"
            | "no_credential_on_encoder"
            | "encoder_not_online"
            | "encoder_communication_timeout"
            | "bridge_disconnected";
    }

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type:
          | "uncategorized_error"
          | "action_attempt_expired"
          | "no_credential_on_encoder"
          | "encoder_not_online"
          | "encoder_communication_timeout"
          | "bridge_disconnected"

      Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system.

  • result: {
        acs_credential_on_encoder:
            | {
                card_number: string
                | null;
                created_at: string | null;
                ends_at: string | null;
                is_issued: boolean | null;
                starts_at: string | null;
                visionline_metadata?: {
                    cancelled?: boolean;
                    card_format?: "TLCode" | "rfid48";
                    card_holder?: string;
                    card_id?: string;
                    common_acs_entrance_ids?: string[];
                    discarded?: boolean;
                    expired?: boolean;
                    guest_acs_entrance_ids?: string[];
                    number_of_issued_cards?: number;
                    overridden?: boolean;
                    overwritten?: boolean;
                    pending_auto_update?: boolean;
                };
            }
            | null;
        acs_credential_on_seam: {
            access_method: "code"
            | "card"
            | "mobile_key"
            | "cloud_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?: string
            | null;
            code?: string | null;
            connected_account_id: string;
            created_at: string;
            display_name: string;
            ends_at?: string;
            errors: { created_at: string; 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"
                | "dormakaba_ambiance_credential"
                | "hotek_card"
                | "salto_ks_tag"
                | "avigilon_alta_credential"
                | "kisi_credential";
            external_type_display_name?: string;
            is_issued?: boolean;
            is_latest_desired_state_synced_with_provider?: boolean
            | null;
            is_managed: boolean;
            is_multi_phone_sync_credential?: boolean;
            is_one_time_use?: boolean;
            issued_at?: string | null;
            latest_desired_state_synced_with_provider_at?: string | null;
            parent_acs_credential_id?: string;
            starts_at?: string;
            user_identity_id?: 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"
                | "schedule_externally_modified"
                | "schedule_modified"
                | "being_deleted"
                | "unknown_issue_with_acs_credential"
                | "needs_to_be_reissued";
            }[];
            workspace_id: string;
        };
        warnings: {
            warning_code: | "acs_credential_on_encoder_out_of_sync"
            | "acs_credential_on_seam_not_found";
            warning_message: string;
        }[];
    }

    Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings.

    • acs_credential_on_encoder:
          | {
              card_number: string
              | null;
              created_at: string | null;
              ends_at: string | null;
              is_issued: boolean | null;
              starts_at: string | null;
              visionline_metadata?: {
                  cancelled?: boolean;
                  card_format?: "TLCode" | "rfid48";
                  card_holder?: string;
                  card_id?: string;
                  common_acs_entrance_ids?: string[];
                  discarded?: boolean;
                  expired?: boolean;
                  guest_acs_entrance_ids?: string[];
                  number_of_issued_cards?: number;
                  overridden?: boolean;
                  overwritten?: boolean;
                  pending_auto_update?: boolean;
              };
          }
          | null

      Snapshot of credential data read from the physical encoder.

    • acs_credential_on_seam: {
          access_method: "code" | "card" | "mobile_key" | "cloud_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?: string
          | null;
          code?: string | null;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          ends_at?: string;
          errors: { created_at: string; 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"
              | "dormakaba_ambiance_credential"
              | "hotek_card"
              | "salto_ks_tag"
              | "avigilon_alta_credential"
              | "kisi_credential";
          external_type_display_name?: string;
          is_issued?: boolean;
          is_latest_desired_state_synced_with_provider?: boolean
          | null;
          is_managed: boolean;
          is_multi_phone_sync_credential?: boolean;
          is_one_time_use?: boolean;
          issued_at?: string | null;
          latest_desired_state_synced_with_provider_at?: string | null;
          parent_acs_credential_id?: string;
          starts_at?: string;
          user_identity_id?: 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"
              | "schedule_externally_modified"
              | "schedule_modified"
              | "being_deleted"
              | "unknown_issue_with_acs_credential"
              | "needs_to_be_reissued";
          }[];
          workspace_id: string;
      }

      Corresponding credential data as stored on Seam and the access system.

      • access_method: "code" | "card" | "mobile_key" | "cloud_key"

        Access method for the credential. Supported values: code, card, mobile_key, cloud_key.

      • acs_credential_id: string

        ID of the credential.

      • Optionalacs_credential_pool_id?: string

        ID of the credential pool to which the credential belongs.

      • acs_system_id: string

        ID of the access control system that contains the credential.

      • Optionalacs_user_id?: string

        ID of the ACS user to whom the credential belongs.

      • Optionalassa_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[];
        }

        Vostio-specific metadata for the credential.

        • Optionalauto_join?: boolean

          Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.

        • Optionaldoor_names?: string[]

          Names of the doors to which to grant access in the Vostio access system.

        • Optionalendpoint_id?: string

          Endpoint ID in the Vostio access system.

        • Optionalkey_id?: string

          Key ID in the Vostio access system.

        • Optionalkey_issuing_request_id?: string

          Key issuing request ID in the Vostio access system.

        • Optionaloverride_guest_acs_entrance_ids?: string[]

          IDs of the guest entrances to override in the Vostio access system.

      • Optionalcard_number?: string | null

        Number of the card associated with the credential.

      • Optionalcode?: string | null

        Access (PIN) code for the credential.

      • connected_account_id: string

        ID of the connected account to which the credential belongs.

      • created_at: string

        Date and time at which the credential was created.

      • display_name: string

        Display name that corresponds to the credential type.

      • Optionalends_at?: string

        Date and time at which the credential validity ends, in ISO 8601 format. Must be a time in the future and after starts_at.

      • errors: { created_at: string; error_code: string; message: string }[]

        Errors associated with the credential.

      • Optionalexternal_type?:
            | "pti_card"
            | "brivo_credential"
            | "hid_credential"
            | "visionline_card"
            | "salto_ks_credential"
            | "assa_abloy_vostio_key"
            | "salto_space_key"
            | "latch_access"
            | "dormakaba_ambiance_credential"
            | "hotek_card"
            | "salto_ks_tag"
            | "avigilon_alta_credential"
            | "kisi_credential"

        Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.

      • Optionalexternal_type_display_name?: string

        Display name that corresponds to the brand-specific terminology for the credential type.

      • Optionalis_issued?: boolean

        Indicates whether the credential has been encoded onto a card.

      • Optionalis_latest_desired_state_synced_with_provider?: boolean | null

        Indicates whether the latest state of the credential has been synced from Seam to the provider.

      • is_managed: boolean

      • Optionalis_multi_phone_sync_credential?: boolean

        Indicates whether the credential is a multi-phone sync credential.

      • Optionalis_one_time_use?: boolean

        Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.

      • Optionalissued_at?: string | null

        Date and time at which the credential was encoded onto a card.

      • Optionallatest_desired_state_synced_with_provider_at?: string | null

        Date and time at which the state of the credential was most recently synced from Seam to the provider.

      • Optionalparent_acs_credential_id?: string

        ID of the parent credential.

      • Optionalstarts_at?: string

        Date and time at which the credential validity starts, in ISO 8601 format.

      • Optionaluser_identity_id?: string

        ID of the user identity to whom the credential belongs.

      • Optionalvisionline_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[];
        }

        Visionline-specific metadata for the credential.

        • Optionalauto_join?: boolean

          Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.

        • Optionalcard_function_type?: "guest" | "staff"

          Card function type in the Visionline access system.

        • Optionalcard_id?: string

          ID of the card in the Visionline access system.

        • Optionalcommon_acs_entrance_ids?: string[]

          Common entrance IDs in the Visionline access system.

        • Optionalcredential_id?: string

          ID of the credential in the Visionline access system.

        • Optionalguest_acs_entrance_ids?: string[]

          Guest entrance IDs in the Visionline access system.

        • Optionalis_valid?: boolean

          Indicates whether the credential is valid.

        • Optionaljoiner_acs_credential_ids?: string[]

          IDs of the credentials to which you want to join.

      • warnings: {
            created_at: string;
            message: string;
            warning_code:
                | "waiting_to_be_issued"
                | "schedule_externally_modified"
                | "schedule_modified"
                | "being_deleted"
                | "unknown_issue_with_acs_credential"
                | "needs_to_be_reissued";
        }[]

        Warnings associated with the credential.

      • workspace_id: string

        ID of the workspace that contains the credential.

    • warnings: {
          warning_code:
              | "acs_credential_on_encoder_out_of_sync"
              | "acs_credential_on_seam_not_found";
          warning_message: string;
      }[]

      Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "ENCODE_CREDENTIAL";
      error: {
          message: string;
          type:
              | "uncategorized_error"
              | "action_attempt_expired"
              | "no_credential_on_encoder"
              | "incompatible_card_format"
              | "credential_cannot_be_reissued"
              | "encoder_not_online"
              | "encoder_communication_timeout"
              | "bridge_disconnected"
              | "encoding_interrupted"
              | "credential_deleted";
      };
      result: {
          access_method: "code"
          | "card"
          | "mobile_key"
          | "cloud_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?: string
          | null;
          code?: string | null;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          ends_at?: string;
          errors: { created_at: string; 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"
              | "dormakaba_ambiance_credential"
              | "hotek_card"
              | "salto_ks_tag"
              | "avigilon_alta_credential"
              | "kisi_credential";
          external_type_display_name?: string;
          is_issued?: boolean;
          is_latest_desired_state_synced_with_provider?: boolean
          | null;
          is_managed: boolean;
          is_multi_phone_sync_credential?: boolean;
          is_one_time_use?: boolean;
          issued_at?: string | null;
          latest_desired_state_synced_with_provider_at?: string | null;
          parent_acs_credential_id?: string;
          starts_at?: string;
          user_identity_id?: 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"
              | "schedule_externally_modified"
              | "schedule_modified"
              | "being_deleted"
              | "unknown_issue_with_acs_credential"
              | "needs_to_be_reissued";
          }[];
          workspace_id: string;
      };
      status: "success"
      | "pending"
      | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "ENCODE_CREDENTIAL"

    Action attempt to track the status of encoding credential data from the physical encoder onto a card.

  • error: {
        message: string;
        type:
            | "uncategorized_error"
            | "action_attempt_expired"
            | "no_credential_on_encoder"
            | "incompatible_card_format"
            | "credential_cannot_be_reissued"
            | "encoder_not_online"
            | "encoder_communication_timeout"
            | "bridge_disconnected"
            | "encoding_interrupted"
            | "credential_deleted";
    }

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type:
          | "uncategorized_error"
          | "action_attempt_expired"
          | "no_credential_on_encoder"
          | "incompatible_card_format"
          | "credential_cannot_be_reissued"
          | "encoder_not_online"
          | "encoder_communication_timeout"
          | "bridge_disconnected"
          | "encoding_interrupted"
          | "credential_deleted"

      Error type to indicate that the credential was deleted and can no longer be encoded.

  • result: {
        access_method: "code" | "card" | "mobile_key" | "cloud_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?: string
        | null;
        code?: string | null;
        connected_account_id: string;
        created_at: string;
        display_name: string;
        ends_at?: string;
        errors: { created_at: string; 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"
            | "dormakaba_ambiance_credential"
            | "hotek_card"
            | "salto_ks_tag"
            | "avigilon_alta_credential"
            | "kisi_credential";
        external_type_display_name?: string;
        is_issued?: boolean;
        is_latest_desired_state_synced_with_provider?: boolean
        | null;
        is_managed: boolean;
        is_multi_phone_sync_credential?: boolean;
        is_one_time_use?: boolean;
        issued_at?: string | null;
        latest_desired_state_synced_with_provider_at?: string | null;
        parent_acs_credential_id?: string;
        starts_at?: string;
        user_identity_id?: 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"
            | "schedule_externally_modified"
            | "schedule_modified"
            | "being_deleted"
            | "unknown_issue_with_acs_credential"
            | "needs_to_be_reissued";
        }[];
        workspace_id: string;
    }

    Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card.

    • access_method: "code" | "card" | "mobile_key" | "cloud_key"

      Access method for the credential. Supported values: code, card, mobile_key, cloud_key.

    • acs_credential_id: string

      ID of the credential.

    • Optionalacs_credential_pool_id?: string

      ID of the credential pool to which the credential belongs.

    • acs_system_id: string

      ID of the access control system that contains the credential.

    • Optionalacs_user_id?: string

      ID of the ACS user to whom the credential belongs.

    • Optionalassa_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[];
      }

      Vostio-specific metadata for the credential.

      • Optionalauto_join?: boolean

        Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.

      • Optionaldoor_names?: string[]

        Names of the doors to which to grant access in the Vostio access system.

      • Optionalendpoint_id?: string

        Endpoint ID in the Vostio access system.

      • Optionalkey_id?: string

        Key ID in the Vostio access system.

      • Optionalkey_issuing_request_id?: string

        Key issuing request ID in the Vostio access system.

      • Optionaloverride_guest_acs_entrance_ids?: string[]

        IDs of the guest entrances to override in the Vostio access system.

    • Optionalcard_number?: string | null

      Number of the card associated with the credential.

    • Optionalcode?: string | null

      Access (PIN) code for the credential.

    • connected_account_id: string

      ID of the connected account to which the credential belongs.

    • created_at: string

      Date and time at which the credential was created.

    • display_name: string

      Display name that corresponds to the credential type.

    • Optionalends_at?: string

      Date and time at which the credential validity ends, in ISO 8601 format. Must be a time in the future and after starts_at.

    • errors: { created_at: string; error_code: string; message: string }[]

      Errors associated with the credential.

    • Optionalexternal_type?:
          | "pti_card"
          | "brivo_credential"
          | "hid_credential"
          | "visionline_card"
          | "salto_ks_credential"
          | "assa_abloy_vostio_key"
          | "salto_space_key"
          | "latch_access"
          | "dormakaba_ambiance_credential"
          | "hotek_card"
          | "salto_ks_tag"
          | "avigilon_alta_credential"
          | "kisi_credential"

      Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.

    • Optionalexternal_type_display_name?: string

      Display name that corresponds to the brand-specific terminology for the credential type.

    • Optionalis_issued?: boolean

      Indicates whether the credential has been encoded onto a card.

    • Optionalis_latest_desired_state_synced_with_provider?: boolean | null

      Indicates whether the latest state of the credential has been synced from Seam to the provider.

    • is_managed: boolean

    • Optionalis_multi_phone_sync_credential?: boolean

      Indicates whether the credential is a multi-phone sync credential.

    • Optionalis_one_time_use?: boolean

      Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.

    • Optionalissued_at?: string | null

      Date and time at which the credential was encoded onto a card.

    • Optionallatest_desired_state_synced_with_provider_at?: string | null

      Date and time at which the state of the credential was most recently synced from Seam to the provider.

    • Optionalparent_acs_credential_id?: string

      ID of the parent credential.

    • Optionalstarts_at?: string

      Date and time at which the credential validity starts, in ISO 8601 format.

    • Optionaluser_identity_id?: string

      ID of the user identity to whom the credential belongs.

    • Optionalvisionline_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[];
      }

      Visionline-specific metadata for the credential.

      • Optionalauto_join?: boolean

        Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.

      • Optionalcard_function_type?: "guest" | "staff"

        Card function type in the Visionline access system.

      • Optionalcard_id?: string

        ID of the card in the Visionline access system.

      • Optionalcommon_acs_entrance_ids?: string[]

        Common entrance IDs in the Visionline access system.

      • Optionalcredential_id?: string

        ID of the credential in the Visionline access system.

      • Optionalguest_acs_entrance_ids?: string[]

        Guest entrance IDs in the Visionline access system.

      • Optionalis_valid?: boolean

        Indicates whether the credential is valid.

      • Optionaljoiner_acs_credential_ids?: string[]

        IDs of the credentials to which you want to join.

    • warnings: {
          created_at: string;
          message: string;
          warning_code:
              | "waiting_to_be_issued"
              | "schedule_externally_modified"
              | "schedule_modified"
              | "being_deleted"
              | "unknown_issue_with_acs_credential"
              | "needs_to_be_reissued";
      }[]

      Warnings associated with the credential.

    • workspace_id: string

      ID of the workspace that contains the credential.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "SCAN_TO_ASSIGN_CREDENTIAL";
      error: {
          message: string;
          type:
              | "uncategorized_error"
              | "action_attempt_expired"
              | "no_credential_on_encoder";
      };
      result: {
          access_method: "code"
          | "card"
          | "mobile_key"
          | "cloud_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?: string
          | null;
          code?: string | null;
          connected_account_id: string;
          created_at: string;
          display_name: string;
          ends_at?: string;
          errors: { created_at: string; 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"
              | "dormakaba_ambiance_credential"
              | "hotek_card"
              | "salto_ks_tag"
              | "avigilon_alta_credential"
              | "kisi_credential";
          external_type_display_name?: string;
          is_issued?: boolean;
          is_latest_desired_state_synced_with_provider?: boolean
          | null;
          is_managed: boolean;
          is_multi_phone_sync_credential?: boolean;
          is_one_time_use?: boolean;
          issued_at?: string | null;
          latest_desired_state_synced_with_provider_at?: string | null;
          parent_acs_credential_id?: string;
          starts_at?: string;
          user_identity_id?: 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"
              | "schedule_externally_modified"
              | "schedule_modified"
              | "being_deleted"
              | "unknown_issue_with_acs_credential"
              | "needs_to_be_reissued";
          }[];
          workspace_id: string;
      };
      status: "success"
      | "pending"
      | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "SCAN_TO_ASSIGN_CREDENTIAL"

    Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.

  • error: {
        message: string;
        type:
            | "uncategorized_error"
            | "action_attempt_expired"
            | "no_credential_on_encoder";
    }

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: "uncategorized_error" | "action_attempt_expired" | "no_credential_on_encoder"

      Error type to indicate that there is no credential on the encoder.

  • result: {
        access_method: "code" | "card" | "mobile_key" | "cloud_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?: string
        | null;
        code?: string | null;
        connected_account_id: string;
        created_at: string;
        display_name: string;
        ends_at?: string;
        errors: { created_at: string; 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"
            | "dormakaba_ambiance_credential"
            | "hotek_card"
            | "salto_ks_tag"
            | "avigilon_alta_credential"
            | "kisi_credential";
        external_type_display_name?: string;
        is_issued?: boolean;
        is_latest_desired_state_synced_with_provider?: boolean
        | null;
        is_managed: boolean;
        is_multi_phone_sync_credential?: boolean;
        is_one_time_use?: boolean;
        issued_at?: string | null;
        latest_desired_state_synced_with_provider_at?: string | null;
        parent_acs_credential_id?: string;
        starts_at?: string;
        user_identity_id?: 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"
            | "schedule_externally_modified"
            | "schedule_modified"
            | "being_deleted"
            | "unknown_issue_with_acs_credential"
            | "needs_to_be_reissued";
        }[];
        workspace_id: string;
    }

    Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned.

    • access_method: "code" | "card" | "mobile_key" | "cloud_key"

      Access method for the credential. Supported values: code, card, mobile_key, cloud_key.

    • acs_credential_id: string

      ID of the credential.

    • Optionalacs_credential_pool_id?: string

      ID of the credential pool to which the credential belongs.

    • acs_system_id: string

      ID of the access control system that contains the credential.

    • Optionalacs_user_id?: string

      ID of the ACS user to whom the credential belongs.

    • Optionalassa_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[];
      }

      Vostio-specific metadata for the credential.

      • Optionalauto_join?: boolean

        Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.

      • Optionaldoor_names?: string[]

        Names of the doors to which to grant access in the Vostio access system.

      • Optionalendpoint_id?: string

        Endpoint ID in the Vostio access system.

      • Optionalkey_id?: string

        Key ID in the Vostio access system.

      • Optionalkey_issuing_request_id?: string

        Key issuing request ID in the Vostio access system.

      • Optionaloverride_guest_acs_entrance_ids?: string[]

        IDs of the guest entrances to override in the Vostio access system.

    • Optionalcard_number?: string | null

      Number of the card associated with the credential.

    • Optionalcode?: string | null

      Access (PIN) code for the credential.

    • connected_account_id: string

      ID of the connected account to which the credential belongs.

    • created_at: string

      Date and time at which the credential was created.

    • display_name: string

      Display name that corresponds to the credential type.

    • Optionalends_at?: string

      Date and time at which the credential validity ends, in ISO 8601 format. Must be a time in the future and after starts_at.

    • errors: { created_at: string; error_code: string; message: string }[]

      Errors associated with the credential.

    • Optionalexternal_type?:
          | "pti_card"
          | "brivo_credential"
          | "hid_credential"
          | "visionline_card"
          | "salto_ks_credential"
          | "assa_abloy_vostio_key"
          | "salto_space_key"
          | "latch_access"
          | "dormakaba_ambiance_credential"
          | "hotek_card"
          | "salto_ks_tag"
          | "avigilon_alta_credential"
          | "kisi_credential"

      Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.

    • Optionalexternal_type_display_name?: string

      Display name that corresponds to the brand-specific terminology for the credential type.

    • Optionalis_issued?: boolean

      Indicates whether the credential has been encoded onto a card.

    • Optionalis_latest_desired_state_synced_with_provider?: boolean | null

      Indicates whether the latest state of the credential has been synced from Seam to the provider.

    • is_managed: boolean

      Indicates whether Seam manages the credential.

    • Optionalis_multi_phone_sync_credential?: boolean

      Indicates whether the credential is a multi-phone sync credential.

    • Optionalis_one_time_use?: boolean

      Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.

    • Optionalissued_at?: string | null

      Date and time at which the credential was encoded onto a card.

    • Optionallatest_desired_state_synced_with_provider_at?: string | null

      Date and time at which the state of the credential was most recently synced from Seam to the provider.

    • Optionalparent_acs_credential_id?: string

      ID of the parent credential.

    • Optionalstarts_at?: string

      Date and time at which the credential validity starts, in ISO 8601 format.

    • Optionaluser_identity_id?: string

      ID of the user identity to whom the credential belongs.

    • Optionalvisionline_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[];
      }

      Visionline-specific metadata for the credential.

      • Optionalauto_join?: boolean

        Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.

      • Optionalcard_function_type?: "guest" | "staff"

        Card function type in the Visionline access system.

      • Optionalcard_id?: string

        ID of the card in the Visionline access system.

      • Optionalcommon_acs_entrance_ids?: string[]

        Common entrance IDs in the Visionline access system.

      • Optionalcredential_id?: string

        ID of the credential in the Visionline access system.

      • Optionalguest_acs_entrance_ids?: string[]

        Guest entrance IDs in the Visionline access system.

      • Optionalis_valid?: boolean

        Indicates whether the credential is valid.

      • Optionaljoiner_acs_credential_ids?: string[]

        IDs of the credentials to which you want to join.

    • warnings: {
          created_at: string;
          message: string;
          warning_code:
              | "waiting_to_be_issued"
              | "schedule_externally_modified"
              | "schedule_modified"
              | "being_deleted"
              | "unknown_issue_with_acs_credential"
              | "needs_to_be_reissued";
      }[]

      Warnings associated with the credential.

    • workspace_id: string

      ID of the workspace that contains the credential.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "ASSIGN_CREDENTIAL";
      error: {
          message: string;
          type:
              | "uncategorized_error"
              | "action_attempt_expired"
              | "credential_not_found";
      };
      result: {
          access_method_id: string;
          client_session_token?: string;
          code?: string
          | null;
          created_at: string;
          customization_profile_id?: string;
          display_name: string;
          errors: {
              created_at: string;
              error_code: "failed_to_issue";
              message: string;
          }[];
          instant_key_url?: string;
          is_assignment_required?: boolean;
          is_encoding_required?: boolean;
          is_issued: boolean;
          is_ready_for_assignment?: boolean;
          is_ready_for_encoding?: boolean;
          issued_at: string
          | null;
          mode: "code" | "card" | "mobile_key" | "cloud_key";
          pending_mutations: {
              created_at: string;
              from: { ends_at: string | null; starts_at: string | null };
              message: string;
              mutation_code:
                  | "provisioning_access"
                  | "revoking_access"
                  | "updating_access_times";
              to: { ends_at: string
              | null; starts_at: string | null };
          }[];
          warnings: {
              created_at: string;
              message: string;
              original_access_method_id?: string;
              warning_code: | "being_deleted"
              | "updating_access_times"
              | "pulled_backup_access_code"
              | "delay_in_issuing";
          }[];
          workspace_id: string;
      };
      status: "success"
      | "pending"
      | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "ASSIGN_CREDENTIAL"

    Action attempt to track the status of assigning a pre-registered card credential to an access method.

  • error: {
        message: string;
        type:
            | "uncategorized_error"
            | "action_attempt_expired"
            | "credential_not_found";
    }

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: "uncategorized_error" | "action_attempt_expired" | "credential_not_found"

      Error type to indicate that no matching credential was found.

  • result: {
        access_method_id: string;
        client_session_token?: string;
        code?: string | null;
        created_at: string;
        customization_profile_id?: string;
        display_name: string;
        errors: {
            created_at: string;
            error_code: "failed_to_issue";
            message: string;
        }[];
        instant_key_url?: string;
        is_assignment_required?: boolean;
        is_encoding_required?: boolean;
        is_issued: boolean;
        is_ready_for_assignment?: boolean;
        is_ready_for_encoding?: boolean;
        issued_at: string
        | null;
        mode: "code" | "card" | "mobile_key" | "cloud_key";
        pending_mutations: {
            created_at: string;
            from: { ends_at: string | null; starts_at: string | null };
            message: string;
            mutation_code:
                | "provisioning_access"
                | "revoking_access"
                | "updating_access_times";
            to: { ends_at: string
            | null; starts_at: string | null };
        }[];
        warnings: {
            created_at: string;
            message: string;
            original_access_method_id?: string;
            warning_code: | "being_deleted"
            | "updating_access_times"
            | "pulled_backup_access_code"
            | "delay_in_issuing";
        }[];
        workspace_id: string;
    }

    Result of assigning a credential. If successful, includes the updated access method with the assigned credential.

    • access_method_id: string

      ID of the access method.

    • Optionalclient_session_token?: string

      Token of the client session associated with the access method.

    • Optionalcode?: string | null

      The actual PIN code for code access methods.

    • created_at: string

      Date and time at which the access method was created.

    • Optionalcustomization_profile_id?: string

      ID of the customization profile associated with the access method.

    • display_name: string

      Display name of the access method.

    • errors: { created_at: string; error_code: "failed_to_issue"; message: string }[]

      Errors associated with the access method.

    • Optionalinstant_key_url?: string

      URL of the Instant Key for mobile key access methods.

    • Optionalis_assignment_required?: boolean

      Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.

    • Optionalis_encoding_required?: boolean

      Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.

    • is_issued: boolean

      Indicates whether the access method has been issued.

    • Optionalis_ready_for_assignment?: boolean

      Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.

    • Optionalis_ready_for_encoding?: boolean

      Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.

    • issued_at: string | null

      Date and time at which the access method was issued.

    • mode: "code" | "card" | "mobile_key" | "cloud_key"

      Access method mode. Supported values: code, card, mobile_key, cloud_key.

    • pending_mutations: {
          created_at: string;
          from: { ends_at: string | null; starts_at: string | null };
          message: string;
          mutation_code:
              | "provisioning_access"
              | "revoking_access"
              | "updating_access_times";
          to: { ends_at: string
          | null; starts_at: string | null };
      }[]

      Pending mutations for the access method. Indicates operations that are in progress.

    • warnings: {
          created_at: string;
          message: string;
          original_access_method_id?: string;
          warning_code:
              | "being_deleted"
              | "updating_access_times"
              | "pulled_backup_access_code"
              | "delay_in_issuing";
      }[]

      Warnings associated with the access method.

    • workspace_id: string

      ID of the Seam workspace associated with the access method.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "RESET_SANDBOX_WORKSPACE";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "RESET_SANDBOX_WORKSPACE"

    Action attempt to track the status of resetting a sandbox workspace.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "SET_FAN_MODE";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "SET_FAN_MODE"

    Action attempt to track the status of setting the fan mode on a thermostat.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "SET_HVAC_MODE";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "SET_HVAC_MODE"

    Action attempt to track the status of setting the HVAC mode on a thermostat.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "ACTIVATE_CLIMATE_PRESET";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "ACTIVATE_CLIMATE_PRESET"

    Action attempt to track the status of a climate preset activation.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "SIMULATE_KEYPAD_CODE_ENTRY"

    Action attempt to track the status of simulating a keypad code entry.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD"

    Action attempt to track the status of simulating a manual lock action using a keypad.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "PUSH_THERMOSTAT_PROGRAMS";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "PUSH_THERMOSTAT_PROGRAMS"

    Action attempt to track the status of pushing thermostat programs.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "CONFIGURE_AUTO_LOCK";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "CONFIGURE_AUTO_LOCK"

    Action attempt to track the status of configuring the auto-lock on a lock.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "SYNC_ACCESS_CODES";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "SYNC_ACCESS_CODES"

    Syncing access codes is pending.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "CREATE_ACCESS_CODE";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "CREATE_ACCESS_CODE"

    Creating an access code is pending.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "DELETE_ACCESS_CODE";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "DELETE_ACCESS_CODE"

    Deleting an access code is pending.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "UPDATE_ACCESS_CODE";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "UPDATE_ACCESS_CODE"

    Updating an access code is pending.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "CREATE_NOISE_THRESHOLD";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "CREATE_NOISE_THRESHOLD"

    Creating a noise threshold is pending.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "DELETE_NOISE_THRESHOLD";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "DELETE_NOISE_THRESHOLD"

    Deleting a noise threshold is pending.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"

• {
      action_attempt_id: string;
      action_type: "UPDATE_NOISE_THRESHOLD";
      error: { message: string; type: string };
      result: {};
      status: "success" | "pending" | "error";
  }

  • action_attempt_id: string

    ID of the action attempt.

  • action_type: "UPDATE_NOISE_THRESHOLD"

    Updating a noise threshold is pending.

  • error: { message: string; type: string }

    Error associated with the action.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    • type: string

      Type of the error.

  • result: {}

    Result of the action.

  • status: "success" | "pending" | "error"