Class SeamHttpAccessCodes

constructor

• new SeamHttpAccessCodes(apiKeyOrOptions?): SeamHttpAccessCodes

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodes

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

simulate

• get simulate(): SeamHttpAccessCodesSimulate

• Returns SeamHttpAccessCodesSimulate

unmanaged

• get unmanaged(): SeamHttpAccessCodesUnmanaged

• Returns SeamHttpAccessCodesUnmanaged

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      access_code: {
          access_code_id: string;
          code: null | string;
          common_code_key: null | string;
          created_at: string;
          device_id: string;
          ends_at?: null | string;
          errors: (
              | {
                  created_at?: string;
                  error_code: "smartthings_failed_to_set_access_code";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "smartthings_failed_to_set_after_multiple_retries";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "smartthings_no_free_slots_available";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "failed_to_set_on_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "failed_to_remove_from_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "duplicate_code_on_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "duplicate_code_attempt_prevented";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "no_space_for_access_code_on_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "igloohome_bridge_too_many_pending_jobs";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "igloohome_bridge_offline";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "igloohome_offline_access_code_no_variance_available";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "kwikset_unable_to_confirm_code";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "kwikset_unable_to_confirm_deletion";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "code_modified_external_to_seam";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_lock_invalid_code_length";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_device_programming_delay";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_device_slots_full";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_lock_missing_keypad";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_lock_temporarily_offline";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "salto_ks_user_not_subscribed";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "hubitat_device_programming_delay";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "hubitat_no_free_positions_available";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "wyze_duplicate_code_name";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "wyze_potential_duplicate_code";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "dormakaba_oracode_no_valid_user_level";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "account_disconnected";
                  is_connected_account_error: true;
                  is_device_error: false;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "salto_ks_subscription_limit_exceeded";
                  is_connected_account_error: true;
                  is_device_error: false;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "lockly_missing_wifi_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "invalid_credentials";
                  is_bridge_error?: boolean;
                  is_connected_account_error?: boolean;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "bridge_disconnected";
                  is_bridge_error?: boolean;
                  is_connected_account_error?: boolean;
                  message: string;
              })[];
          is_backup?: boolean;
          is_backup_access_code_available: boolean;
          is_external_modification_allowed: boolean;
          is_managed: true;
          is_offline_access_code: boolean;
          is_one_time_use: boolean;
          is_scheduled_on_device?: boolean;
          is_waiting_for_code_assignment?: boolean;
          name: null | string;
          pulled_backup_access_code_id?: null | string;
          starts_at?: null | string;
          status:
              | "set"
              | "setting"
              | "unset"
              | "removing"
              | "unknown";
          type: "time_bound" | "ongoing";
          warnings: (
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "smartthings_failed_to_set_access_code";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "schlage_detected_duplicate";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "schlage_creation_outage";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "code_modified_external_to_seam";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "delay_in_setting_on_device";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "delay_in_removing_from_device";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "third_party_integration_detected";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "august_device_programming_delay";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "august_lock_temporarily_offline";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "igloo_algopin_must_be_used_within_24_hours";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "management_transferred";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "kwikset_unable_to_confirm_code";
              })[];
      };
      action_attempt:
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: {
                  acs_credential_on_encoder: null | {
                      card_number: null | string;
                      created_at: null | string;
                      ends_at: null | string;
                      is_issued: null | boolean;
                      starts_at: null | string;
                      visionline_metadata?: {
                          cancelled: ...;
                          card_format: ...;
                          card_holder?: ...;
                          card_id: ...;
                          common_acs_entrance_ids?: ...;
                          discarded: ...;
                          expired: ...;
                          guest_acs_entrance_ids?: ...;
                          number_of_issued_cards: ...;
                          overridden?: ...;
                          overwritten: ...;
                          pending_auto_update: ...;
                      };
                  };
                  acs_credential_on_seam: null | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: true;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  } | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: false;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  };
                  warnings: {
                      warning_code: "acs_credential_on_encoder_out_of_sync" | "acs_credential_on_seam_not_found";
                      warning_message: string;
                  }[];
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: {
                  message: string;
                  type: "uncategorized_error";
              } | {
                  message: string;
                  type: "action_attempt_expired";
              } | {
                  message: string;
                  type: "no_credential_on_encoder";
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: {
                  access_method_id: string;
                  created_at: string;
                  display_name: string;
                  instant_key_url?: string;
                  is_card_encoding_required?: boolean;
                  issued_at?: string;
                  mode: "code" | "card" | "mobile_key";
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: true;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              } | {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: false;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          };
  }>, "action_attempt" | "access_code">, "access_code">

