@seamapi/http 1.120.0 → 1.122.0

package/src/lib/seam/connect/resources/action-attempt.ts

@@ -0,0 +1,726 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file.
+ */
+
+export type ActionAttemptResource =
+  | {
+      action_attempt_id: string
+
+      action_type: 'LOCK_DOOR'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {
+        was_confirmed_by_device?: boolean | undefined
+      }
+
+      status: 'success' | 'pending' | 'error'
+    }
+  | {
+      action_attempt_id: string
+
+      action_type: 'UNLOCK_DOOR'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {
+        was_confirmed_by_device?: boolean | undefined
+      }
+
+      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 | undefined
+                card_format?: 'TLCode' | 'rfid48' | undefined
+                card_holder?: string | undefined
+                card_id?: string | undefined
+                common_acs_entrance_ids?: Array<string> | undefined
+                discarded?: boolean | undefined
+                expired?: boolean | undefined
+                guest_acs_entrance_ids?: Array<string> | undefined
+                number_of_issued_cards?: number | undefined
+                overridden?: boolean | undefined
+                overwritten?: boolean | undefined
+                pending_auto_update?: boolean | undefined
+              }
+            | undefined
+        } | null
+        acs_credential_on_seam: {
+          access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
+
+          acs_credential_id: string
+
+          acs_credential_pool_id?: string | undefined
+          acs_system_id: string
+
+          acs_user_id?: string | undefined
+          assa_abloy_vostio_metadata?:
+            | {
+                auto_join?: boolean | undefined
+                door_names?: Array<string> | undefined
+                endpoint_id?: string | undefined
+                key_id?: string | undefined
+                key_issuing_request_id?: string | undefined
+                override_guest_acs_entrance_ids?: Array<string> | undefined
+              }
+            | undefined
+          card_number?: string | null | undefined
+          code?: string | null | undefined
+          connected_account_id: string
+
+          created_at: string
+
+          display_name: string
+
+          ends_at?: string | undefined
+          errors: Array<{
+            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'
+            | undefined
+          external_type_display_name?: string | undefined
+          is_issued?: boolean | undefined
+          is_latest_desired_state_synced_with_provider?:
+            | boolean
+            | null
+            | undefined
+          is_managed: boolean
+
+          is_multi_phone_sync_credential?: boolean | undefined
+          is_one_time_use?: boolean | undefined
+          issued_at?: string | null | undefined
+          latest_desired_state_synced_with_provider_at?:
+            | string
+            | null
+            | undefined
+          parent_acs_credential_id?: string | undefined
+          starts_at?: string | undefined
+          user_identity_id?: string | undefined
+          visionline_metadata?:
+            | {
+                auto_join?: boolean | undefined
+                card_function_type?: 'guest' | 'staff' | undefined
+                card_id?: string | undefined
+                common_acs_entrance_ids?: Array<string> | undefined
+                credential_id?: string | undefined
+                guest_acs_entrance_ids?: Array<string> | undefined
+                is_valid?: boolean | undefined
+                joiner_acs_credential_ids?: Array<string> | undefined
+              }
+            | undefined
+          warnings: Array<{
+            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: Array<{
+          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
+
+      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 | undefined
+        acs_system_id: string
+
+        acs_user_id?: string | undefined
+        assa_abloy_vostio_metadata?:
+          | {
+              auto_join?: boolean | undefined
+              door_names?: Array<string> | undefined
+              endpoint_id?: string | undefined
+              key_id?: string | undefined
+              key_issuing_request_id?: string | undefined
+              override_guest_acs_entrance_ids?: Array<string> | undefined
+            }
+          | undefined
+        card_number?: string | null | undefined
+        code?: string | null | undefined
+        connected_account_id: string
+
+        created_at: string
+
+        display_name: string
+
+        ends_at?: string | undefined
+        errors: Array<{
+          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'
+          | undefined
+        external_type_display_name?: string | undefined
+        is_issued?: boolean | undefined
+        is_latest_desired_state_synced_with_provider?:
+          | boolean
+          | null
+          | undefined
+        is_managed: boolean
+
+        is_multi_phone_sync_credential?: boolean | undefined
+        is_one_time_use?: boolean | undefined
+        issued_at?: string | null | undefined
+        latest_desired_state_synced_with_provider_at?: string | null | undefined
+        parent_acs_credential_id?: string | undefined
+        starts_at?: string | undefined
+        user_identity_id?: string | undefined
+        visionline_metadata?:
+          | {
+              auto_join?: boolean | undefined
+              card_function_type?: 'guest' | 'staff' | undefined
+              card_id?: string | undefined
+              common_acs_entrance_ids?: Array<string> | undefined
+              credential_id?: string | undefined
+              guest_acs_entrance_ids?: Array<string> | undefined
+              is_valid?: boolean | undefined
+              joiner_acs_credential_ids?: Array<string> | undefined
+            }
+          | undefined
+        warnings: Array<{
+          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
+
+      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 | undefined
+        acs_system_id: string
+
+        acs_user_id?: string | undefined
+        assa_abloy_vostio_metadata?:
+          | {
+              auto_join?: boolean | undefined
+              door_names?: Array<string> | undefined
+              endpoint_id?: string | undefined
+              key_id?: string | undefined
+              key_issuing_request_id?: string | undefined
+              override_guest_acs_entrance_ids?: Array<string> | undefined
+            }
+          | undefined
+        card_number?: string | null | undefined
+        code?: string | null | undefined
+        connected_account_id: string
+
+        created_at: string
+
+        display_name: string
+
+        ends_at?: string | undefined
+        errors: Array<{
+          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'
+          | undefined
+        external_type_display_name?: string | undefined
+        is_issued?: boolean | undefined
+        is_latest_desired_state_synced_with_provider?:
+          | boolean
+          | null
+          | undefined
+        is_managed: boolean
+
+        is_multi_phone_sync_credential?: boolean | undefined
+        is_one_time_use?: boolean | undefined
+        issued_at?: string | null | undefined
+        latest_desired_state_synced_with_provider_at?: string | null | undefined
+        parent_acs_credential_id?: string | undefined
+        starts_at?: string | undefined
+        user_identity_id?: string | undefined
+        visionline_metadata?:
+          | {
+              auto_join?: boolean | undefined
+              card_function_type?: 'guest' | 'staff' | undefined
+              card_id?: string | undefined
+              common_acs_entrance_ids?: Array<string> | undefined
+              credential_id?: string | undefined
+              guest_acs_entrance_ids?: Array<string> | undefined
+              is_valid?: boolean | undefined
+              joiner_acs_credential_ids?: Array<string> | undefined
+            }
+          | undefined
+        warnings: Array<{
+          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
+
+      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 | undefined
+        code?: string | null | undefined
+        created_at: string
+
+        customization_profile_id?: string | undefined
+        display_name: string
+
+        errors: Array<{
+          created_at: string
+
+          error_code: 'failed_to_issue'
+
+          message: string
+        }>
+
+        instant_key_url?: string | undefined
+        is_assignment_required?: boolean | undefined
+        is_encoding_required?: boolean | undefined
+        is_issued: boolean
+
+        is_ready_for_assignment?: boolean | undefined
+        is_ready_for_encoding?: boolean | undefined
+        issued_at: string | null
+        mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
+
+        pending_mutations: Array<{
+          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: Array<{
+          created_at: string
+
+          message: string
+
+          warning_code:
+            | 'being_deleted'
+            | 'updating_access_times'
+            | 'pulled_backup_access_code'
+            | 'delay_in_issuing'
+
+          original_access_method_id?: string | undefined
+        }>
+
+        workspace_id: string
+      }
+
+      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
+
+      action_type: 'SET_FAN_MODE'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      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
+
+      action_type: 'ACTIVATE_CLIMATE_PRESET'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      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
+
+      action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      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
+
+      action_type: 'CONFIGURE_AUTO_LOCK'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      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
+
+      action_type: 'CREATE_ACCESS_CODE'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      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
+
+      action_type: 'UPDATE_ACCESS_CODE'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      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
+
+      action_type: 'DELETE_NOISE_THRESHOLD'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      status: 'success' | 'pending' | 'error'
+    }
+  | {
+      action_attempt_id: string
+
+      action_type: 'UPDATE_NOISE_THRESHOLD'
+
+      error: {
+        message: string
+
+        type: string
+      }
+
+      result: {}
+
+      status: 'success' | 'pending' | 'error'
+    }