Type Alias ActionAttempt

Type Declaration

• {
      action_attempt_id: string;
      action_type: "LOCK_DOOR";
      error: { message: string; type: string } | null;
      result: { was_confirmed_by_device?: boolean } | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: { was_confirmed_by_device?: boolean } | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "UNLOCK_DOOR";
      error: { message: string; type: string } | null;
      result: { was_confirmed_by_device?: boolean } | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: { was_confirmed_by_device?: boolean } | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

  • 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";
          }
          | null;
      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;
              akiles_metadata?: { member_pin_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"
                  | "akiles_credential";
              external_type_display_name?: string;
              is_issued?: boolean;
              is_latest_desired_state_synced_with_provider?: boolean
              | null;
              is_managed: true | false;
              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;
                  new_code?: string;
                  original_code?: string;
                  warning_code: | "waiting_to_be_issued"
                  | "schedule_externally_modified"
                  | "schedule_modified"
                  | "being_deleted"
                  | "unknown_issue_with_acs_credential"
                  | "needs_to_be_reissued"
                  | "requested_code_unavailable";
              }[];
              workspace_id: string;
          }
          | null;
          warnings: {
              warning_code: | "acs_credential_on_encoder_out_of_sync"
              | "acs_credential_on_seam_not_found";
              warning_message: string;
          }[];
      }
      | null;
      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";
        }
        | null

    Null while the action attempt is pending or when this value does not apply.

  • 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;
                akiles_metadata?: { member_pin_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"
                    | "akiles_credential";
                external_type_display_name?: string;
                is_issued?: boolean;
                is_latest_desired_state_synced_with_provider?: boolean
                | null;
                is_managed: true | false;
                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;
                    new_code?: string;
                    original_code?: string;
                    warning_code: | "waiting_to_be_issued"
                    | "schedule_externally_modified"
                    | "schedule_modified"
                    | "being_deleted"
                    | "unknown_issue_with_acs_credential"
                    | "needs_to_be_reissued"
                    | "requested_code_unavailable";
                }[];
                workspace_id: string;
            }
            | null;
            warnings: {
                warning_code: | "acs_credential_on_encoder_out_of_sync"
                | "acs_credential_on_seam_not_found";
                warning_message: string;
            }[];
        }
        | null

    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. Null while the action attempt is pending or when this value does not apply.

  • 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";
          }
          | null;
      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;
          akiles_metadata?: { member_pin_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"
              | "akiles_credential";
          external_type_display_name?: string;
          is_issued?: boolean;
          is_latest_desired_state_synced_with_provider?: boolean
          | null;
          is_managed: true | false;
          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;
              new_code?: string;
              original_code?: string;
              warning_code: | "waiting_to_be_issued"
              | "schedule_externally_modified"
              | "schedule_modified"
              | "being_deleted"
              | "unknown_issue_with_acs_credential"
              | "needs_to_be_reissued"
              | "requested_code_unavailable";
          }[];
          workspace_id: string;
      }
      | null;
      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";
        }
        | null

    Null while the action attempt is pending or when this value does not apply.

  • 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;
            akiles_metadata?: { member_pin_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"
                | "akiles_credential";
            external_type_display_name?: string;
            is_issued?: boolean;
            is_latest_desired_state_synced_with_provider?: boolean
            | null;
            is_managed: true | false;
            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;
                new_code?: string;
                original_code?: string;
                warning_code: | "waiting_to_be_issued"
                | "schedule_externally_modified"
                | "schedule_modified"
                | "being_deleted"
                | "unknown_issue_with_acs_credential"
                | "needs_to_be_reissued"
                | "requested_code_unavailable";
            }[];
            workspace_id: string;
        }
        | null

    Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. Null while the action attempt is pending or when this value does not apply.

  • 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";
          }
          | null;
      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;
          akiles_metadata?: { member_pin_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"
              | "akiles_credential";
          external_type_display_name?: string;
          is_issued?: boolean;
          is_latest_desired_state_synced_with_provider?: boolean
          | null;
          is_managed: true;
          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;
              new_code?: string;
              original_code?: string;
              warning_code: | "waiting_to_be_issued"
              | "schedule_externally_modified"
              | "schedule_modified"
              | "being_deleted"
              | "unknown_issue_with_acs_credential"
              | "needs_to_be_reissued"
              | "requested_code_unavailable";
          }[];
          workspace_id: string;
      }
      | null;
      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";
        }
        | null

    Null while the action attempt is pending or when this value does not apply.

  • 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;
            akiles_metadata?: { member_pin_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"
                | "akiles_credential";
            external_type_display_name?: string;
            is_issued?: boolean;
            is_latest_desired_state_synced_with_provider?: boolean
            | null;
            is_managed: true;
            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;
                new_code?: string;
                original_code?: string;
                warning_code: | "waiting_to_be_issued"
                | "schedule_externally_modified"
                | "schedule_modified"
                | "being_deleted"
                | "unknown_issue_with_acs_credential"
                | "needs_to_be_reissued"
                | "requested_code_unavailable";
            }[];
            workspace_id: string;
        }
        | null

    Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "ASSIGN_CREDENTIAL";
      error:
          | {
              message: string;
              type: | "uncategorized_error"
              | "action_attempt_expired"
              | "credential_not_found";
          }
          | null;
      result: | {
          access_method_id: string;
          client_session_token?: string;
          code?: string
          | null;
          created_at: string;
          customization_profile_id?: string;
          display_name: string;
          display_status: 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;
      }
      | null;
      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";
        }
        | null

    Null while the action attempt is pending or when this value does not apply.

  • result:
        | {
            access_method_id: string;
            client_session_token?: string;
            code?: string
            | null;
            created_at: string;
            customization_profile_id?: string;
            display_name: string;
            display_status: 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;
        }
        | null

    Result of assigning a credential. If successful, includes the updated access method with the assigned credential. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "RESET_SANDBOX_WORKSPACE";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "SET_FAN_MODE";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "SET_HVAC_MODE";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "ACTIVATE_CLIMATE_PRESET";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "PUSH_THERMOSTAT_PROGRAMS";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "CONFIGURE_AUTO_LOCK";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "SYNC_ACCESS_CODES";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "CREATE_ACCESS_CODE";
      error: { message: string; type: string } | null;
      result: { access_code: Record<string, unknown> } | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: { access_code: Record<string, unknown> } | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "DELETE_ACCESS_CODE";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "UPDATE_ACCESS_CODE";
      error: { message: string; type: string } | null;
      result: { access_code?: Record<string, unknown> } | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: { access_code?: Record<string, unknown> } | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "CREATE_NOISE_THRESHOLD";
      error: { message: string; type: string } | null;
      result: { noise_threshold: Record<string, unknown> } | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: { noise_threshold: Record<string, unknown> } | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "DELETE_NOISE_THRESHOLD";
      error: { message: string; type: string } | null;
      result: {} | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: {} | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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

• {
      action_attempt_id: string;
      action_type: "UPDATE_NOISE_THRESHOLD";
      error: { message: string; type: string } | null;
      result: { noise_threshold: Record<string, unknown> } | null;
      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 } | null

    Error associated with the action. Null while the action attempt is pending or when this value does not apply.

  • result: { noise_threshold: Record<string, unknown> } | null

    Result of the action. Null while the action attempt is pending or when this value does not apply.

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