• Parameters

  • Optionalbody: {
        allow_external_modification?: boolean;
        attempt_for_offline_device?: boolean;
        code?: string;
        common_code_key?: string;
        device_id: string;
        ends_at?: string;
        is_external_modification_allowed?: boolean;
        is_offline_access_code?: boolean;
        is_one_time_use?: boolean;
        max_time_rounding?:
            | "1hour"
            | "1day"
            | "1h"
            | "1d";
        name?: string;
        prefer_native_scheduling?: boolean;
        preferred_code_length?: number;
        starts_at?: string;
        sync?: boolean;
        use_backup_access_code_pool?: boolean;
        use_offline_access_code?: boolean;
    }

    • Optionalallow_external_modification?: boolean

      Indicates whether external modification of the code is allowed. Default: false.

    • Optionalattempt_for_offline_device?: boolean

    • Optionalcode?: string

      Code to be used for access.

    • Optionalcommon_code_key?: string

      Key to identify access codes that should have the same code. Any two access codes with the same common_code_key are guaranteed to have the same code. See also Creating and Updating Multiple Linked Access Codes.

    • device_id: string

      ID of the device for which you want to create the new access code.

    • Optionalends_at?: string

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

    • Optionalis_external_modification_allowed?: boolean

      Indicates whether external modification of the code is allowed. Default: false.

    • Optionalis_offline_access_code?: boolean

      Indicates whether the access code is an offline access code.

    • Optionalis_one_time_use?: boolean

      Indicates whether the offline access code is a single-use access code.

    • Optionalmax_time_rounding?:
          | "1hour"
          | "1day"
          | "1h"
          | "1d"

      Maximum rounding adjustment. To create a daily-bound offline access code for devices that support this feature, set this parameter to 1d.

    • Optionalname?: string

      Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as first_name and last_name. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called appearance. This is an object with a name property and, optionally, first_name and last_name properties (for providers that break down a name into components).

    • Optionalprefer_native_scheduling?: boolean

      Indicates whether native scheduling should be used for time-bound codes when supported by the provider. Default: true.

    • Optionalpreferred_code_length?: number

      Preferred code length. Only applicable if you do not specify a code. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.

    • Optionalstarts_at?: string

      Date and time at which the validity of the new access code starts, in ISO 8601 format.

    • Optionalsync?: boolean

    • Optionaluse_backup_access_code_pool?: boolean

      Indicates whether to use a backup access code pool provided by Seam. If true, you can use /access_codes/pull_backup_access_code.

    • Optionaluse_offline_access_code?: boolean

  Returns SeamHttpRequest<SetNonNullable<Required<{
      access_code: {
          access_code_id: string;
          code: null | string;
          common_code_key: null | string;
          created_at: string;
          device_id: string;
          ends_at?: null | string;
          errors: (
              | {
                  created_at?: string;
                  error_code: "smartthings_failed_to_set_access_code";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "smartthings_failed_to_set_after_multiple_retries";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "smartthings_no_free_slots_available";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "failed_to_set_on_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "failed_to_remove_from_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "duplicate_code_on_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "duplicate_code_attempt_prevented";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "no_space_for_access_code_on_device";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "igloohome_bridge_too_many_pending_jobs";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "igloohome_bridge_offline";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "igloohome_offline_access_code_no_variance_available";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "kwikset_unable_to_confirm_code";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "kwikset_unable_to_confirm_deletion";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "code_modified_external_to_seam";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_lock_invalid_code_length";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_device_programming_delay";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_device_slots_full";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_lock_missing_keypad";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "august_lock_temporarily_offline";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "salto_ks_user_not_subscribed";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "hubitat_device_programming_delay";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "hubitat_no_free_positions_available";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "wyze_duplicate_code_name";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "wyze_potential_duplicate_code";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at?: string;
                  error_code: "dormakaba_oracode_no_valid_user_level";
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "account_disconnected";
                  is_connected_account_error: true;
                  is_device_error: false;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "salto_ks_subscription_limit_exceeded";
                  is_connected_account_error: true;
                  is_device_error: false;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "lockly_missing_wifi_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "invalid_credentials";
                  is_bridge_error?: boolean;
                  is_connected_account_error?: boolean;
                  message: string;
              }
              | {
                  created_at: string;
                  error_code: "bridge_disconnected";
                  is_bridge_error?: boolean;
                  is_connected_account_error?: boolean;
                  message: string;
              })[];
          is_backup?: boolean;
          is_backup_access_code_available: boolean;
          is_external_modification_allowed: boolean;
          is_managed: true;
          is_offline_access_code: boolean;
          is_one_time_use: boolean;
          is_scheduled_on_device?: boolean;
          is_waiting_for_code_assignment?: boolean;
          name: null | string;
          pulled_backup_access_code_id?: null | string;
          starts_at?: null | string;
          status:
              | "set"
              | "setting"
              | "unset"
              | "removing"
              | "unknown";
          type: "time_bound" | "ongoing";
          warnings: (
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "smartthings_failed_to_set_access_code";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "schlage_detected_duplicate";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "schlage_creation_outage";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "code_modified_external_to_seam";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "delay_in_setting_on_device";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "delay_in_removing_from_device";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "third_party_integration_detected";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "august_device_programming_delay";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "august_lock_temporarily_offline";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "igloo_algopin_must_be_used_within_24_hours";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "management_transferred";
              }
              | {
                  created_at?: string;
                  message: string;
                  warning_code: "kwikset_unable_to_confirm_code";
              })[];
      };
      action_attempt:
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "LOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UNLOCK_DOOR";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: null;
              result: {
                  acs_credential_on_encoder: null | {
                      card_number: null | string;
                      created_at: null | string;
                      ends_at: null | string;
                      is_issued: null | boolean;
                      starts_at: null | string;
                      visionline_metadata?: {
                          cancelled: ...;
                          card_format: ...;
                          card_holder?: ...;
                          card_id: ...;
                          common_acs_entrance_ids?: ...;
                          discarded: ...;
                          expired: ...;
                          guest_acs_entrance_ids?: ...;
                          number_of_issued_cards: ...;
                          overridden?: ...;
                          overwritten: ...;
                          pending_auto_update: ...;
                      };
                  };
                  acs_credential_on_seam: null | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: true;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  } | {
                      access_method: "code" | "card" | "mobile_key";
                      acs_credential_id: string;
                      acs_credential_pool_id?: string;
                      acs_system_id: string;
                      acs_user_id?: string;
                      assa_abloy_vostio_metadata?: {
                          auto_join?: ...;
                          door_names?: ...;
                          endpoint_id?: ...;
                          key_id?: ...;
                          key_issuing_request_id?: ...;
                          override_guest_acs_entrance_ids?: ...;
                      };
                      card_number?: null | string;
                      code?: null | string;
                      created_at: string;
                      display_name: string;
                      ends_at?: string;
                      errors: {
                          error_code: ...;
                          message: ...;
                      }[];
                      external_type?:
                          | "pti_card"
                          | "brivo_credential"
                          | "hid_credential"
                          | "visionline_card"
                          | "salto_ks_credential"
                          | "assa_abloy_vostio_key"
                          | "salto_space_key"
                          | "latch_access";
                      external_type_display_name?: string;
                      is_issued?: boolean;
                      is_latest_desired_state_synced_with_provider?: null | boolean;
                      is_managed: false;
                      is_multi_phone_sync_credential?: boolean;
                      is_one_time_use?: boolean;
                      issued_at?: null | string;
                      latest_desired_state_synced_with_provider_at?: null | string;
                      parent_acs_credential_id?: string;
                      starts_at?: string;
                      visionline_metadata?: {
                          auto_join?: ...;
                          card_function_type: ...;
                          card_id?: ...;
                          common_acs_entrance_ids?: ...;
                          credential_id?: ...;
                          guest_acs_entrance_ids?: ...;
                          is_valid?: ...;
                          joiner_acs_credential_ids?: ...;
                      };
                      warnings: (
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...))[];
                      workspace_id: string;
                  };
                  warnings: {
                      warning_code: "acs_credential_on_encoder_out_of_sync" | "acs_credential_on_seam_not_found";
                      warning_message: string;
                  }[];
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SCAN_CREDENTIAL";
              error: {
                  message: string;
                  type: "uncategorized_error";
              } | {
                  message: string;
                  type: "action_attempt_expired";
              } | {
                  message: string;
                  type: "no_credential_on_encoder";
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error: null;
              result: {
                  access_method_id: string;
                  created_at: string;
                  display_name: string;
                  instant_key_url?: string;
                  is_card_encoding_required?: boolean;
                  issued_at?: string;
                  mode: "code" | "card" | "mobile_key";
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_ACCESS_METHOD";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error: null;
              result: {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: true;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              } | {
                  access_method: "code" | "card" | "mobile_key";
                  acs_credential_id: string;
                  acs_credential_pool_id?: string;
                  acs_system_id: string;
                  acs_user_id?: string;
                  assa_abloy_vostio_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      door_names?: (...) | (...);
                      endpoint_id?: (...) | (...);
                      key_id?: (...) | (...);
                      key_issuing_request_id?: (...) | (...);
                      override_guest_acs_entrance_ids?: (...) | (...);
                  };
                  card_number?: null | string;
                  code?: null | string;
                  created_at: string;
                  display_name: string;
                  ends_at?: string;
                  errors: {
                      error_code: string;
                      message: string;
                  }[];
                  external_type?:
                      | "pti_card"
                      | "brivo_credential"
                      | "hid_credential"
                      | "visionline_card"
                      | "salto_ks_credential"
                      | "assa_abloy_vostio_key"
                      | "salto_space_key"
                      | "latch_access";
                  external_type_display_name?: string;
                  is_issued?: boolean;
                  is_latest_desired_state_synced_with_provider?: null | boolean;
                  is_managed: false;
                  is_multi_phone_sync_credential?: boolean;
                  is_one_time_use?: boolean;
                  issued_at?: null | string;
                  latest_desired_state_synced_with_provider_at?: null | string;
                  parent_acs_credential_id?: string;
                  starts_at?: string;
                  visionline_metadata?: {
                      auto_join?: (...) | (...) | (...);
                      card_function_type: (...) | (...);
                      card_id?: (...) | (...);
                      common_acs_entrance_ids?: (...) | (...);
                      credential_id?: (...) | (...);
                      guest_acs_entrance_ids?: (...) | (...);
                      is_valid?: (...) | (...) | (...);
                      joiner_acs_credential_ids?: (...) | (...);
                  };
                  warnings: (
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      }
                      | {
                          created_at: ...;
                          message: ...;
                          warning_code: ...;
                      })[];
                  workspace_id: string;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ENCODE_CREDENTIAL";
              error:
                  | {
                      message: string;
                      type: "uncategorized_error";
                  }
                  | {
                      message: string;
                      type: "action_attempt_expired";
                  }
                  | {
                      message: string;
                      type: "no_credential_on_encoder";
                  }
                  | {
                      message: string;
                      type: "incompatible_card_format";
                  }
                  | {
                      message: string;
                      type: "credential_cannot_be_reissued";
                  };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "RESET_SANDBOX_WORKSPACE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_FAN_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SET_HVAC_MODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "ACTIVATE_CLIMATE_PRESET";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "PUSH_THERMOSTAT_PROGRAMS";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "SYNC_ACCESS_CODES";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: null;
              result: {
                  access_code?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_ACCESS_CODE";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "CREATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: null;
              result: {};
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "DELETE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: null;
              status: "pending";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: null;
              result: {
                  noise_threshold?: any;
              };
              status: "success";
          }
          | {
              action_attempt_id: string;
              action_type: "UPDATE_NOISE_THRESHOLD";
              error: {
                  message: string;
                  type: string;
              };
              result: null;
              status: "error";
          };
  }>, "action_attempt" | "access_code">, "access_code">