/access_codes/create
"/access_codes/create": {
commonParams: {};
formData: {};
jsonBody: {
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;
};
jsonResponse: {
access_code: {
access_code_id: string;
code: string
| null;
common_code_key: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "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: string
| null;
pulled_backup_access_code_id?: string | null;
starts_at?: string | null;
status: "setting" | "set" | "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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
};
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/access_codes/create";
}
/access_codes/create_multiple
"/access_codes/create_multiple": {
commonParams: {};
formData: {};
jsonBody: {
allow_external_modification?: boolean;
attempt_for_offline_device?: boolean;
behavior_when_code_cannot_be_shared?: "throw" | "create_random_code";
code?: string;
device_ids: string[];
ends_at?: string;
is_external_modification_allowed?: boolean;
name?: string;
prefer_native_scheduling?: boolean;
preferred_code_length?: number;
starts_at?: string;
};
jsonResponse: {
access_codes: {
access_code_id: string;
code: string
| null;
common_code_key: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "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: string
| null;
pulled_backup_access_code_id?: string | null;
starts_at?: string | null;
status: "setting" | "set" | "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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "POST"
| "PUT";
queryParams: {};
route: "/access_codes/create_multiple";
}
/access_codes/delete
"/access_codes/delete": {
commonParams: {
access_code_id: string;
device_id?: string;
sync?: boolean;
};
formData: {};
jsonBody: {};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "DELETE"
| "POST";
queryParams: {};
route: "/access_codes/delete";
}
/access_codes/generate_code
"/access_codes/generate_code": {
commonParams: { device_id: string };
formData: {};
jsonBody: {};
jsonResponse: { generated_code: { code: string; device_id: string } };
maxDuration: undefined;
method: "GET" | "POST";
queryParams: {};
route: "/access_codes/generate_code";
}
/access_codes/get
"/access_codes/get": {
commonParams: {
access_code_id?: string;
code?: string;
device_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_code: {
access_code_id: string;
code: string
| null;
common_code_key: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "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: string
| null;
pulled_backup_access_code_id?: string | null;
starts_at?: string | null;
status: "setting" | "set" | "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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_codes/get";
}
/access_codes/list
"/access_codes/list": {
commonParams: {
access_code_ids?: string[];
customer_key?: string;
device_id?: string;
limit?: number;
page_cursor?: string | undefined | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_codes: {
access_code_id: string;
code: string
| null;
common_code_key: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "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: string
| null;
pulled_backup_access_code_id?: string | null;
starts_at?: string | null;
status: "setting" | "set" | "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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_codes/list";
}
/access_codes/pull_backup_access_code
"/access_codes/pull_backup_access_code": {
commonParams: {};
formData: {};
jsonBody: { access_code_id: string };
jsonResponse: {
access_code: {
access_code_id: string;
code: string | null;
common_code_key: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "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: string
| null;
pulled_backup_access_code_id?: string | null;
starts_at?: string | null;
status: "setting" | "set" | "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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
};
backup_access_code: {
access_code_id: string;
code: string
| null;
common_code_key: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "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: string
| null;
pulled_backup_access_code_id?: string | null;
starts_at?: string | null;
status: "setting" | "set" | "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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/access_codes/pull_backup_access_code";
}
/access_codes/report_device_constraints
"/access_codes/report_device_constraints": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
max_code_length?: number;
min_code_length?: number;
supported_code_lengths?: number[];
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/access_codes/report_device_constraints";
}
/access_codes/simulate/create_unmanaged_access_code
"/access_codes/simulate/create_unmanaged_access_code": {
commonParams: {};
formData: {};
jsonBody: { code: string; device_id: string; name: string };
jsonResponse: {
access_code: {
access_code_id: string;
code: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: false;
name: string
| null;
starts_at?: string | null;
status: "set";
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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/access_codes/simulate/create_unmanaged_access_code";
}
/access_codes/unmanaged/convert_to_managed
"/access_codes/unmanaged/convert_to_managed": {
commonParams: {
access_code_id: string;
allow_external_modification?: boolean;
force?: boolean;
is_external_modification_allowed?: boolean;
sync?: boolean;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/access_codes/unmanaged/convert_to_managed";
}
/access_codes/unmanaged/delete
"/access_codes/unmanaged/delete": {
commonParams: { access_code_id: string; sync?: boolean };
formData: {};
jsonBody: {};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "DELETE"
| "POST";
queryParams: {};
route: "/access_codes/unmanaged/delete";
}
/access_codes/unmanaged/get
"/access_codes/unmanaged/get": {
commonParams: {
access_code_id?: string;
code?: string;
device_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_code: {
access_code_id: string;
code: string
| null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: false;
name: string
| null;
starts_at?: string | null;
status: "set";
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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_codes/unmanaged/get";
}
/access_codes/unmanaged/list
"/access_codes/unmanaged/list": {
commonParams: {
device_id: string;
limit?: number;
page_cursor?: string | undefined | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_codes: {
access_code_id: string;
code: string
| null;
created_at: string;
device_id: string;
ends_at?: string | null;
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: "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_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_invalid_time_range";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "kwikset_insufficient_permissions";
is_access_code_error: true;
message: string;
}
| {
created_at?: string;
error_code: "keynest_unsupported_third_party_locker";
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: false;
name: string
| null;
starts_at?: string | null;
status: "set";
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";
}
| {
created_at?: string;
message: string;
warning_code: "ultraloq_access_code_disabled";
}
)[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_codes/unmanaged/list";
}
/access_codes/unmanaged/update
"/access_codes/unmanaged/update": {
commonParams: {
access_code_id: string;
allow_external_modification?: boolean;
force?: boolean;
is_external_modification_allowed?: boolean;
is_managed: boolean;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/access_codes/unmanaged/update";
}
/access_codes/update
"/access_codes/update": {
commonParams: {};
formData: {};
jsonBody: {
access_code_id: string;
allow_external_modification?: boolean;
attempt_for_offline_device?: boolean;
code?: string;
device_id?: string;
ends_at?: string;
is_external_modification_allowed?: boolean;
is_managed?: 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;
type?: "ongoing" | "time_bound";
use_backup_access_code_pool?: boolean;
use_offline_access_code?: boolean;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST"
| "PATCH"
| "PUT";
queryParams: {};
route: "/access_codes/update";
}
/access_codes/update_multiple
"/access_codes/update_multiple": {
commonParams: {};
formData: {};
jsonBody: {
common_code_key: string;
ends_at?: string;
name?: string;
starts_at?: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/access_codes/update_multiple";
}
/access_grants/create
"/access_grants/create": {
commonParams: (
| { user_identity_id: string }
| {
user_identity: {
email_address?: string | null;
full_name?: string | null;
phone_number?: string | null;
user_identity_key?: string | null;
};
}
) & {
access_grant_key?: string;
acs_entrance_ids?: string[];
customization_profile_id?: string;
device_ids?: string[];
ends_at?: string | undefined
| null;
location?: {
acs_entrance_ids?: string[];
device_ids?: string[];
name?: string;
};
location_ids?: string[];
name?: string | undefined
| null;
requested_access_methods: {
code?: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids?: string[];
space_keys?: string[];
starts_at?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_grant: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string
| null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/access_grants/create";
}
/access_grants/delete
"/access_grants/delete": {
commonParams: { access_grant_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/access_grants/delete";
}
/access_grants/get
"/access_grants/get": {
commonParams: { access_grant_id: string } | { access_grant_key: string };
formData: {};
jsonBody: {};
jsonResponse: {
access_grant: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string | null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_grants/get";
}
"/access_grants/get_related": {
commonParams: {
access_grant_ids: string[];
exclude?: (
| "spaces"
| "devices"
| "acs_entrances"
| "connected_accounts"
| "acs_systems"
| "user_identities"
| "acs_access_groups"
)[];
include?: (
| "spaces"
| "devices"
| "acs_entrances"
| "connected_accounts"
| "acs_systems"
| "user_identities"
| "acs_access_groups"
)[];
};
formData: {};
jsonBody: {};
jsonResponse: {
batch: {
acs_access_groups?: {
access_group_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
access_group_type_display_name: string;
acs_access_group_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
external_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
external_type_display_name: string;
is_managed: true;
name: string;
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
acs_entrances?: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor"
| "EntranceDoor"
| "GuestDoor"
| "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: (...)[];
};
}[];
acs_systems?: {
acs_access_group_count?: number;
acs_system_id: string;
acs_user_count?: number;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: string
| null;
errors: (
| { created_at: ...; error_code: ...; message: ... }
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
message: ...;
}
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
)[];
external_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: { time_zone: string
| null };
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| {
created_at: ...;
message: ...;
misconfigured_acs_entrance_ids?: ...;
warning_code: ...;
}
)[];
workspace_id: string;
}[];
connected_accounts?: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
account_type?: string;
account_type_display_name: string;
automatically_manage_new_devices: boolean;
connected_account_id: string;
created_at?: string;
custom_metadata: { [x: string]: string | boolean };
customer_key?: string;
display_name: string;
errors: (
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
salto_ks_metadata: ...;
}
)[];
image_url?: string;
user_identifier?: {
api_url?: string;
email?: string;
exclusive?: boolean;
phone?: string;
username?: string;
};
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
| {
created_at: ...;
message: ...;
salto_ks_metadata: ...;
warning_code: ...;
}
| { created_at: ...; message: ...; warning_code: ... }
)[];
}[];
devices?: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: (...) & {
akiles_metadata?: ...;
assa_abloy_vostio_metadata?: ...;
august_metadata?: ...;
avigilon_alta_metadata?: ...;
brivo_metadata?: ...;
controlbyweb_metadata?: ...;
dormakaba_oracode_metadata?: ...;
ecobee_metadata?: ...;
four_suites_metadata?: ...;
genie_metadata?: ...;
honeywell_resideo_metadata?: ...;
hubitat_metadata?: ...;
igloo_metadata?: ...;
igloohome_metadata?: ...;
keynest_metadata?: ...;
korelock_metadata?: ...;
kwikset_metadata?: ...;
lockly_metadata?: ...;
minut_metadata?: ...;
nest_metadata?: ...;
noiseaware_metadata?: ...;
nuki_metadata?: ...;
salto_ks_metadata?: ...;
salto_metadata?: ...;
schlage_metadata?: ...;
seam_bridge_metadata?: ...;
sensi_metadata?: ...;
smartthings_metadata?: ...;
tado_metadata?: ...;
tedee_metadata?: ...;
ttlock_metadata?: ...;
two_n_metadata?: ...;
ultraloq_metadata?: ...;
visionline_metadata?: ...;
wyze_metadata?: ...;
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: ...;
available_climate_presets?: ...;
available_fan_mode_settings?: ...;
available_hvac_mode_settings?: ...;
current_climate_setting?: ...;
default_climate_setting?: ...;
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: ...;
is_fan_running?: ...;
is_heating?: ...;
is_temporary_manual_override_active?: ...;
max_cooling_set_point_celsius?: ...;
max_cooling_set_point_fahrenheit?: ...;
max_heating_set_point_celsius?: ...;
max_heating_set_point_fahrenheit?: ...;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: ...;
min_cooling_set_point_fahrenheit?: ...;
min_heating_cooling_delta_celsius?: ...;
min_heating_cooling_delta_fahrenheit?: ...;
min_heating_set_point_celsius?: ...;
min_heating_set_point_fahrenheit?: ...;
relative_humidity?: ...;
temperature_celsius?: ...;
temperature_fahrenheit?: ...;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
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: ... }
| { 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: ... }
| { 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: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
spaces?: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
}[];
user_identities?: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string
| null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
user_identity_key: string | null;
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_grants/get_related";
}
/access_grants/list
"/access_grants/list": {
commonParams: {
access_grant_ids?: string[];
access_grant_key?: string;
acs_entrance_id?: string;
acs_system_id?: string;
customer_key?: string;
limit?: number;
location_id?: string;
page_cursor?: string | undefined | null;
reservation_key?: string;
space_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_grants: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string
| null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_grants/list";
}
/access_grants/request_access_methods
"/access_grants/request_access_methods": {
commonParams: {
access_grant_id: string;
requested_access_methods: {
code?: string;
mode: "code" | "card" | "mobile_key";
}[];
};
formData: {};
jsonBody: {};
jsonResponse: {
access_grant: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string
| null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/access_grants/request_access_methods";
}
/access_grants/unmanaged/get
"/access_grants/unmanaged/get": {
commonParams: { access_grant_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
access_grant: {
access_grant_id: string;
access_method_ids: string[];
created_at: string;
display_name: string;
ends_at: string | null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id?: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_grants/unmanaged/get";
}
/access_grants/unmanaged/list
"/access_grants/unmanaged/list": {
commonParams: {
acs_entrance_id?: string;
acs_system_id?: string;
reservation_key?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_grants: {
access_grant_id: string;
access_method_ids: string[];
created_at: string;
display_name: string;
ends_at: string
| null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id?: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_grants/unmanaged/list";
}
/access_grants/unmanaged/update
"/access_grants/unmanaged/update": {
commonParams: {};
formData: {};
jsonBody: {
access_grant_id: string;
access_grant_key?: string;
is_managed: true;
};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/access_grants/unmanaged/update";
}
/access_grants/update
"/access_grants/update": {
commonParams: {
access_grant_id: string;
ends_at?: string | null;
name?: string | null;
starts_at?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/access_grants/update";
}
/access_methods/delete
"/access_methods/delete": {
commonParams: { access_method_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/access_methods/delete";
}
/access_methods/encode
"/access_methods/encode": {
commonParams: { access_method_id: string; acs_encoder_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/access_methods/encode";
}
/access_methods/get
"/access_methods/get": {
commonParams: { access_method_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
access_method: {
access_method_id: string;
client_session_token?: string;
code?: string | null;
created_at: string;
customization_profile_id?: string;
display_name: string;
instant_key_url?: string;
is_encoding_required?: boolean;
is_issued: boolean;
issued_at: string | null;
mode: "code" | "card" | "mobile_key";
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_methods/get";
}
"/access_methods/get_related": {
commonParams: {
access_method_ids: string[];
exclude?: (
| "spaces"
| "devices"
| "acs_entrances"
| "access_grants"
| "access_methods"
| "instant_keys"
| "client_sessions"
| "acs_credentials"
)[];
include?: (
| "spaces"
| "devices"
| "acs_entrances"
| "access_grants"
| "access_methods"
| "instant_keys"
| "client_sessions"
| "acs_credentials"
)[];
};
formData: {};
jsonBody: {};
jsonResponse: {
batch: {
access_grants?: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string
| null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
access_methods?: {
access_method_id: string;
client_session_token?: string;
code?: string
| null;
created_at: string;
customization_profile_id?: string;
display_name: string;
instant_key_url?: string;
is_encoding_required?: boolean;
is_issued: boolean;
issued_at: string | null;
mode: "code" | "card" | "mobile_key";
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
acs_credentials?: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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;
}[];
acs_entrances?: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor"
| "EntranceDoor"
| "GuestDoor"
| "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: (...)[];
};
}[];
client_sessions?: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string
| null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
}[];
devices?: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: (...) & {
akiles_metadata?: ...;
assa_abloy_vostio_metadata?: ...;
august_metadata?: ...;
avigilon_alta_metadata?: ...;
brivo_metadata?: ...;
controlbyweb_metadata?: ...;
dormakaba_oracode_metadata?: ...;
ecobee_metadata?: ...;
four_suites_metadata?: ...;
genie_metadata?: ...;
honeywell_resideo_metadata?: ...;
hubitat_metadata?: ...;
igloo_metadata?: ...;
igloohome_metadata?: ...;
keynest_metadata?: ...;
korelock_metadata?: ...;
kwikset_metadata?: ...;
lockly_metadata?: ...;
minut_metadata?: ...;
nest_metadata?: ...;
noiseaware_metadata?: ...;
nuki_metadata?: ...;
salto_ks_metadata?: ...;
salto_metadata?: ...;
schlage_metadata?: ...;
seam_bridge_metadata?: ...;
sensi_metadata?: ...;
smartthings_metadata?: ...;
tado_metadata?: ...;
tedee_metadata?: ...;
ttlock_metadata?: ...;
two_n_metadata?: ...;
ultraloq_metadata?: ...;
visionline_metadata?: ...;
wyze_metadata?: ...;
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: ...;
available_climate_presets?: ...;
available_fan_mode_settings?: ...;
available_hvac_mode_settings?: ...;
current_climate_setting?: ...;
default_climate_setting?: ...;
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: ...;
is_fan_running?: ...;
is_heating?: ...;
is_temporary_manual_override_active?: ...;
max_cooling_set_point_celsius?: ...;
max_cooling_set_point_fahrenheit?: ...;
max_heating_set_point_celsius?: ...;
max_heating_set_point_fahrenheit?: ...;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: ...;
min_cooling_set_point_fahrenheit?: ...;
min_heating_cooling_delta_celsius?: ...;
min_heating_cooling_delta_fahrenheit?: ...;
min_heating_set_point_celsius?: ...;
min_heating_set_point_fahrenheit?: ...;
relative_humidity?: ...;
temperature_celsius?: ...;
temperature_fahrenheit?: ...;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
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: ... }
| { 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: ... }
| { 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: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
instant_keys?: {
client_session_id: string;
created_at: string;
customization?: {
logo_url?: string;
primary_color?: string;
secondary_color?: string;
};
customization_profile_id?: string;
expires_at: string;
instant_key_id: string;
instant_key_url: string;
user_identity_id: string;
workspace_id: string;
}[];
spaces?: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
}[];
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_methods/get_related";
}
/access_methods/list
"/access_methods/list": {
commonParams: {
access_grant_id: string;
acs_entrance_id?: string;
device_id?: string;
space_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_methods: {
access_method_id: string;
client_session_token?: string;
code?: string
| null;
created_at: string;
customization_profile_id?: string;
display_name: string;
instant_key_url?: string;
is_encoding_required?: boolean;
is_issued: boolean;
issued_at: string | null;
mode: "code" | "card" | "mobile_key";
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_methods/list";
}
/access_methods/unmanaged/get
"/access_methods/unmanaged/get": {
commonParams: { access_method_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
access_method: {
access_method_id: string;
code?: string | null;
created_at: string;
display_name: string;
is_encoding_required?: boolean;
is_issued: boolean;
issued_at: string | null;
mode: "code" | "card" | "mobile_key";
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_methods/unmanaged/get";
}
/access_methods/unmanaged/list
"/access_methods/unmanaged/list": {
commonParams: {
access_grant_id: string;
acs_entrance_id?: string;
device_id?: string;
space_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
access_methods: {
access_method_id: string;
code?: string
| null;
created_at: string;
display_name: string;
is_encoding_required?: boolean;
is_issued: boolean;
issued_at: string | null;
mode: "code" | "card" | "mobile_key";
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/access_methods/unmanaged/list";
}
/acs/access_groups/add_user
"/acs/access_groups/add_user": {
commonParams: {
acs_access_group_id: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "PUT"
| "POST";
queryParams: {};
route: "/acs/access_groups/add_user";
}
/acs/access_groups/delete
"/acs/access_groups/delete": {
commonParams: { acs_access_group_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/acs/access_groups/delete";
}
/acs/access_groups/get
"/acs/access_groups/get": {
commonParams: { acs_access_group_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_access_group: {
access_group_type:
| "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
access_group_type_display_name: string;
acs_access_group_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
external_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
external_type_display_name: string;
is_managed: true;
name: string;
warnings: (
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_access_group";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/access_groups/get";
}
/acs/access_groups/list
"/acs/access_groups/list": {
commonParams: {
acs_system_id?: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_access_groups: {
access_group_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
access_group_type_display_name: string;
acs_access_group_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
external_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
external_type_display_name: string;
is_managed: true;
name: string;
warnings: (
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_access_group";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/access_groups/list";
}
/acs/access_groups/list_accessible_entrances
"/acs/access_groups/list_accessible_entrances": {
commonParams: { acs_access_group_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_entrances: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: {
visionline_door_profile_id: string;
visionline_door_profile_type: (...)
| (...)
| (...);
}[];
};
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/access_groups/list_accessible_entrances";
}
/acs/access_groups/list_users
"/acs/access_groups/list_users": {
commonParams: { acs_access_group_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_users: {
access_schedule?: { ends_at: string | null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "latch_conflict_with_resident_user";
message: string;
}
)[];
external_type?: | "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: true;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
| { created_at: string; message: string; mutation_code: "creating" }
| { created_at: string; message: string; mutation_code: "deleting" }
| {
created_at: string;
message: string;
mutation_code: "deferring_creation";
scheduled_at?: (...) | (...);
}
| {
created_at: string;
from: { email_address?: ...; full_name?: ...; phone_number?: ... };
message: string;
mutation_code: "updating_user_information";
to: { email_address?: ...; full_name?: ...; phone_number?: ... };
}
| {
created_at: string;
from: { ends_at: ...; starts_at: ... };
message: string;
mutation_code: "updating_access_schedule";
to: { ends_at: ...; starts_at: ... };
}
| {
created_at: string;
from: { is_suspended: ... };
message: string;
mutation_code: "updating_suspension_state";
to: { is_suspended: ... };
}
| {
created_at: string;
from: { acs_access_group_id: ... };
message: string;
mutation_code: "updating_group_membership";
to: { acs_access_group_id: ... };
}
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_user";
}
| {
created_at: string;
message: string;
warning_code: "latch_resident_user";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/access_groups/list_users";
}
/acs/access_groups/remove_user
"/acs/access_groups/remove_user": {
commonParams: {
acs_access_group_id: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE"
| "POST";
queryParams: {};
route: "/acs/access_groups/remove_user";
}
/acs/access_groups/unmanaged/get
"/acs/access_groups/unmanaged/get": {
commonParams: { acs_access_group_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_access_group: {
access_group_type:
| "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
access_group_type_display_name: string;
acs_access_group_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
external_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
external_type_display_name: string;
is_managed: false;
name: string;
warnings: (
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_access_group";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/access_groups/unmanaged/get";
}
/acs/access_groups/unmanaged/list
"/acs/access_groups/unmanaged/list": {
commonParams: { acs_system_id?: string; acs_user_id?: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_access_groups: {
access_group_type:
| "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
access_group_type_display_name: string;
acs_access_group_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
external_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
external_type_display_name: string;
is_managed: false;
name: string;
warnings: (
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_access_group";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/access_groups/unmanaged/list";
}
/acs/credential_pools/list
"/acs/credential_pools/list": {
commonParams: { acs_system_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_credential_pools: {
acs_credential_pool_id: string;
acs_system_id: string;
created_at: string;
display_name: string;
external_type: "hid_part_number";
external_type_display_name: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/credential_pools/list";
}
/acs/credential_provisioning_automations/launch
"/acs/credential_provisioning_automations/launch": {
commonParams: {
acs_credential_pool_id?: string;
create_credential_manager_user?: boolean;
credential_manager_acs_system_id: string;
credential_manager_acs_user_id?: string;
user_identity_id: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_credential_provisioning_automation: {
acs_credential_provisioning_automation_id: string;
created_at: string;
credential_manager_acs_system_id: string;
user_identity_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/credential_provisioning_automations/launch";
}
/acs/credentials/assign
"/acs/credentials/assign": {
commonParams: {};
formData: {};
jsonBody: {
acs_credential_id: string;
acs_user_id?: string;
user_identity_id?: string;
};
jsonResponse: {
acs_credential: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/acs/credentials/assign";
}
/acs/credentials/create
"/acs/credentials/create": {
commonParams: {
access_method: "code" | "card" | "mobile_key";
acs_system_id?: string;
acs_user_id?: string;
allowed_acs_entrance_ids?: string[];
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
join_all_guest_acs_entrances?: boolean;
override_all_guest_acs_entrances?: boolean;
override_guest_acs_entrance_ids?: string[];
};
code?: string;
credential_manager_acs_system_id?: string;
ends_at?: string;
hotek_metadata?: { auto_join?: boolean; override?: boolean };
is_multi_phone_sync_credential?: boolean;
salto_space_metadata?: {
assign_new_key?: boolean;
update_current_key?: boolean;
};
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
assa_abloy_credential_service_mobile_endpoint_id?: string;
auto_join?: boolean;
card_format?: "TLCode"
| "rfid48";
card_function_type?: "guest" | "staff";
is_override_key?: boolean;
joiner_acs_credential_ids?: string[];
override?: boolean;
};
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_credential: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/credentials/create";
}
/acs/credentials/create_offline_code
"/acs/credentials/create_offline_code": {
commonParams: {
acs_user_id: string;
allowed_acs_entrance_id: string;
ends_at?: string;
is_one_time_use?: boolean;
starts_at?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_credential: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/credentials/create_offline_code";
}
/acs/credentials/delete
"/acs/credentials/delete": {
commonParams: { acs_credential_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/acs/credentials/delete";
}
/acs/credentials/get
"/acs/credentials/get": {
commonParams: { acs_credential_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_credential: {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/credentials/get";
}
/acs/credentials/list
"/acs/credentials/list": {
commonParams: (
| { acs_user_id: string }
| { acs_system_id: string }
| { acs_system_id: string; acs_user_id: string }
| { user_identity_id: string }
| {}
) & {
created_before?: Date;
is_multi_phone_sync_credential?: boolean;
limit?: number;
page_cursor?: string | undefined | null;
search?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_credentials: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/credentials/list";
}
/acs/credentials/list_accessible_entrances
"/acs/credentials/list_accessible_entrances": {
commonParams: { acs_credential_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_entrances: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: {
visionline_door_profile_id: string;
visionline_door_profile_type: (...)
| (...)
| (...);
}[];
};
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/credentials/list_accessible_entrances";
}
/acs/credentials/unassign
"/acs/credentials/unassign": {
commonParams: {};
formData: {};
jsonBody: {
acs_credential_id: string;
acs_user_id?: string;
user_identity_id?: string;
};
jsonResponse: {
acs_credential: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/acs/credentials/unassign";
}
/acs/credentials/unmanaged/get
"/acs/credentials/unmanaged/get": {
commonParams: { acs_credential_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_credential: {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/credentials/unmanaged/get";
}
/acs/credentials/unmanaged/list
"/acs/credentials/unmanaged/list": {
commonParams:
| { acs_user_id: string }
| { acs_system_id: string }
| { acs_system_id: string; acs_user_id: string }
| { user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_credentials: {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/credentials/unmanaged/list";
}
/acs/credentials/update
"/acs/credentials/update": {
commonParams: {};
formData: {};
jsonBody: { acs_credential_id: string; code?: string; ends_at?: string };
jsonResponse: {
acs_credential: {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/acs/credentials/update";
}
/acs/encoders/encode_credential
"/acs/encoders/encode_credential": {
commonParams: {
access_method_id?: string;
acs_credential_id?: string;
acs_encoder_id: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/encoders/encode_credential";
}
/acs/encoders/get
"/acs/encoders/get": {
commonParams: { acs_encoder_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_encoder: {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
errors: {
created_at: string;
error_code: "acs_encoder_removed";
message: string;
}[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/encoders/get";
}
/acs/encoders/list
"/acs/encoders/list": {
commonParams: (
| { acs_system_id: string }
| { acs_system_ids: string[] }
| { acs_encoder_ids: string[] }
) & { limit?: number; page_cursor?: string | undefined | null };
formData: {};
jsonBody: {};
jsonResponse: {
acs_encoders: {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
errors: {
created_at: string;
error_code: "acs_encoder_removed";
message: string;
}[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/encoders/list";
}
"/acs/encoders/scan_credential": {
commonParams: { acs_encoder_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/encoders/scan_credential";
}
"/acs/encoders/simulate/next_credential_encode_will_fail": {
commonParams: {};
formData: {};
jsonBody:
| { acs_encoder_id: string; error_code?: "no_credential_on_encoder" }
| {
acs_credential_id?: string;
acs_encoder_id: string;
error_code: "uncategorized_error" | "action_attempt_expired";
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/encoders/simulate/next_credential_encode_will_fail";
}
"/acs/encoders/simulate/next_credential_encode_will_succeed": {
commonParams: {};
formData: {};
jsonBody: { acs_encoder_id: string; scenario?: "credential_is_issued" };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/encoders/simulate/next_credential_encode_will_succeed";
}
"/acs/encoders/simulate/next_credential_scan_will_fail": {
commonParams: {};
formData: {};
jsonBody:
| { acs_encoder_id: string; error_code?: "no_credential_on_encoder" }
| {
acs_credential_id_on_seam?: string;
acs_encoder_id: string;
error_code: "uncategorized_error" | "action_attempt_expired";
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/encoders/simulate/next_credential_scan_will_fail";
}
"/acs/encoders/simulate/next_credential_scan_will_succeed": {
commonParams: {};
formData: {};
jsonBody:
| {
acs_credential_id_on_seam?: string;
acs_encoder_id: string;
scenario?: | "credential_exists_on_seam"
| "credential_on_encoder_needs_update";
}
| {
acs_encoder_id: string;
scenario: "credential_does_not_exist_on_seam";
}
| { acs_encoder_id: string; scenario: "credential_on_encoder_is_empty" };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/encoders/simulate/next_credential_scan_will_succeed";
}
/acs/entrances/get
"/acs/entrances/get": {
commonParams: { acs_entrance_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_entrance: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: {
visionline_door_profile_id: string;
visionline_door_profile_type: "BLE"
| "commonDoor"
| "touch";
}[];
};
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/entrances/get";
}
/acs/entrances/grant_access
"/acs/entrances/grant_access": {
commonParams: {};
formData: {};
jsonBody: {
acs_entrance_id: string;
acs_user_id?: string;
user_identity_id?: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/entrances/grant_access";
}
/acs/entrances/list
"/acs/entrances/list": {
commonParams: {
acs_credential_id?: string;
acs_entrance_ids?: string[];
acs_system_id?: string;
connected_account_id?: string;
customer_key?: string;
limit?: number;
location_id?: string | null;
page_cursor?: string | undefined | null;
search?: string;
space_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_entrances: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor"
| "EntranceDoor"
| "GuestDoor"
| "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: {
visionline_door_profile_id: string;
visionline_door_profile_type: (...)
| (...)
| (...);
}[];
};
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/entrances/list";
}
/acs/entrances/list_credentials_with_access
"/acs/entrances/list_credentials_with_access": {
commonParams: {
acs_entrance_id: string;
include_if?: "visionline_metadata.is_valid"[];
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_credentials: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/entrances/list_credentials_with_access";
}
/acs/systems/get
"/acs/systems/get": {
commonParams: { acs_system_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_system: {
acs_access_group_count?: number;
acs_system_id: string;
acs_user_count?: number;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: string | null;
errors: (
| {
created_at: string;
error_code: "seam_bridge_disconnected";
message: string;
}
| {
created_at: string;
error_code: "bridge_disconnected";
is_bridge_error?: boolean;
message: string;
}
| {
created_at: string;
error_code: "visionline_instance_unreachable";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "acs_system_disconnected";
message: string;
}
| {
created_at: string;
error_code: "account_disconnected";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_certification_expired";
message: string;
}
)[];
external_type?: | "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: { time_zone: string
| null };
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
misconfigured_acs_entrance_ids?: string[];
warning_code: "time_zone_does_not_match_location";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/systems/get";
}
/acs/systems/list
"/acs/systems/list": {
commonParams: { connected_account_id?: string; customer_key?: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_systems: {
acs_access_group_count?: number;
acs_system_id: string;
acs_user_count?: number;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: string | null;
errors: (
| {
created_at: string;
error_code: "seam_bridge_disconnected";
message: string;
}
| {
created_at: string;
error_code: "bridge_disconnected";
is_bridge_error?: boolean;
message: string;
}
| {
created_at: string;
error_code: "visionline_instance_unreachable";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "acs_system_disconnected";
message: string;
}
| {
created_at: string;
error_code: "account_disconnected";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_certification_expired";
message: string;
}
)[];
external_type?: | "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: { time_zone: string
| null };
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
misconfigured_acs_entrance_ids?: (...)[];
warning_code: "time_zone_does_not_match_location";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/systems/list";
}
/acs/systems/list_compatible_credential_manager_acs_systems
"/acs/systems/list_compatible_credential_manager_acs_systems": {
commonParams: { acs_system_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_systems: {
acs_access_group_count?: number;
acs_system_id: string;
acs_user_count?: number;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: string | null;
errors: (
| {
created_at: string;
error_code: "seam_bridge_disconnected";
message: string;
}
| {
created_at: string;
error_code: "bridge_disconnected";
is_bridge_error?: boolean;
message: string;
}
| {
created_at: string;
error_code: "visionline_instance_unreachable";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "acs_system_disconnected";
message: string;
}
| {
created_at: string;
error_code: "account_disconnected";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_certification_expired";
message: string;
}
)[];
external_type?: | "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: { time_zone: string
| null };
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
misconfigured_acs_entrance_ids?: (...)[];
warning_code: "time_zone_does_not_match_location";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/systems/list_compatible_credential_manager_acs_systems";
}
/acs/systems/report_devices
"/acs/systems/report_devices": {
commonParams: {
acs_encoders?: {
hotek_metadata: { encoder_number: string };
is_removed?: boolean;
}[];
acs_entrances?: {
hotek_metadata: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
is_removed?: boolean;
}[];
acs_system_id: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/systems/report_devices";
}
/acs/users/add_to_access_group
"/acs/users/add_to_access_group": {
commonParams: { acs_access_group_id: string; acs_user_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "PUT" | "POST";
queryParams: {};
route: "/acs/users/add_to_access_group";
}
/acs/users/create
"/acs/users/create": {
commonParams: {};
formData: {};
jsonBody: {
access_schedule?: {
ends_at?: string | undefined | null;
starts_at?: string;
};
acs_access_group_ids?: string[];
acs_system_id: string;
email?: string;
email_address?: string;
full_name: string;
phone_number?: string;
user_identity_id?: string;
};
jsonResponse: {
acs_user: {
access_schedule?: { ends_at: string
| null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "latch_conflict_with_resident_user";
message: string;
}
)[];
external_type?: | "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: true;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
| { created_at: string; message: string; mutation_code: "creating" }
| { created_at: string; message: string; mutation_code: "deleting" }
| {
created_at: string;
message: string;
mutation_code: "deferring_creation";
scheduled_at?: (...) | null;
}
| {
created_at: string;
from: {
email_address?: (...)
| (...);
full_name?: (...) | (...);
phone_number?: (...) | (...);
};
message: string;
mutation_code: "updating_user_information";
to: {
email_address?: (...)
| (...);
full_name?: (...) | (...);
phone_number?: (...) | (...);
};
}
| {
created_at: string;
from: { ends_at: (...)
| (...); starts_at: (...) | (...) };
message: string;
mutation_code: "updating_access_schedule";
to: { ends_at: (...) | (...); starts_at: (...) | (...) };
}
| {
created_at: string;
from: { is_suspended: boolean };
message: string;
mutation_code: "updating_suspension_state";
to: { is_suspended: boolean };
}
| {
created_at: string;
from: { acs_access_group_id: (...)
| (...) };
message: string;
mutation_code: "updating_group_membership";
to: { acs_access_group_id: (...) | (...) };
}
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_user";
}
| {
created_at: string;
message: string;
warning_code: "latch_resident_user";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/users/create";
}
/acs/users/delete
"/acs/users/delete": {
commonParams: {
acs_system_id?: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE"
| "POST";
queryParams: {};
route: "/acs/users/delete";
}
/acs/users/get
"/acs/users/get": {
commonParams: {
acs_system_id?: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_user: {
access_schedule?: { ends_at: string
| null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "latch_conflict_with_resident_user";
message: string;
}
)[];
external_type?: | "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: true;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
| { created_at: string; message: string; mutation_code: "creating" }
| { created_at: string; message: string; mutation_code: "deleting" }
| {
created_at: string;
message: string;
mutation_code: "deferring_creation";
scheduled_at?: (...) | null;
}
| {
created_at: string;
from: {
email_address?: (...)
| (...);
full_name?: (...) | (...);
phone_number?: (...) | (...);
};
message: string;
mutation_code: "updating_user_information";
to: {
email_address?: (...)
| (...);
full_name?: (...) | (...);
phone_number?: (...) | (...);
};
}
| {
created_at: string;
from: { ends_at: (...)
| (...); starts_at: (...) | (...) };
message: string;
mutation_code: "updating_access_schedule";
to: { ends_at: (...) | (...); starts_at: (...) | (...) };
}
| {
created_at: string;
from: { is_suspended: boolean };
message: string;
mutation_code: "updating_suspension_state";
to: { is_suspended: boolean };
}
| {
created_at: string;
from: { acs_access_group_id: (...)
| (...) };
message: string;
mutation_code: "updating_group_membership";
to: { acs_access_group_id: (...) | (...) };
}
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_user";
}
| {
created_at: string;
message: string;
warning_code: "latch_resident_user";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/users/get";
}
/acs/users/list
"/acs/users/list": {
commonParams: {
acs_system_id?: string;
created_before?: Date;
limit?: number;
page_cursor?: string | undefined | null;
search?: string;
user_identity_email_address?: string;
user_identity_id?: string;
user_identity_phone_number?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_users: {
access_schedule?: { ends_at: string
| null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "latch_conflict_with_resident_user";
message: string;
}
)[];
external_type?: | "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: true;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
| { created_at: string; message: string; mutation_code: "creating" }
| { created_at: string; message: string; mutation_code: "deleting" }
| {
created_at: string;
message: string;
mutation_code: "deferring_creation";
scheduled_at?: (...) | (...);
}
| {
created_at: string;
from: { email_address?: ...; full_name?: ...; phone_number?: ... };
message: string;
mutation_code: "updating_user_information";
to: { email_address?: ...; full_name?: ...; phone_number?: ... };
}
| {
created_at: string;
from: { ends_at: ...; starts_at: ... };
message: string;
mutation_code: "updating_access_schedule";
to: { ends_at: ...; starts_at: ... };
}
| {
created_at: string;
from: { is_suspended: ... };
message: string;
mutation_code: "updating_suspension_state";
to: { is_suspended: ... };
}
| {
created_at: string;
from: { acs_access_group_id: ... };
message: string;
mutation_code: "updating_group_membership";
to: { acs_access_group_id: ... };
}
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_user";
}
| {
created_at: string;
message: string;
warning_code: "latch_resident_user";
}
)[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/users/list";
}
/acs/users/list_accessible_entrances
"/acs/users/list_accessible_entrances": {
commonParams: {
acs_system_id?: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_entrances: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor"
| "EntranceDoor"
| "GuestDoor"
| "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: {
visionline_door_profile_id: string;
visionline_door_profile_type: (...)
| (...)
| (...);
}[];
};
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/users/list_accessible_entrances";
}
/acs/users/remove_from_access_group
"/acs/users/remove_from_access_group": {
commonParams: {
acs_access_group_id: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE"
| "POST";
queryParams: {};
route: "/acs/users/remove_from_access_group";
}
/acs/users/revoke_access_to_all_entrances
"/acs/users/revoke_access_to_all_entrances": {
commonParams: {};
formData: {};
jsonBody: {
acs_system_id?: string;
acs_user_id?: string;
user_identity_id?: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/users/revoke_access_to_all_entrances";
}
"/acs/users/suspend": {
commonParams: {
acs_system_id?: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/users/suspend";
}
/acs/users/unmanaged/get
"/acs/users/unmanaged/get": {
commonParams: { acs_user_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_user: {
access_schedule?: { ends_at: string | null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "latch_conflict_with_resident_user";
message: string;
}
)[];
external_type?: | "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: false;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
| { created_at: string; message: string; mutation_code: "creating" }
| { created_at: string; message: string; mutation_code: "deleting" }
| {
created_at: string;
message: string;
mutation_code: "deferring_creation";
scheduled_at?: (...) | null;
}
| {
created_at: string;
from: {
email_address?: (...)
| (...);
full_name?: (...) | (...);
phone_number?: (...) | (...);
};
message: string;
mutation_code: "updating_user_information";
to: {
email_address?: (...)
| (...);
full_name?: (...) | (...);
phone_number?: (...) | (...);
};
}
| {
created_at: string;
from: { ends_at: (...)
| (...); starts_at: (...) | (...) };
message: string;
mutation_code: "updating_access_schedule";
to: { ends_at: (...) | (...); starts_at: (...) | (...) };
}
| {
created_at: string;
from: { is_suspended: boolean };
message: string;
mutation_code: "updating_suspension_state";
to: { is_suspended: boolean };
}
| {
created_at: string;
from: { acs_access_group_id: (...)
| (...) };
message: string;
mutation_code: "updating_group_membership";
to: { acs_access_group_id: (...) | (...) };
}
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_user";
}
| {
created_at: string;
message: string;
warning_code: "latch_resident_user";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/users/unmanaged/get";
}
/acs/users/unmanaged/list
"/acs/users/unmanaged/list": {
commonParams: {
acs_system_id?: string;
limit?: number;
user_identity_email_address?: string;
user_identity_id?: string;
user_identity_phone_number?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
acs_users: {
access_schedule?: { ends_at: string
| null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "latch_conflict_with_resident_user";
message: string;
}
)[];
external_type?: | "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: false;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
| { created_at: string; message: string; mutation_code: "creating" }
| { created_at: string; message: string; mutation_code: "deleting" }
| {
created_at: string;
message: string;
mutation_code: "deferring_creation";
scheduled_at?: (...) | (...);
}
| {
created_at: string;
from: { email_address?: ...; full_name?: ...; phone_number?: ... };
message: string;
mutation_code: "updating_user_information";
to: { email_address?: ...; full_name?: ...; phone_number?: ... };
}
| {
created_at: string;
from: { ends_at: ...; starts_at: ... };
message: string;
mutation_code: "updating_access_schedule";
to: { ends_at: ...; starts_at: ... };
}
| {
created_at: string;
from: { is_suspended: ... };
message: string;
mutation_code: "updating_suspension_state";
to: { is_suspended: ... };
}
| {
created_at: string;
from: { acs_access_group_id: ... };
message: string;
mutation_code: "updating_group_membership";
to: { acs_access_group_id: ... };
}
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_user";
}
| {
created_at: string;
message: string;
warning_code: "latch_resident_user";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/acs/users/unmanaged/list";
}
/acs/users/unsuspend
"/acs/users/unsuspend": {
commonParams: {
acs_system_id?: string;
acs_user_id?: string;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/acs/users/unsuspend";
}
/acs/users/update
"/acs/users/update": {
commonParams: {};
formData: {};
jsonBody: {
access_schedule?: { ends_at: string; starts_at: string } | null;
acs_system_id?: string;
acs_user_id?: string;
email?: string;
email_address?: string;
full_name?: string;
hid_acs_system_id?: string;
phone_number?: string;
user_identity_id?: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/acs/users/update";
}
/action_attempts/get
"/action_attempts/get": {
commonParams: { action_attempt_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/action_attempts/get";
}
/action_attempts/list
"/action_attempts/list": {
commonParams: {
action_attempt_ids?: string[];
device_id?: string;
limit?: number;
page_cursor?: string | undefined | null;
};
formData: {};
jsonBody: {};
jsonResponse: {
action_attempts: (
| {
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: | {
card_number: (...)
| (...);
created_at: (...) | (...);
ends_at: (...) | (...);
is_issued: (...) | (...);
starts_at: (...) | (...);
visionline_metadata?: (...) | (...);
}
| null;
acs_credential_on_seam: (...) | (...)
| null;
warnings: { warning_code: (...) | (...); 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" }
| { message: string; type: "no_card_on_encoder" };
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;
code?: (...) | null;
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: string;
errors: { error_code: ...; message: ... }[];
external_type?: ...;
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: ...;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: (...) | null;
latest_desired_state_synced_with_provider_at?: ...;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: 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;
code?: (...) | null;
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: string;
errors: { error_code: ...; message: ... }[];
external_type?: ...;
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: ...;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: (...) | null;
latest_desired_state_synced_with_provider_at?: ...;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: 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;
};
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" }
| { message: string; type: "no_card_on_encoder" };
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";
}
)[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/action_attempts/list";
}
/bridges/get
"/bridges/get": {
commonParams: { bridge_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
bridge: { bridge_id: string; created_at: string; workspace_id: string };
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/bridges/get";
}
/bridges/list
"/bridges/list": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
bridges: {
bridge_id: string;
created_at: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/bridges/list";
}
/client_sessions/create
"/client_sessions/create": {
commonParams: {};
formData: {};
jsonBody: {
connect_webview_ids?: string[];
connected_account_ids?: string[];
customer_id?: string;
customer_key?: string;
expires_at?: Date;
user_identifier_key?: string;
user_identity_id?: string;
user_identity_ids?: string[];
};
jsonResponse: {
client_session: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string
| null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST"
| "PUT";
queryParams: {};
route: "/client_sessions/create";
}
/client_sessions/delete
"/client_sessions/delete": {
commonParams: { client_session_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/client_sessions/delete";
}
/client_sessions/get
"/client_sessions/get": {
commonParams: {
client_session_id?: string;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
client_session: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string
| null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/client_sessions/get";
}
/client_sessions/get_or_create
"/client_sessions/get_or_create": {
commonParams: {};
formData: {};
jsonBody: {
connect_webview_ids?: string[];
connected_account_ids?: string[];
expires_at?: Date;
user_identifier_key?: string;
user_identity_id?: string;
user_identity_ids?: string[];
};
jsonResponse: {
client_session: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string
| null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/client_sessions/get_or_create";
}
/client_sessions/grant_access
"/client_sessions/grant_access": {
commonParams: {
client_session_id?: string;
connect_webview_ids?: string[];
connected_account_ids?: string[];
user_identifier_key?: string;
user_identity_id?: string;
user_identity_ids?: string[];
};
formData: {};
jsonBody: {};
jsonResponse: {
client_session: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string
| null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/client_sessions/grant_access";
}
/client_sessions/list
"/client_sessions/list": {
commonParams: {
client_session_id?: string;
connect_webview_id?: string;
user_identifier_key?: string;
user_identity_id?: string;
without_user_identifier_key?: boolean;
};
formData: {};
jsonBody: {};
jsonResponse: {
client_sessions: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string
| null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/client_sessions/list";
}
/client_sessions/revoke
"/client_sessions/revoke": {
commonParams: { client_session_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/client_sessions/revoke";
}
/connect_webviews/create
"/connect_webviews/create": {
commonParams: {};
formData: {};
jsonBody: {
accepted_capabilities?: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
accepted_providers?: (
| "hotek"
| "dormakaba_community"
| "legic_connect"
| "akuvox"
| "august"
| "avigilon_alta"
| "brivo"
| "butterflymx"
| "schlage"
| "smartthings"
| "yale"
| "genie"
| "doorking"
| "salto"
| "salto_ks"
| "lockly"
| "ttlock"
| "linear"
| "noiseaware"
| "nuki"
| "seam_relay_admin"
| "igloo"
| "kwikset"
| "minut"
| "my_2n"
| "controlbyweb"
| "nest"
| "igloohome"
| "ecobee"
| "hubitat"
| "four_suites"
| "dormakaba_oracode"
| "pti"
| "wyze"
| "seam_passport"
| "visionline"
| "assa_abloy_credential_service"
| "tedee"
| "honeywell_resideo"
| "latch"
| "akiles"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "tado"
| "salto_space"
| "sensi"
| "kwikset2"
| "keynest"
| "korelock"
| "dormakaba_ambiance"
| "ultraloq"
| "yale_access"
| "hid_cm"
| "google_nest"
)[];
automatically_manage_new_devices?: boolean;
custom_metadata?: { [x: string]: null
| string
| boolean };
custom_redirect_failure_url?: string;
custom_redirect_url?: string;
customer_key?: string;
device_selection_mode?: "none" | "single" | "multiple";
excluded_providers?: string[];
provider_category?:
| "stable"
| "consumer_smartlocks"
| "beta"
| "thermostats"
| "noise_sensors"
| "access_control_systems"
| "internal_beta";
wait_for_device_creation?: boolean;
};
jsonResponse: {
connect_webview: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: string | null;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: string | null;
created_at: string;
custom_metadata: { [x: string]: string | boolean };
custom_redirect_failure_url: string | null;
custom_redirect_url: string | null;
customer_key?: string;
device_selection_mode: "none" | "single" | "multiple";
login_successful: boolean;
selected_provider: string | null;
status: "pending" | "failed" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/connect_webviews/create";
}
/connect_webviews/delete
"/connect_webviews/delete": {
commonParams: {};
formData: {};
jsonBody: { connect_webview_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/connect_webviews/delete";
}
/connect_webviews/get
"/connect_webviews/get": {
commonParams: { connect_webview_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
connect_webview: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: string | null;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: string | null;
created_at: string;
custom_metadata: { [x: string]: string | boolean };
custom_redirect_failure_url: string | null;
custom_redirect_url: string | null;
customer_key?: string;
device_selection_mode: "none" | "single" | "multiple";
login_successful: boolean;
selected_provider: string | null;
status: "pending" | "failed" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/connect_webviews/get";
}
/connect_webviews/list
"/connect_webviews/list": {
commonParams: {
custom_metadata_has?: { [x: string]: string | boolean };
customer_key?: string;
limit?: number;
page_cursor?: string | undefined | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
connect_webviews: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: string | null;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: string | null;
created_at: string;
custom_metadata: { [x: string]: string | boolean };
custom_redirect_failure_url: string | null;
custom_redirect_url: string | null;
customer_key?: string;
device_selection_mode: "none" | "single" | "multiple";
login_successful: boolean;
selected_provider: string | null;
status: "pending" | "failed" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/connect_webviews/list";
}
/connected_accounts/delete
"/connected_accounts/delete": {
commonParams: {};
formData: {};
jsonBody: { connected_account_id: string; sync?: boolean };
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/connected_accounts/delete";
}
/connected_accounts/get
"/connected_accounts/get": {
commonParams: { connected_account_id: string } | { email: string };
formData: {};
jsonBody: {};
jsonResponse: {
connected_account: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
account_type?: string;
account_type_display_name: string;
automatically_manage_new_devices: boolean;
connected_account_id: string;
created_at?: string;
custom_metadata: { [x: string]: string | boolean };
customer_key?: string;
display_name: string;
errors: (
| {
created_at: string;
error_code: "account_disconnected";
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;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
salto_ks_metadata: {
sites: {
site_id: ...;
site_name: ...;
site_user_subscription_limit: ...;
subscribed_site_user_count: ...;
}[];
};
}
)[];
image_url?: string;
user_identifier?: {
api_url?: string;
email?: string;
exclusive?: boolean;
phone?: string;
username?: string;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_connected_account";
}
| {
created_at: string;
message: string;
salto_ks_metadata: {
sites: {
site_id: ...;
site_name: ...;
site_user_subscription_limit: ...;
subscribed_site_user_count: ...;
}[];
};
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "account_reauthorization_requested";
}
)[];
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/connected_accounts/get";
}
/connected_accounts/list
"/connected_accounts/list": {
commonParams: {
custom_metadata_has?: { [x: string]: string | boolean };
customer_key?: string;
limit?: number;
page_cursor?: string | undefined | null;
search?: string;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
connected_accounts: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
account_type?: string;
account_type_display_name: string;
automatically_manage_new_devices: boolean;
connected_account_id: string;
created_at?: string;
custom_metadata: { [x: string]: string | boolean };
customer_key?: string;
display_name: string;
errors: (
| {
created_at: string;
error_code: "account_disconnected";
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;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
salto_ks_metadata: { sites: (...)[] };
}
)[];
image_url?: string;
user_identifier?: {
api_url?: string;
email?: string;
exclusive?: boolean;
phone?: string;
username?: string;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_connected_account";
}
| {
created_at: string;
message: string;
salto_ks_metadata: { sites: (...)[] };
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "account_reauthorization_requested";
}
)[];
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/connected_accounts/list";
}
/connected_accounts/simulate/disconnect
"/connected_accounts/simulate/disconnect": {
commonParams: {};
formData: {};
jsonBody: { connected_account_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/connected_accounts/simulate/disconnect";
}
/connected_accounts/sync
"/connected_accounts/sync": {
commonParams: {};
formData: {};
jsonBody: { connected_account_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/connected_accounts/sync";
}
/connected_accounts/update
"/connected_accounts/update": {
commonParams: {};
formData: {};
jsonBody: {
accepted_capabilities?: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
automatically_manage_new_devices?: boolean;
connected_account_id: string;
custom_metadata?: { [x: string]: null | string | boolean };
customer_key?: string;
};
jsonResponse: {
connected_account: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
account_type?: string;
account_type_display_name: string;
automatically_manage_new_devices: boolean;
connected_account_id: string;
created_at?: string;
custom_metadata: { [x: string]: string | boolean };
customer_key?: string;
display_name: string;
errors: (
| {
created_at: string;
error_code: "account_disconnected";
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;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
salto_ks_metadata: {
sites: {
site_id: ...;
site_name: ...;
site_user_subscription_limit: ...;
subscribed_site_user_count: ...;
}[];
};
}
)[];
image_url?: string;
user_identifier?: {
api_url?: string;
email?: string;
exclusive?: boolean;
phone?: string;
username?: string;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_connected_account";
}
| {
created_at: string;
message: string;
salto_ks_metadata: {
sites: {
site_id: ...;
site_name: ...;
site_user_subscription_limit: ...;
subscribed_site_user_count: ...;
}[];
};
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "account_reauthorization_requested";
}
)[];
};
};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/connected_accounts/update";
}
/customers/create_portal
"/customers/create_portal": {
commonParams: {
customization_profile_id?: string;
features?: {
configure?: {
allow_access_automation_rule_customization?: boolean;
allow_climate_automation_rule_customization?: boolean;
allow_instant_key_customization?: boolean;
exclude?: boolean;
};
connect?: {
accepted_providers?: string[];
exclude?: boolean;
excluded_providers?: string[];
};
manage?: {
exclude?: boolean;
exclude_reservation_management?: boolean;
exclude_staff_management?: boolean;
};
manage_devices?: { exclude?: boolean };
organize?: { exclude?: boolean };
};
is_embedded?: boolean;
landing_page?: {
manage?: | | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...) | (...) | (...);
};
locale?: "en-US"
| "pt-PT"
| "fr-FR"
| "it-IT"
| "es-ES";
property_listing_filter?: { [x: string]: string | boolean };
} & {
customer_data?: {
access_grants?: {
access_grant_key: string;
building_keys?: (...)[];
common_area_keys?: (...)[];
ends_at?: string;
facility_keys?: (...)[];
guest_key?: string;
listing_keys?: (...)[];
name?: string;
preferred_code?: string;
property_keys?: (...)[];
resident_key?: string;
room_keys?: (...)[];
space_keys?: (...)[];
starts_at?: string;
tenant_key?: string;
unit_keys?: (...)[];
user_identity_key?: string;
user_key?: string;
}[];
bookings?: {
booking_key: string;
building_keys?: (...)[];
common_area_keys?: (...)[];
ends_at?: string;
facility_keys?: (...)[];
guest_key?: string;
listing_keys?: (...)[];
name?: string;
preferred_code?: string;
property_keys?: (...)[];
resident_key?: string;
room_keys?: (...)[];
space_keys?: (...)[];
starts_at?: string;
tenant_key?: string;
unit_keys?: (...)[];
user_identity_key?: string;
user_key?: string;
}[];
buildings?: { building_key: string; name: string }[];
common_areas?: {
common_area_key: string;
name: string;
parent_site_key?: string;
}[];
customer_key: string;
facilities?: { facility_key: string; name: string }[];
guests?: {
email_address?: string;
guest_key: string;
name: string;
phone_number?: string;
}[];
listings?: { listing_key: string; name: string }[];
properties?: { name: string; property_key: string }[];
property_listings?: {
custom_metadata?: { [x: ...]: ... };
name: string;
property_listing_key: string;
}[];
reservations?: {
building_keys?: (...)[];
common_area_keys?: (...)[];
ends_at?: string;
facility_keys?: (...)[];
guest_key?: string;
listing_keys?: (...)[];
name?: string;
preferred_code?: string;
property_keys?: (...)[];
reservation_key: string;
resident_key?: string;
room_keys?: (...)[];
space_keys?: (...)[];
starts_at?: string;
tenant_key?: string;
unit_keys?: (...)[];
user_identity_key?: string;
user_key?: string;
}[];
residents?: {
email_address?: string;
name: string;
phone_number?: string;
resident_key: string;
}[];
rooms?: { name: string; parent_site_key?: string; room_key: string }[];
sites?: { name: string; site_key: string }[];
spaces?: { name: string; space_key: string }[];
staff_members?: {
building_keys?: (...)[];
common_area_keys?: (...)[];
email_address?: string;
facility_keys?: (...)[];
listing_keys?: (...)[];
name: string;
phone_number?: string;
property_keys?: (...)[];
property_listing_keys?: (...)[];
room_keys?: (...)[];
site_keys?: (...)[];
space_keys?: (...)[];
staff_member_key: string;
unit_keys?: (...)[];
}[];
tenants?: {
email_address?: string;
name: string;
phone_number?: string;
tenant_key: string;
}[];
units?: { name: string; parent_site_key?: string; unit_key: string }[];
user_identities?: {
email_address?: string;
name: string;
phone_number?: string;
user_identity_key: string;
}[];
users?: {
email_address?: string;
name: string;
phone_number?: string;
user_key: string;
}[];
};
};
formData: {};
jsonBody: {};
jsonResponse: {
magic_link: {
created_at: string;
customer_key: string;
expires_at: string;
url: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/customers/create_portal";
}
/customers/delete_data
"/customers/delete_data": {
commonParams: {
access_grant_keys?: string[];
booking_keys?: string[];
building_keys?: string[];
common_area_keys?: string[];
customer_keys?: string[];
facility_keys?: string[];
guest_keys?: string[];
listing_keys?: string[];
property_keys?: string[];
property_listing_keys?: string[];
reservation_keys?: string[];
resident_keys?: string[];
room_keys?: string[];
space_keys?: string[];
staff_member_keys?: string[];
tenant_keys?: string[];
unit_keys?: string[];
user_identity_keys?: string[];
user_keys?: string[];
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE"
| "POST";
queryParams: {};
route: "/customers/delete_data";
}
/customers/push_data
"/customers/push_data": {
commonParams: {
access_grants?: {
access_grant_key: string;
building_keys?: string[];
common_area_keys?: string[];
ends_at?: string;
facility_keys?: string[];
guest_key?: string;
listing_keys?: string[];
name?: string;
preferred_code?: string;
property_keys?: string[];
resident_key?: string;
room_keys?: string[];
space_keys?: string[];
starts_at?: string;
tenant_key?: string;
unit_keys?: string[];
user_identity_key?: string;
user_key?: string;
}[];
bookings?: {
booking_key: string;
building_keys?: string[];
common_area_keys?: string[];
ends_at?: string;
facility_keys?: string[];
guest_key?: string;
listing_keys?: string[];
name?: string;
preferred_code?: string;
property_keys?: string[];
resident_key?: string;
room_keys?: string[];
space_keys?: string[];
starts_at?: string;
tenant_key?: string;
unit_keys?: string[];
user_identity_key?: string;
user_key?: string;
}[];
buildings?: { building_key: string; name: string }[];
common_areas?: {
common_area_key: string;
name: string;
parent_site_key?: string;
}[];
customer_key: string;
facilities?: { facility_key: string; name: string }[];
guests?: {
email_address?: string;
guest_key: string;
name: string;
phone_number?: string;
}[];
listings?: { listing_key: string; name: string }[];
properties?: { name: string; property_key: string }[];
property_listings?: {
custom_metadata?: { [x: string]: null | string | boolean };
name: string;
property_listing_key: string;
}[];
reservations?: {
building_keys?: string[];
common_area_keys?: string[];
ends_at?: string;
facility_keys?: string[];
guest_key?: string;
listing_keys?: string[];
name?: string;
preferred_code?: string;
property_keys?: string[];
reservation_key: string;
resident_key?: string;
room_keys?: string[];
space_keys?: string[];
starts_at?: string;
tenant_key?: string;
unit_keys?: string[];
user_identity_key?: string;
user_key?: string;
}[];
residents?: {
email_address?: string;
name: string;
phone_number?: string;
resident_key: string;
}[];
rooms?: { name: string; parent_site_key?: string; room_key: string }[];
sites?: { name: string; site_key: string }[];
spaces?: { name: string; space_key: string }[];
staff_members?: {
building_keys?: string[];
common_area_keys?: string[];
email_address?: string;
facility_keys?: string[];
listing_keys?: string[];
name: string;
phone_number?: string;
property_keys?: string[];
property_listing_keys?: string[];
room_keys?: string[];
site_keys?: string[];
space_keys?: string[];
staff_member_key: string;
unit_keys?: string[];
}[];
tenants?: {
email_address?: string;
name: string;
phone_number?: string;
tenant_key: string;
}[];
units?: { name: string; parent_site_key?: string; unit_key: string }[];
user_identities?: {
email_address?: string;
name: string;
phone_number?: string;
user_identity_key: string;
}[];
users?: {
email_address?: string;
name: string;
phone_number?: string;
user_key: string;
}[];
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/customers/push_data";
}
/devices/delete
"/devices/delete": {
commonParams: { device_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/devices/delete";
}
/devices/get
"/devices/get": {
commonParams: { device_id?: string; name?: string };
formData: {};
jsonBody: {};
jsonResponse: {
device: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: (...) | (...);
appearance: { name: ... };
battery?: (...) | (...);
battery_level?: (...) | (...);
currently_triggering_noise_threshold_ids?: (...) | (...);
has_direct_power?: (...) | (...);
image_alt_text?: (...) | (...);
image_url?: (...) | (...);
manufacturer?: (...) | (...);
model: {
accessory_keypad_supported?: ...;
can_connect_accessory_keypad?: ...;
display_name: ...;
has_built_in_keypad?: ...;
manufacturer_display_name: ...;
offline_access_codes_supported?: ...;
online_access_codes_supported?: ...;
};
name: string;
noise_level_decibels?: (...)
| (...);
offline_access_codes_enabled?: (...) | (...);
online: boolean;
online_access_codes_enabled?: (...) | (...);
serial_number?: (...) | (...);
supports_accessory_keypad?: (...) | (...);
supports_offline_access_codes?: (...) | (...);
} & {
assa_abloy_credential_service_metadata?: (...)
| (...);
salto_space_credential_service_metadata?: (...) | (...);
} & {
akiles_metadata?: {
_member_group_id?: (...)
| (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: { encoder_name: string };
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
activation_enabled?: (...)
| (...);
device_name?: (...) | (...);
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...)
| (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...)
| (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: { device_name: string; ecobee_device_id: string };
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: { device_name: string; door_name: string };
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...)
| (...);
};
igloohome_metadata?: {
bridge_id?: (...)
| (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
is_keypad_linked_to_bridge?: (...) | (...);
keypad_id?: (...) | (...);
};
keynest_metadata?: {
address?: (...)
| (...);
current_or_last_store_id?: (...) | (...);
current_status?: (...) | (...);
current_user_company?: (...) | (...);
current_user_email?: (...) | (...);
current_user_name?: (...) | (...);
current_user_phone_number?: (...) | (...);
default_office_id?: (...) | (...);
device_name?: (...) | (...);
fob_id?: (...) | (...);
handover_method?: (...) | (...);
has_photo?: (...) | (...);
is_quadient_locker?: (...) | (...);
key_id?: (...) | (...);
key_notes?: (...) | (...);
keynest_app_user?: (...) | (...);
last_movement?: (...) | (...);
property_id?: (...) | (...);
property_postcode?: (...) | (...);
status_type?: (...) | (...);
subscription_plan?: (...) | (...);
};
korelock_metadata?: {
device_id?: (...)
| (...);
device_name?: (...) | (...);
firmware_version?: (...) | (...);
model_code?: (...) | (...);
serial_number?: (...) | (...);
wifi_signal_strength?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...)
| (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...)
| (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...)
| (...);
keypad_battery_critical?: (...) | (...);
keypad_paired?: (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
has_custom_pin_subscription?: (...)
| (...);
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...)
| (...);
};
schlage_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...)
| (...);
};
sensi_metadata?: {
device_id: string;
device_name: string;
product_type: string;
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...)
| (...);
model?: (...) | (...);
};
tado_metadata?: { device_type: string; serial_no: string };
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
wifi: ...;
};
has_gateway?: (...)
| (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: { device_id: number; device_name: string };
ultraloq_metadata?: {
device_id: string;
device_name: string;
device_type: string;
time_zone: (...) | (...);
};
visionline_metadata?: { encoder_id: string };
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: | (...)
| (...);
code_constraints?: (...) | (...);
door_open?: (...) | (...);
has_native_entry_events?: (...) | (...);
keypad_battery?: (...) | (...);
locked?: (...) | (...);
max_active_codes_supported?: (...) | (...);
supported_code_lengths?: (...) | (...);
supports_backup_access_code_pool?: (...) | (...);
} & {
active_thermostat_schedule?: (...)
| (...);
active_thermostat_schedule_id?: (...) | (...);
available_climate_preset_modes?: (...)[];
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
can_use_with_thermostat_daily_programs: ...;
climate_preset_key: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: (...) | (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
default_climate_setting?: {
can_delete?: (...)
| (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
fallback_climate_preset_key?: (...)
| (...);
fan_mode_setting?: (...) | (...) | (...);
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: (...) | (...);
max_unique_climate_presets_per_thermostat_weekly_program?: (...) | (...);
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: (...) | (...);
thermostat_daily_program_period_precision_minutes?: (...) | (...);
thermostat_daily_programs?: (...) | (...);
thermostat_weekly_program?: (...) | (...);
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/devices/get";
}
/devices/list
"/devices/list": {
commonParams: {
connect_webview_id?: string;
connected_account_id?: string;
connected_account_ids?: string[];
created_before?: Date;
custom_metadata_has?: { [x: string]: string | boolean };
customer_key?: string;
device_ids?: string[];
device_type?:
| | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
device_types?: (
| | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone"
)[];
exclude_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
include_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
limit?: number;
manufacturer?: | "akuvox"
| "august"
| "avigilon_alta"
| "brivo"
| "butterflymx"
| "doorking"
| "four_suites"
| "genie"
| "igloo"
| "keywe"
| "kwikset"
| "linear"
| "lockly"
| "nuki"
| "philia"
| "salto"
| "samsung"
| "schlage"
| "seam"
| "unknown"
| "wyze"
| "yale"
| "two_n"
| "ttlock"
| "igloohome"
| "hubitat"
| "controlbyweb"
| "dormakaba_oracode"
| "tedee"
| "korelock"
| "akiles"
| "ecobee"
| "honeywell_resideo"
| "keynest"
| "korelock"
| "kwikset2"
| "minut"
| "nest"
| "noiseaware"
| "sensi"
| "smartthings"
| "tado"
| "ultraloq";
page_cursor?: string | undefined
| null;
search?: string;
space_id?: string;
unstable_location_id?: string | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/devices/list";
}
/devices/list_device_providers
"/devices/list_device_providers": {
commonParams: {
provider_category?:
| "stable"
| "consumer_smartlocks"
| "beta"
| "thermostats"
| "noise_sensors"
| "access_control_systems";
};
formData: {};
jsonBody: {};
jsonResponse: {
device_providers: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
device_provider_name: | "hotek"
| "dormakaba_community"
| "legic_connect"
| "akuvox"
| "august"
| "avigilon_alta"
| "brivo"
| "butterflymx"
| "schlage"
| "smartthings"
| "yale"
| "genie"
| "doorking"
| "salto"
| "salto_ks"
| "lockly"
| "ttlock"
| "linear"
| "noiseaware"
| "nuki"
| "seam_relay_admin"
| "igloo"
| "kwikset"
| "minut"
| "my_2n"
| "controlbyweb"
| "nest"
| "igloohome"
| "ecobee"
| "hubitat"
| "four_suites"
| "dormakaba_oracode"
| "pti"
| "wyze"
| "seam_passport"
| "visionline"
| "assa_abloy_credential_service"
| "tedee"
| "honeywell_resideo"
| "latch"
| "akiles"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "tado"
| "salto_space"
| "sensi"
| "kwikset2"
| "keynest"
| "korelock"
| "dormakaba_ambiance"
| "ultraloq";
display_name: string;
image_url: string;
provider_categories: (
| "stable"
| "consumer_smartlocks"
| "beta"
| "thermostats"
| "noise_sensors"
| "access_control_systems"
)[];
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/devices/list_device_providers";
}
"/devices/report_provider_metadata": {
commonParams: {
devices: {
device_id: string;
ultraloq_metadata?: {
time_zone:
| "Africa/Abidjan"
| "Africa/Accra"
| "Africa/Addis_Ababa"
| "Africa/Algiers"
| "Africa/Asmera"
| "Africa/Bamako"
| "Africa/Bangui"
| "Africa/Banjul"
| "Africa/Bissau"
| "Africa/Blantyre"
| "Africa/Brazzaville"
| "Africa/Bujumbura"
| "Africa/Cairo"
| "Africa/Casablanca"
| "Africa/Ceuta"
| "Africa/Conakry"
| "Africa/Dakar"
| "Africa/Dar_es_Salaam"
| "Africa/Djibouti"
| "Africa/Douala"
| "Africa/El_Aaiun"
| "Africa/Freetown"
| "Africa/Gaborone"
| "Africa/Harare"
| "Africa/Johannesburg"
| "Africa/Juba"
| "Africa/Kampala"
| "Africa/Khartoum"
| "Africa/Kigali"
| "Africa/Kinshasa"
| "Africa/Lagos"
| "Africa/Libreville"
| "Africa/Lome"
| "Africa/Luanda"
| "Africa/Lubumbashi"
| "Africa/Lusaka"
| "Africa/Malabo"
| "Africa/Maputo"
| "Africa/Maseru"
| "Africa/Mbabane"
| "Africa/Mogadishu"
| "Africa/Monrovia"
| "Africa/Nairobi"
| "Africa/Ndjamena"
| "Africa/Niamey"
| "Africa/Nouakchott"
| "Africa/Ouagadougou"
| "Africa/Porto-Novo"
| "Africa/Sao_Tome"
| "Africa/Tripoli"
| "Africa/Tunis"
| "Africa/Windhoek"
| "America/Adak"
| "America/Anchorage"
| "America/Anguilla"
| "America/Antigua"
| "America/Araguaina"
| "America/Argentina/La_Rioja"
| "America/Argentina/Rio_Gallegos"
| "America/Argentina/Salta"
| "America/Argentina/San_Juan"
| "America/Argentina/San_Luis"
| "America/Argentina/Tucuman"
| "America/Argentina/Ushuaia"
| "America/Aruba"
| "America/Asuncion"
| "America/Bahia"
| "America/Bahia_Banderas"
| "America/Barbados"
| "America/Belem"
| "America/Belize"
| "America/Blanc-Sablon"
| "America/Boa_Vista"
| "America/Bogota"
| "America/Boise"
| "America/Buenos_Aires"
| "America/Cambridge_Bay"
| "America/Campo_Grande"
| "America/Cancun"
| "America/Caracas"
| "America/Catamarca"
| "America/Cayenne"
| "America/Cayman"
| "America/Chicago"
| "America/Chihuahua"
| "America/Ciudad_Juarez"
| "America/Coral_Harbour"
| "America/Cordoba"
| "America/Costa_Rica"
| "America/Creston"
| "America/Cuiaba"
| "America/Curacao"
| "America/Danmarkshavn"
| "America/Dawson"
| "America/Dawson_Creek"
| "America/Denver"
| "America/Detroit"
| "America/Dominica"
| "America/Edmonton"
| "America/Eirunepe"
| "America/El_Salvador"
| "America/Fort_Nelson"
| "America/Fortaleza"
| "America/Glace_Bay"
| "America/Godthab"
| "America/Goose_Bay"
| "America/Grand_Turk"
| "America/Grenada"
| "America/Guadeloupe"
| "America/Guatemala"
| "America/Guayaquil"
| "America/Guyana"
| "America/Halifax"
| "America/Havana"
| "America/Hermosillo"
| "America/Indiana/Knox"
| "America/Indiana/Marengo"
| "America/Indiana/Petersburg"
| "America/Indiana/Tell_City"
| "America/Indiana/Vevay"
| "America/Indiana/Vincennes"
| "America/Indiana/Winamac"
| "America/Indianapolis"
| "America/Inuvik"
| "America/Iqaluit"
| "America/Jamaica"
| "America/Jujuy"
| "America/Juneau"
| "America/Kentucky/Monticello"
| "America/Kralendijk"
| "America/La_Paz"
| "America/Lima"
| "America/Los_Angeles"
| "America/Louisville"
| "America/Lower_Princes"
| "America/Maceio"
| "America/Managua"
| "America/Manaus"
| "America/Marigot"
| "America/Martinique"
| "America/Matamoros"
| "America/Mazatlan"
| "America/Mendoza"
| "America/Menominee"
| "America/Merida"
| "America/Metlakatla"
| "America/Mexico_City"
| "America/Miquelon"
| "America/Moncton"
| "America/Monterrey"
| "America/Montevideo"
| "America/Montreal"
| "America/Montserrat"
| "America/Nassau"
| "America/New_York"
| "America/Nipigon"
| "America/Nome"
| "America/Noronha"
| "America/North_Dakota/Beulah"
| "America/North_Dakota/Center"
| "America/North_Dakota/New_Salem"
| "America/Ojinaga"
| "America/Panama"
| "America/Pangnirtung"
| "America/Paramaribo"
| "America/Phoenix"
| "America/Port-au-Prince"
| "America/Port_of_Spain"
| "America/Porto_Velho"
| "America/Puerto_Rico"
| "America/Punta_Arenas"
| "America/Rainy_River"
| "America/Rankin_Inlet"
| "America/Recife"
| "America/Regina"
| "America/Resolute"
| "America/Rio_Branco"
| "America/Santa_Isabel"
| "America/Santarem"
| "America/Santiago"
| "America/Santo_Domingo"
| "America/Sao_Paulo"
| "America/Scoresbysund"
| "America/Sitka"
| "America/St_Barthelemy"
| "America/St_Johns"
| "America/St_Kitts"
| "America/St_Lucia"
| "America/St_Thomas"
| "America/St_Vincent"
| "America/Swift_Current"
| "America/Tegucigalpa"
| "America/Thule"
| "America/Thunder_Bay"
| "America/Tijuana"
| "America/Toronto"
| "America/Tortola"
| "America/Vancouver"
| "America/Whitehorse"
| "America/Winnipeg"
| "America/Yakutat"
| "America/Yellowknife"
| "Antarctica/Casey"
| "Antarctica/Davis"
| "Antarctica/DumontDUrville"
| "Antarctica/Macquarie"
| "Antarctica/Mawson"
| "Antarctica/McMurdo"
| "Antarctica/Palmer"
| "Antarctica/Rothera"
| "Antarctica/Syowa"
| "Antarctica/Troll"
| "Antarctica/Vostok"
| "Arctic/Longyearbyen"
| "Asia/Aden"
| "Asia/Almaty"
| "Asia/Amman"
| "Asia/Anadyr"
| "Asia/Aqtau"
| "Asia/Aqtobe"
| "Asia/Ashgabat"
| "Asia/Atyrau"
| "Asia/Baghdad"
| "Asia/Bahrain"
| "Asia/Baku"
| "Asia/Bangkok"
| "Asia/Barnaul"
| "Asia/Beirut"
| "Asia/Bishkek"
| "Asia/Brunei"
| "Asia/Calcutta"
| "Asia/Chita"
| "Asia/Choibalsan"
| "Asia/Colombo"
| "Asia/Damascus"
| "Asia/Dhaka"
| "Asia/Dili"
| "Asia/Dubai"
| "Asia/Dushanbe"
| "Asia/Famagusta"
| "Asia/Gaza"
| "Asia/Hebron"
| "Asia/Hong_Kong"
| "Asia/Hovd"
| "Asia/Irkutsk"
| "Asia/Jakarta"
| "Asia/Jayapura"
| "Asia/Jerusalem"
| "Asia/Kabul"
| "Asia/Kamchatka"
| "Asia/Karachi"
| "Asia/Katmandu"
| "Asia/Khandyga"
| "Asia/Krasnoyarsk"
| "Asia/Kuala_Lumpur"
| "Asia/Kuching"
| "Asia/Kuwait"
| "Asia/Macau"
| "Asia/Magadan"
| "Asia/Makassar"
| "Asia/Manila"
| "Asia/Muscat"
| "Asia/Nicosia"
| "Asia/Novokuznetsk"
| "Asia/Novosibirsk"
| "Asia/Omsk"
| "Asia/Oral"
| "Asia/Phnom_Penh"
| "Asia/Pontianak"
| "Asia/Pyongyang"
| "Asia/Qatar"
| "Asia/Qostanay"
| "Asia/Qyzylorda"
| "Asia/Rangoon"
| "Asia/Riyadh"
| "Asia/Saigon"
| "Asia/Sakhalin"
| "Asia/Samarkand"
| "Asia/Seoul"
| "Asia/Shanghai"
| "Asia/Singapore"
| "Asia/Srednekolymsk"
| "Asia/Taipei"
| "Asia/Tashkent"
| "Asia/Tbilisi"
| "Asia/Tehran"
| "Asia/Thimphu"
| "Asia/Tokyo"
| "Asia/Tomsk"
| "Asia/Ulaanbaatar"
| "Asia/Urumqi"
| "Asia/Ust-Nera"
| "Asia/Vientiane"
| "Asia/Vladivostok"
| "Asia/Yakutsk"
| "Asia/Yekaterinburg"
| "Asia/Yerevan"
| "Atlantic/Azores"
| "Atlantic/Bermuda"
| "Atlantic/Canary"
| "Atlantic/Cape_Verde"
| "Atlantic/Faeroe"
| "Atlantic/Madeira"
| "Atlantic/Reykjavik"
| "Atlantic/South_Georgia"
| "Atlantic/St_Helena"
| "Atlantic/Stanley"
| "Australia/Adelaide"
| "Australia/Brisbane"
| "Australia/Broken_Hill"
| "Australia/Currie"
| "Australia/Darwin"
| "Australia/Eucla"
| "Australia/Hobart"
| "Australia/Lindeman"
| "Australia/Lord_Howe"
| "Australia/Melbourne"
| "Australia/Perth"
| "Australia/Sydney"
| "Europe/Amsterdam"
| "Europe/Andorra"
| "Europe/Astrakhan"
| "Europe/Athens"
| "Europe/Belgrade"
| "Europe/Berlin"
| "Europe/Bratislava"
| "Europe/Brussels"
| "Europe/Bucharest"
| "Europe/Budapest"
| "Europe/Busingen"
| "Europe/Chisinau"
| "Europe/Copenhagen"
| "Europe/Dublin"
| "Europe/Gibraltar"
| "Europe/Guernsey"
| "Europe/Helsinki"
| "Europe/Isle_of_Man"
| "Europe/Istanbul"
| "Europe/Jersey"
| "Europe/Kaliningrad"
| "Europe/Kiev"
| "Europe/Kirov"
| "Europe/Lisbon"
| "Europe/Ljubljana"
| "Europe/London"
| "Europe/Luxembourg"
| "Europe/Madrid"
| "Europe/Malta"
| "Europe/Mariehamn"
| "Europe/Minsk"
| "Europe/Monaco"
| "Europe/Moscow"
| "Europe/Oslo"
| "Europe/Paris"
| "Europe/Podgorica"
| "Europe/Prague"
| "Europe/Riga"
| "Europe/Rome"
| "Europe/Samara"
| "Europe/San_Marino"
| "Europe/Sarajevo"
| "Europe/Saratov"
| "Europe/Simferopol"
| "Europe/Skopje"
| "Europe/Sofia"
| "Europe/Stockholm"
| "Europe/Tallinn"
| "Europe/Tirane"
| "Europe/Ulyanovsk"
| "Europe/Uzhgorod"
| "Europe/Vaduz"
| "Europe/Vatican"
| "Europe/Vienna"
| "Europe/Vilnius"
| "Europe/Volgograd"
| "Europe/Warsaw"
| "Europe/Zagreb"
| "Europe/Zaporozhye"
| "Europe/Zurich"
| "Indian/Antananarivo"
| "Indian/Chagos"
| "Indian/Christmas"
| "Indian/Cocos"
| "Indian/Comoro"
| "Indian/Kerguelen"
| "Indian/Mahe"
| "Indian/Maldives"
| "Indian/Mauritius"
| "Indian/Mayotte"
| "Indian/Reunion"
| "Pacific/Apia"
| "Pacific/Auckland"
| "Pacific/Bougainville"
| "Pacific/Chatham"
| "Pacific/Easter"
| "Pacific/Efate"
| "Pacific/Enderbury"
| "Pacific/Fakaofo"
| "Pacific/Fiji"
| "Pacific/Funafuti"
| "Pacific/Galapagos"
| "Pacific/Gambier"
| "Pacific/Guadalcanal"
| "Pacific/Guam"
| "Pacific/Honolulu"
| "Pacific/Johnston"
| "Pacific/Kiritimati"
| "Pacific/Kosrae"
| "Pacific/Kwajalein"
| "Pacific/Majuro"
| "Pacific/Marquesas"
| "Pacific/Midway"
| "Pacific/Nauru"
| "Pacific/Niue"
| "Pacific/Norfolk"
| "Pacific/Noumea"
| "Pacific/Pago_Pago"
| "Pacific/Palau"
| "Pacific/Pitcairn"
| "Pacific/Ponape"
| "Pacific/Port_Moresby"
| "Pacific/Rarotonga"
| "Pacific/Saipan"
| "Pacific/Tahiti"
| "Pacific/Tarawa"
| "Pacific/Tongatapu"
| "Pacific/Truk"
| "Pacific/Wake"
| "Pacific/Wallis";
};
}[];
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/devices/report_provider_metadata";
}
/devices/simulate/connect
"/devices/simulate/connect": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/devices/simulate/connect";
}
/devices/simulate/connect_to_hub
"/devices/simulate/connect_to_hub": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/devices/simulate/connect_to_hub";
}
/devices/simulate/disconnect
"/devices/simulate/disconnect": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/devices/simulate/disconnect";
}
/devices/simulate/disconnect_from_hub
"/devices/simulate/disconnect_from_hub": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/devices/simulate/disconnect_from_hub";
}
/devices/simulate/paid_subscription
"/devices/simulate/paid_subscription": {
commonParams: {};
formData: {};
jsonBody: { device_id: string; is_expired: boolean };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/devices/simulate/paid_subscription";
}
/devices/simulate/remove
"/devices/simulate/remove": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/devices/simulate/remove";
}
/devices/unmanaged/get
"/devices/unmanaged/get": {
commonParams: { device_id?: string; name?: string };
formData: {};
jsonBody: {};
jsonResponse: {
device: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_type:
| | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: false;
location: { location_name?: string; timezone?: string }
| null;
properties: {
accessory_keypad?: {
battery?: { level: number };
is_connected: boolean;
};
battery?: {
level: number;
status: "critical"
| "low"
| "good"
| "full";
};
battery_level?: number;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/devices/unmanaged/get";
}
/devices/unmanaged/list
"/devices/unmanaged/list": {
commonParams: {
connect_webview_id?: string;
connected_account_id?: string;
connected_account_ids?: string[];
created_before?: Date;
custom_metadata_has?: { [x: string]: string | boolean };
customer_key?: string;
device_ids?: string[];
device_type?:
| | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
device_types?: (
| | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone"
)[];
exclude_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
include_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
limit?: number;
manufacturer?: | "akuvox"
| "august"
| "avigilon_alta"
| "brivo"
| "butterflymx"
| "doorking"
| "four_suites"
| "genie"
| "igloo"
| "keywe"
| "kwikset"
| "linear"
| "lockly"
| "nuki"
| "philia"
| "salto"
| "samsung"
| "schlage"
| "seam"
| "unknown"
| "wyze"
| "yale"
| "two_n"
| "ttlock"
| "igloohome"
| "hubitat"
| "controlbyweb"
| "dormakaba_oracode"
| "tedee"
| "korelock"
| "akiles"
| "ecobee"
| "honeywell_resideo"
| "keynest"
| "korelock"
| "kwikset2"
| "minut"
| "nest"
| "noiseaware"
| "sensi"
| "smartthings"
| "tado"
| "ultraloq";
page_cursor?: string | undefined
| null;
search?: string;
space_id?: string;
unstable_location_id?: string | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_type:
| | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: false;
location: { location_name?: string; timezone?: string }
| null;
properties: {
accessory_keypad?: {
battery?: { level: number };
is_connected: boolean;
};
battery?: {
level: number;
status: "critical"
| "low"
| "good"
| "full";
};
battery_level?: number;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/devices/unmanaged/list";
}
/devices/unmanaged/update
"/devices/unmanaged/update": {
commonParams: {
custom_metadata?: { [x: string]: null | string | boolean };
device_id: string;
is_managed?: true;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/devices/unmanaged/update";
}
/devices/update
"/devices/update": {
commonParams: {
custom_metadata?: { [x: string]: null | string | boolean };
device_id: string;
is_managed?: boolean;
name?: string | null;
properties?: { name?: string | null };
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/devices/update";
}
/events/get
"/events/get": {
commonParams: {
device_id?: string;
event_id?: string;
event_type?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
event?: | {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.changed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.scheduled_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.removed_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_setting_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string
| null;
connected_account_custom_metadata?: { [x: string]: string | boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_removing_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_remove_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.modified_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.deleted_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
backup_access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.backup_access_code_pulled";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.failed_to_convert_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.removed";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.created";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_all_doors";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_door";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_to_door_lost";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
access_grant_key?: string;
created_at: string;
ends_at?: string;
event_id: string;
event_type: "access_grant.access_times_changed";
occurred_at: string;
starts_at?: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
error_message: string;
event_id: string;
event_type: "access_grant.could_not_create_requested_access_methods";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.issued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.revoked";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.card_encoding_required";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.reissued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.connected";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.issued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.reissued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.invalidated";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.created";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.removed";
occurred_at: string;
workspace_id: string;
}
| {
acs_access_group_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_access_group.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.removed";
occurred_at: string;
workspace_id: string;
}
| {
client_session_id: string;
created_at: string;
event_id: string;
event_type: "client_session.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.connected";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.created";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.successful_login";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_errors: (
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
salto_ks_metadata: ...;
}
)[];
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
connected_account_type?: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync_after_reconnection";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.reauthorization_requested";
occurred_at: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connect_webview.login_succeeded";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
created_at: string;
event_id: string;
event_type: "connect_webview.login_failed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.added";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.converted_to_unmanaged";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.unmanaged.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.unmanaged.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.tampered";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.low_battery";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
battery_status: "critical"
| "low"
| "good"
| "full";
connected_account_custom_metadata?: { [x: string]: string | boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.battery_status_changed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.removed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_no_longer_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_activated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_deactivated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connection_became_flaky";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connection_stabilized";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required.resolved";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "noise_sensor.noise_threshold_triggered";
minut_metadata?: { [x: string]: unknown };
noise_level_decibels?: number;
noise_level_nrs?: number;
noise_threshold_id?: string;
noise_threshold_name?: string;
noiseaware_metadata?: { [x: string]: unknown };
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "lock.locked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
acs_entrance_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id?: string;
event_id: string;
event_type: "lock.unlocked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
user_identity_id?: string;
workspace_id: string;
}
| {
access_code_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "lock.access_denied";
occurred_at: string;
workspace_id: string;
}
| {
climate_preset_key: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.climate_preset_activated";
is_fallback_climate_preset: boolean;
occurred_at: string;
thermostat_schedule_id: string | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
cooling_set_point_celsius?: number | undefined;
cooling_set_point_fahrenheit?: number | undefined;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.manually_adjusted";
fan_mode_setting?: (...) | undefined;
heating_set_point_celsius?: number | undefined;
heating_set_point_fahrenheit?: number | undefined;
hvac_mode_setting?: (...) | undefined;
method: "seam" | "external";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_no_longer_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
desired_temperature_celsius?: number;
desired_temperature_fahrenheit?: number;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_reached_set_point";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_changed";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
device_name: string;
event_id: string;
event_type: "device.name_changed";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
enrollment_automation_id: string;
event_id: string;
event_type: "enrollment_automation.deleted";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
device_custom_metadata?: { [x: string]: string
| boolean };
device_id: string;
event_id: string;
event_type: "phone.deactivated";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.device_membership_changed";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.created";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.deleted";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
};
message?: string;
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/events/get";
}
/events/list
"/events/list": {
commonParams: {
access_code_id?: string;
access_code_ids?: string[];
access_grant_id?: string;
access_grant_ids?: string[];
access_method_id?: string;
access_method_ids?: string[];
acs_access_group_id?: string;
acs_credential_id?: string;
acs_encoder_id?: string;
acs_entrance_id?: string;
acs_system_id?: string;
acs_system_ids?: string[];
acs_user_id?: string;
between?: (string | Date)[];
connect_webview_id?: string;
connected_account_id?: string;
customer_key?: string;
device_id?: string;
device_ids?: string[];
event_ids?: string[];
event_type?:
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "access_grant.created"
| "access_grant.deleted"
| "access_grant.access_granted_to_all_doors"
| "access_grant.access_granted_to_door"
| "access_grant.access_to_door_lost"
| "access_grant.access_times_changed"
| "access_grant.could_not_create_requested_access_methods"
| "access_method.issued"
| "access_method.revoked"
| "access_method.card_encoding_required"
| "access_method.deleted"
| "access_method.reissued"
| "acs_system.connected"
| "acs_system.added"
| "acs_system.disconnected"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_credential.reissued"
| "acs_credential.invalidated"
| "acs_user.created"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "acs_access_group.deleted"
| "acs_entrance.added"
| "acs_entrance.removed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "connected_account.reauthorization_requested"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "thermostat.temperature_reached_set_point"
| "thermostat.temperature_changed"
| "device.name_changed"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "space.device_membership_changed"
| "space.created"
| "space.deleted";
event_types?: (
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "access_grant.created"
| "access_grant.deleted"
| "access_grant.access_granted_to_all_doors"
| "access_grant.access_granted_to_door"
| "access_grant.access_to_door_lost"
| "access_grant.access_times_changed"
| "access_grant.could_not_create_requested_access_methods"
| "access_method.issued"
| "access_method.revoked"
| "access_method.card_encoding_required"
| "access_method.deleted"
| "access_method.reissued"
| "acs_system.connected"
| "acs_system.added"
| "acs_system.disconnected"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_credential.reissued"
| "acs_credential.invalidated"
| "acs_user.created"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "acs_access_group.deleted"
| "acs_entrance.added"
| "acs_entrance.removed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "connected_account.reauthorization_requested"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "thermostat.temperature_reached_set_point"
| "thermostat.temperature_changed"
| "device.name_changed"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "space.device_membership_changed"
| "space.created"
| "space.deleted"
)[];
limit?: number;
since?: string;
space_id?: string;
space_ids?: string[];
unstable_offset?: number;
user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
events: (
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.changed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.scheduled_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.removed_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_setting_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string
| null;
connected_account_custom_metadata?: { [x: string]: string | boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_removing_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_remove_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.modified_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.deleted_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
backup_access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.backup_access_code_pulled";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.failed_to_convert_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.removed";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.created";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_all_doors";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_door";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_to_door_lost";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
access_grant_key?: string;
created_at: string;
ends_at?: string;
event_id: string;
event_type: "access_grant.access_times_changed";
occurred_at: string;
starts_at?: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
error_message: string;
event_id: string;
event_type: "access_grant.could_not_create_requested_access_methods";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.issued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.revoked";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.card_encoding_required";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.reissued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.connected";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.issued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.reissued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.invalidated";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.created";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.removed";
occurred_at: string;
workspace_id: string;
}
| {
acs_access_group_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_access_group.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.removed";
occurred_at: string;
workspace_id: string;
}
| {
client_session_id: string;
created_at: string;
event_id: string;
event_type: "client_session.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.connected";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.created";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.successful_login";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_errors: (
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
salto_ks_metadata: ...;
}
)[];
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
connected_account_type?: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync_after_reconnection";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.reauthorization_requested";
occurred_at: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connect_webview.login_succeeded";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
created_at: string;
event_id: string;
event_type: "connect_webview.login_failed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.added";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.converted_to_unmanaged";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.unmanaged.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.unmanaged.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.tampered";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.low_battery";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
battery_status: "critical"
| "low"
| "good"
| "full";
connected_account_custom_metadata?: { [x: string]: string | boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.battery_status_changed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.removed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_no_longer_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_activated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_deactivated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connection_became_flaky";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connection_stabilized";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required.resolved";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "noise_sensor.noise_threshold_triggered";
minut_metadata?: { [x: string]: unknown };
noise_level_decibels?: number;
noise_level_nrs?: number;
noise_threshold_id?: string;
noise_threshold_name?: string;
noiseaware_metadata?: { [x: string]: unknown };
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "lock.locked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
acs_entrance_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id?: string;
event_id: string;
event_type: "lock.unlocked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
user_identity_id?: string;
workspace_id: string;
}
| {
access_code_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "lock.access_denied";
occurred_at: string;
workspace_id: string;
}
| {
climate_preset_key: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.climate_preset_activated";
is_fallback_climate_preset: boolean;
occurred_at: string;
thermostat_schedule_id: string | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
cooling_set_point_celsius?: number | undefined;
cooling_set_point_fahrenheit?: number | undefined;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.manually_adjusted";
fan_mode_setting?: (...) | undefined;
heating_set_point_celsius?: number | undefined;
heating_set_point_fahrenheit?: number | undefined;
hvac_mode_setting?: (...) | undefined;
method: "seam" | "external";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_no_longer_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
desired_temperature_celsius?: number;
desired_temperature_fahrenheit?: number;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_reached_set_point";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_changed";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
device_name: string;
event_id: string;
event_type: "device.name_changed";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
enrollment_automation_id: string;
event_id: string;
event_type: "enrollment_automation.deleted";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
device_custom_metadata?: { [x: string]: string
| boolean };
device_id: string;
event_id: string;
event_type: "phone.deactivated";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.device_membership_changed";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.created";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.deleted";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
)[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/events/list";
}
/instant_keys/delete
"/instant_keys/delete": {
commonParams: { instant_key_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/instant_keys/delete";
}
/instant_keys/get
"/instant_keys/get": {
commonParams: { instant_key_id?: string; instant_key_url?: string };
formData: {};
jsonBody: {};
jsonResponse: {
instant_key: {
client_session_id: string;
created_at: string;
customization?: {
logo_url?: string;
primary_color?: string;
secondary_color?: string;
};
customization_profile_id?: string;
expires_at: string;
instant_key_id: string;
instant_key_url: string;
user_identity_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/instant_keys/get";
}
/instant_keys/list
"/instant_keys/list": {
commonParams: { user_identity_id?: string };
formData: {};
jsonBody: {};
jsonResponse: {
instant_keys: {
client_session_id: string;
created_at: string;
customization?: {
logo_url?: string;
primary_color?: string;
secondary_color?: string;
};
customization_profile_id?: string;
expires_at: string;
instant_key_id: string;
instant_key_url: string;
user_identity_id: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/instant_keys/list";
}
/locks/get
"/locks/get": {
commonParams: { device_id?: string; name?: string };
formData: {};
jsonBody: {};
jsonResponse: {
device: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: (...) | (...);
appearance: { name: ... };
battery?: (...) | (...);
battery_level?: (...) | (...);
currently_triggering_noise_threshold_ids?: (...) | (...);
has_direct_power?: (...) | (...);
image_alt_text?: (...) | (...);
image_url?: (...) | (...);
manufacturer?: (...) | (...);
model: {
accessory_keypad_supported?: ...;
can_connect_accessory_keypad?: ...;
display_name: ...;
has_built_in_keypad?: ...;
manufacturer_display_name: ...;
offline_access_codes_supported?: ...;
online_access_codes_supported?: ...;
};
name: string;
noise_level_decibels?: (...)
| (...);
offline_access_codes_enabled?: (...) | (...);
online: boolean;
online_access_codes_enabled?: (...) | (...);
serial_number?: (...) | (...);
supports_accessory_keypad?: (...) | (...);
supports_offline_access_codes?: (...) | (...);
} & {
assa_abloy_credential_service_metadata?: (...)
| (...);
salto_space_credential_service_metadata?: (...) | (...);
} & {
akiles_metadata?: {
_member_group_id?: (...)
| (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: { encoder_name: string };
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
activation_enabled?: (...)
| (...);
device_name?: (...) | (...);
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...)
| (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...)
| (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: { device_name: string; ecobee_device_id: string };
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: { device_name: string; door_name: string };
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...)
| (...);
};
igloohome_metadata?: {
bridge_id?: (...)
| (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
is_keypad_linked_to_bridge?: (...) | (...);
keypad_id?: (...) | (...);
};
keynest_metadata?: {
address?: (...)
| (...);
current_or_last_store_id?: (...) | (...);
current_status?: (...) | (...);
current_user_company?: (...) | (...);
current_user_email?: (...) | (...);
current_user_name?: (...) | (...);
current_user_phone_number?: (...) | (...);
default_office_id?: (...) | (...);
device_name?: (...) | (...);
fob_id?: (...) | (...);
handover_method?: (...) | (...);
has_photo?: (...) | (...);
is_quadient_locker?: (...) | (...);
key_id?: (...) | (...);
key_notes?: (...) | (...);
keynest_app_user?: (...) | (...);
last_movement?: (...) | (...);
property_id?: (...) | (...);
property_postcode?: (...) | (...);
status_type?: (...) | (...);
subscription_plan?: (...) | (...);
};
korelock_metadata?: {
device_id?: (...)
| (...);
device_name?: (...) | (...);
firmware_version?: (...) | (...);
model_code?: (...) | (...);
serial_number?: (...) | (...);
wifi_signal_strength?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...)
| (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...)
| (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...)
| (...);
keypad_battery_critical?: (...) | (...);
keypad_paired?: (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
has_custom_pin_subscription?: (...)
| (...);
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...)
| (...);
};
schlage_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...)
| (...);
};
sensi_metadata?: {
device_id: string;
device_name: string;
product_type: string;
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...)
| (...);
model?: (...) | (...);
};
tado_metadata?: { device_type: string; serial_no: string };
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
wifi: ...;
};
has_gateway?: (...)
| (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: { device_id: number; device_name: string };
ultraloq_metadata?: {
device_id: string;
device_name: string;
device_type: string;
time_zone: (...) | (...);
};
visionline_metadata?: { encoder_id: string };
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: | (...)
| (...);
code_constraints?: (...) | (...);
door_open?: (...) | (...);
has_native_entry_events?: (...) | (...);
keypad_battery?: (...) | (...);
locked?: (...) | (...);
max_active_codes_supported?: (...) | (...);
supported_code_lengths?: (...) | (...);
supports_backup_access_code_pool?: (...) | (...);
} & {
active_thermostat_schedule?: (...)
| (...);
active_thermostat_schedule_id?: (...) | (...);
available_climate_preset_modes?: (...)[];
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
can_use_with_thermostat_daily_programs: ...;
climate_preset_key: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: (...) | (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
default_climate_setting?: {
can_delete?: (...)
| (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
fallback_climate_preset_key?: (...)
| (...);
fan_mode_setting?: (...) | (...) | (...);
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: (...) | (...);
max_unique_climate_presets_per_thermostat_weekly_program?: (...) | (...);
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: (...) | (...);
thermostat_daily_program_period_precision_minutes?: (...) | (...);
thermostat_daily_programs?: (...) | (...);
thermostat_weekly_program?: (...) | (...);
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
};
lock: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: (...) | (...);
appearance: { name: ... };
battery?: (...) | (...);
battery_level?: (...) | (...);
currently_triggering_noise_threshold_ids?: (...) | (...);
has_direct_power?: (...) | (...);
image_alt_text?: (...) | (...);
image_url?: (...) | (...);
manufacturer?: (...) | (...);
model: {
accessory_keypad_supported?: ...;
can_connect_accessory_keypad?: ...;
display_name: ...;
has_built_in_keypad?: ...;
manufacturer_display_name: ...;
offline_access_codes_supported?: ...;
online_access_codes_supported?: ...;
};
name: string;
noise_level_decibels?: (...)
| (...);
offline_access_codes_enabled?: (...) | (...);
online: boolean;
online_access_codes_enabled?: (...) | (...);
serial_number?: (...) | (...);
supports_accessory_keypad?: (...) | (...);
supports_offline_access_codes?: (...) | (...);
} & {
assa_abloy_credential_service_metadata?: (...)
| (...);
salto_space_credential_service_metadata?: (...) | (...);
} & {
akiles_metadata?: {
_member_group_id?: (...)
| (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: { encoder_name: string };
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
activation_enabled?: (...)
| (...);
device_name?: (...) | (...);
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...)
| (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...)
| (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: { device_name: string; ecobee_device_id: string };
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: { device_name: string; door_name: string };
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...)
| (...);
};
igloohome_metadata?: {
bridge_id?: (...)
| (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
is_keypad_linked_to_bridge?: (...) | (...);
keypad_id?: (...) | (...);
};
keynest_metadata?: {
address?: (...)
| (...);
current_or_last_store_id?: (...) | (...);
current_status?: (...) | (...);
current_user_company?: (...) | (...);
current_user_email?: (...) | (...);
current_user_name?: (...) | (...);
current_user_phone_number?: (...) | (...);
default_office_id?: (...) | (...);
device_name?: (...) | (...);
fob_id?: (...) | (...);
handover_method?: (...) | (...);
has_photo?: (...) | (...);
is_quadient_locker?: (...) | (...);
key_id?: (...) | (...);
key_notes?: (...) | (...);
keynest_app_user?: (...) | (...);
last_movement?: (...) | (...);
property_id?: (...) | (...);
property_postcode?: (...) | (...);
status_type?: (...) | (...);
subscription_plan?: (...) | (...);
};
korelock_metadata?: {
device_id?: (...)
| (...);
device_name?: (...) | (...);
firmware_version?: (...) | (...);
model_code?: (...) | (...);
serial_number?: (...) | (...);
wifi_signal_strength?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...)
| (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...)
| (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...)
| (...);
keypad_battery_critical?: (...) | (...);
keypad_paired?: (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
has_custom_pin_subscription?: (...)
| (...);
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...)
| (...);
};
schlage_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...)
| (...);
};
sensi_metadata?: {
device_id: string;
device_name: string;
product_type: string;
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...)
| (...);
model?: (...) | (...);
};
tado_metadata?: { device_type: string; serial_no: string };
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
wifi: ...;
};
has_gateway?: (...)
| (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: { device_id: number; device_name: string };
ultraloq_metadata?: {
device_id: string;
device_name: string;
device_type: string;
time_zone: (...) | (...);
};
visionline_metadata?: { encoder_id: string };
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: | (...)
| (...);
code_constraints?: (...) | (...);
door_open?: (...) | (...);
has_native_entry_events?: (...) | (...);
keypad_battery?: (...) | (...);
locked?: (...) | (...);
max_active_codes_supported?: (...) | (...);
supported_code_lengths?: (...) | (...);
supports_backup_access_code_pool?: (...) | (...);
} & {
active_thermostat_schedule?: (...)
| (...);
active_thermostat_schedule_id?: (...) | (...);
available_climate_preset_modes?: (...)[];
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
can_use_with_thermostat_daily_programs: ...;
climate_preset_key: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: (...) | (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
default_climate_setting?: {
can_delete?: (...)
| (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
fallback_climate_preset_key?: (...)
| (...);
fan_mode_setting?: (...) | (...) | (...);
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: (...) | (...);
max_unique_climate_presets_per_thermostat_weekly_program?: (...) | (...);
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: (...) | (...);
thermostat_daily_program_period_precision_minutes?: (...) | (...);
thermostat_daily_programs?: (...) | (...);
thermostat_weekly_program?: (...) | (...);
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/locks/get";
}
/locks/list
"/locks/list": {
commonParams: {
connect_webview_id?: string;
connected_account_id?: string;
connected_account_ids?: string[];
created_before?: Date;
custom_metadata_has?: { [x: string]: string | boolean };
customer_key?: string;
device_ids?: string[];
device_type?:
| "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock";
device_types?: (
| "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
)[];
exclude_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
include_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
limit?: number;
manufacturer?: | "akuvox"
| "august"
| "brivo"
| "butterflymx"
| "avigilon_alta"
| "doorking"
| "genie"
| "igloo"
| "linear"
| "lockly"
| "kwikset"
| "nuki"
| "salto"
| "schlage"
| "seam"
| "wyze"
| "yale"
| "two_n"
| "controlbyweb"
| "ttlock"
| "igloohome"
| "hubitat"
| "four_suites"
| "dormakaba_oracode"
| "tedee"
| "korelock"
| "akiles"
| "korelock"
| "kwikset2"
| "smartthings"
| "ultraloq";
page_cursor?: string | undefined
| null;
search?: string;
space_id?: string;
unstable_location_id?: string | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
locks: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/locks/list";
}
/locks/lock_door
"/locks/lock_door": {
commonParams: {};
formData: {};
jsonBody: { device_id: string; sync?: boolean };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/locks/lock_door";
}
/locks/simulate/keypad_code_entry
"/locks/simulate/keypad_code_entry": {
commonParams: {};
formData: {};
jsonBody: { code: string; device_id: string };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/locks/simulate/keypad_code_entry";
}
/locks/simulate/manual_lock_via_keypad
"/locks/simulate/manual_lock_via_keypad": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/locks/simulate/manual_lock_via_keypad";
}
/locks/unlock_door
"/locks/unlock_door": {
commonParams: {};
formData: {};
jsonBody: { device_id: string; sync?: boolean };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/locks/unlock_door";
}
/noise_sensors/list
"/noise_sensors/list": {
commonParams: {
connect_webview_id?: string;
connected_account_id?: string;
connected_account_ids?: string[];
created_before?: Date;
custom_metadata_has?: { [x: string]: string | boolean };
customer_key?: string;
device_ids?: string[];
device_type?: "noiseaware_activity_zone" | "minut_sensor";
device_types?: ("noiseaware_activity_zone" | "minut_sensor")[];
exclude_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
include_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
limit?: number;
manufacturer?: "minut"
| "noiseaware";
page_cursor?: string | undefined | null;
search?: string;
space_id?: string;
unstable_location_id?: string | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
noise_sensors: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/noise_sensors/list";
}
/noise_sensors/noise_thresholds/create
"/noise_sensors/noise_thresholds/create": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
ends_daily_at: string;
name?: string;
noise_threshold_decibels?: number;
noise_threshold_nrs?: number;
starts_daily_at: string;
sync?: boolean;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
noise_threshold: {
device_id: string;
ends_daily_at: string;
name: string;
noise_threshold_decibels: number;
noise_threshold_id: string;
noise_threshold_nrs?: number;
starts_daily_at: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/noise_sensors/noise_thresholds/create";
}
/noise_sensors/noise_thresholds/delete
"/noise_sensors/noise_thresholds/delete": {
commonParams: {};
formData: {};
jsonBody: { device_id: string; noise_threshold_id: string; sync?: boolean };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "DELETE"
| "POST";
queryParams: {};
route: "/noise_sensors/noise_thresholds/delete";
}
/noise_sensors/noise_thresholds/get
"/noise_sensors/noise_thresholds/get": {
commonParams: { noise_threshold_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
noise_threshold: {
device_id: string;
ends_daily_at: string;
name: string;
noise_threshold_decibels: number;
noise_threshold_id: string;
noise_threshold_nrs?: number;
starts_daily_at: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/noise_sensors/noise_thresholds/get";
}
/noise_sensors/noise_thresholds/list
"/noise_sensors/noise_thresholds/list": {
commonParams: { device_id: string; is_programmed?: boolean };
formData: {};
jsonBody: {};
jsonResponse: {
noise_thresholds: {
device_id: string;
ends_daily_at: string;
name: string;
noise_threshold_decibels: number;
noise_threshold_id: string;
noise_threshold_nrs?: number;
starts_daily_at: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/noise_sensors/noise_thresholds/list";
}
/noise_sensors/noise_thresholds/update
"/noise_sensors/noise_thresholds/update": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
ends_daily_at?: string;
name?: string;
noise_threshold_decibels?: number;
noise_threshold_id: string;
noise_threshold_nrs?: number;
starts_daily_at?: string;
sync?: boolean;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "PATCH"
| "POST"
| "PUT";
queryParams: {};
route: "/noise_sensors/noise_thresholds/update";
}
"/noise_sensors/simulate/trigger_noise_threshold": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/noise_sensors/simulate/trigger_noise_threshold";
}
/phones/deactivate
"/phones/deactivate": {
commonParams: {};
formData: {};
jsonBody: { device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/phones/deactivate";
}
/phones/get
"/phones/get": {
commonParams: { device_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
phone: {
created_at: string;
custom_metadata: { [x: string]: string | boolean };
device_id: string;
device_type: "ios_phone" | "android_phone";
display_name: string;
errors: { error_code: string; message: string }[];
nickname?: string;
properties: {
assa_abloy_credential_service_metadata?: {
endpoints: { endpoint_id: string; is_active: boolean }[];
has_active_endpoint: boolean;
};
salto_space_credential_service_metadata?: { has_active_phone: boolean };
};
warnings: { message: string; warning_code: string }[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/phones/get";
}
/phones/list
"/phones/list": {
commonParams: {
acs_credential_id?: string;
owner_user_identity_id?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
phones: {
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_type: "ios_phone" | "android_phone";
display_name: string;
errors: { error_code: string; message: string }[];
nickname?: string;
properties: {
assa_abloy_credential_service_metadata?: {
endpoints: { endpoint_id: string; is_active: boolean }[];
has_active_endpoint: boolean;
};
salto_space_credential_service_metadata?: { has_active_phone: boolean };
};
warnings: { message: string; warning_code: string }[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/phones/list";
}
/phones/simulate/create_sandbox_phone
"/phones/simulate/create_sandbox_phone": {
commonParams: {};
formData: {};
jsonBody: {
assa_abloy_metadata?: {
application_version?: string;
ble_capability?: boolean;
hce_capability?: boolean;
nfc_capability?: boolean;
seos_applet_version?: string;
seos_tsm_endpoint_id?: number;
};
custom_sdk_installation_id?: string;
phone_metadata?: {
device_manufacturer?: string;
device_model?: string;
operating_system?: "android"
| "ios";
os_version?: string;
};
user_identity_id: string;
};
jsonResponse: {
phone: {
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_type: "ios_phone" | "android_phone";
display_name: string;
errors: { error_code: string; message: string }[];
nickname?: string;
properties: {
assa_abloy_credential_service_metadata?: {
endpoints: { endpoint_id: string; is_active: boolean }[];
has_active_endpoint: boolean;
};
salto_space_credential_service_metadata?: { has_active_phone: boolean };
};
warnings: { message: string; warning_code: string }[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/phones/simulate/create_sandbox_phone";
}
/seam/bridge/v1/bridge_client_sessions/create
"/seam/bridge/v1/bridge_client_sessions/create": {
commonParams: {};
formData: {};
jsonBody: {
bridge_client_machine_identifier_key: string;
bridge_client_name: string;
bridge_client_time_zone: string;
};
jsonResponse: {
bridge_client_session: {
bridge_client_machine_identifier_key: string;
bridge_client_name: string;
bridge_client_session_id: string;
bridge_client_session_token: string;
bridge_client_time_zone: string;
created_at: string;
errors: (
| {
can_tailscale_proxy_reach_bridge: boolean
| null;
can_tailscale_proxy_reach_tailscale_network: boolean | null;
created_at: string;
error_code: "bridge_lan_unreachable";
is_bridge_socks_server_healthy: boolean | null;
is_tailscale_proxy_reachable: boolean | null;
is_tailscale_proxy_socks_server_healthy: boolean | null;
message: string;
}
| {
created_at: string;
error_code: "no_communication_from_bridge";
message: string;
}
)[];
pairing_code: string;
pairing_code_expires_at: string;
tailscale_auth_key: string
| null;
tailscale_hostname: string;
telemetry_token: string | null;
telemetry_token_expires_at: string | null;
telemetry_url: string | null;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/bridge/v1/bridge_client_sessions/create";
}
/seam/bridge/v1/bridge_client_sessions/get
"/seam/bridge/v1/bridge_client_sessions/get": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
bridge_client_session: {
bridge_client_machine_identifier_key: string;
bridge_client_name: string;
bridge_client_session_id: string;
bridge_client_session_token: string;
bridge_client_time_zone: string;
created_at: string;
errors: (
| {
can_tailscale_proxy_reach_bridge: boolean
| null;
can_tailscale_proxy_reach_tailscale_network: boolean | null;
created_at: string;
error_code: "bridge_lan_unreachable";
is_bridge_socks_server_healthy: boolean | null;
is_tailscale_proxy_reachable: boolean | null;
is_tailscale_proxy_socks_server_healthy: boolean | null;
message: string;
}
| {
created_at: string;
error_code: "no_communication_from_bridge";
message: string;
}
)[];
pairing_code: string;
pairing_code_expires_at: string;
tailscale_auth_key: string
| null;
tailscale_hostname: string;
telemetry_token: string | null;
telemetry_token_expires_at: string | null;
telemetry_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/bridge/v1/bridge_client_sessions/get";
}
/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token
"/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
bridge_client_session: {
bridge_client_machine_identifier_key: string;
bridge_client_name: string;
bridge_client_session_id: string;
bridge_client_session_token: string;
bridge_client_time_zone: string;
created_at: string;
errors: (
| {
can_tailscale_proxy_reach_bridge: boolean
| null;
can_tailscale_proxy_reach_tailscale_network: boolean | null;
created_at: string;
error_code: "bridge_lan_unreachable";
is_bridge_socks_server_healthy: boolean | null;
is_tailscale_proxy_reachable: boolean | null;
is_tailscale_proxy_socks_server_healthy: boolean | null;
message: string;
}
| {
created_at: string;
error_code: "no_communication_from_bridge";
message: string;
}
)[];
pairing_code: string;
pairing_code_expires_at: string;
tailscale_auth_key: string
| null;
tailscale_hostname: string;
telemetry_token: string | null;
telemetry_token_expires_at: string | null;
telemetry_url: string | null;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token";
}
/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code
"/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
bridge_client_session: {
bridge_client_machine_identifier_key: string;
bridge_client_name: string;
bridge_client_session_id: string;
bridge_client_session_token: string;
bridge_client_time_zone: string;
created_at: string;
errors: (
| {
can_tailscale_proxy_reach_bridge: boolean
| null;
can_tailscale_proxy_reach_tailscale_network: boolean | null;
created_at: string;
error_code: "bridge_lan_unreachable";
is_bridge_socks_server_healthy: boolean | null;
is_tailscale_proxy_reachable: boolean | null;
is_tailscale_proxy_socks_server_healthy: boolean | null;
message: string;
}
| {
created_at: string;
error_code: "no_communication_from_bridge";
message: string;
}
)[];
pairing_code: string;
pairing_code_expires_at: string;
tailscale_auth_key: string
| null;
tailscale_hostname: string;
telemetry_token: string | null;
telemetry_token_expires_at: string | null;
telemetry_url: string | null;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code";
}
/seam/bridge/v1/bridge_client_sessions/report_status
"/seam/bridge/v1/bridge_client_sessions/report_status": {
commonParams: {};
formData: {};
jsonBody: {
is_tailscale_connected: boolean | null;
tailscale_ip_v4: string | null;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/bridge/v1/bridge_client_sessions/report_status";
}
/seam/bridge/v1/bridge_connected_systems/list
"/seam/bridge/v1/bridge_connected_systems/list": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
bridge_connected_systems: {
acs_system_display_name: string;
acs_system_id: string;
bridge_created_at: string;
bridge_id: string;
connected_account_created_at: string;
connected_account_id: string;
workspace_display_name: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/bridge/v1/bridge_connected_systems/list";
}
/seam/console/v1/get_resource_locator
"/seam/console/v1/get_resource_locator": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
resource_locator: {
acs_system_id?: string;
device_id?: string;
resource_type: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: { uuid: string };
route: "/seam/console/v1/get_resource_locator";
}
/seam/console/v1/timelines/get
"/seam/console/v1/timelines/get": {
commonParams: {
created_before?: Date;
limit?: number;
page_cursor?: string;
resource_id: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
timeline: {
groups: {
context: | {
context_type: "request";
request_id: string;
request_payload: { [x: string]: any };
response_payload: { [x: string]: any };
}
| { context_type: "job"; job_id: string };
created_at: string;
entries: {
body:
| { description: string; entry_type: "resource_created" }
| {
description: string;
entry_type: "resource_updated";
errors?: (...) | (...);
properties_updated?: (...) | (...);
warnings?: (...) | (...);
}
| { description: string; entry_type: "resource_deleted" }
| { entry_type: "event"; event_id: string; event_type: string }
| {
description: string;
entry_type: "provider_call";
response_body?: (...) | (...);
response_status_code: number;
};
created_at: string;
entry_type: string;
resource_id: string;
resource_type: string;
}[];
}[];
resource_id: string;
resource_type: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/console/v1/timelines/get";
}
/seam/customer/v1/access_grants/list
"/seam/customer/v1/access_grants/list": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
access_grants: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string | null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/access_grants/list";
}
/seam/customer/v1/automation_runs/list
"/seam/customer/v1/automation_runs/list": {
commonParams: {
automation_id?: string;
created_before?: Date;
limit?: number;
page_cursor?: string | undefined | null;
partner_resource_id?: string;
rule?:
| "reservation_created"
| "reservation_time_updated"
| "reservation_deleted"
| "space_name_updated";
success?: boolean;
};
formData: {};
jsonBody: {};
jsonResponse: {
automation_runs: {
automation_id: string
| null;
automation_result?: {
actions: {
access_grant_id: string;
action_type: "create" | "update" | "delete";
resource_type: string;
}[];
error?: string;
rule: | "reservation_created"
| "reservation_time_updated"
| "reservation_deleted";
success: boolean;
};
automation_run_id: string;
created_at: string;
partner_key: string
| null;
partner_resource_id: string | null;
resource_type: string | null;
resource_type_alias: string | null;
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/automation_runs/list";
}
/seam/customer/v1/automations/delete
"/seam/customer/v1/automations/delete": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/seam/customer/v1/automations/delete";
}
/seam/customer/v1/automations/get
"/seam/customer/v1/automations/get": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
access_rules?: {
reservation_created?: {
config: {
access_methods: ((...) | (...) | (...))[];
method_issuance_strategy:
| "first_available"
| "first_two_available"
| "all_available";
};
rule: "reservation_created";
};
reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
reservation_spaces_updated?: {
config?: {};
rule: "reservation_spaces_updated";
};
reservation_time_updated?: {
config?: {};
rule: "reservation_time_updated";
};
space_name_updated?: { config?: {}; rule: "space_name_updated" };
staff_member_created?: { config: {}; rule: "staff_member_created" };
staff_member_name_updated?: {
config?: {};
rule: "staff_member_name_updated";
};
user_identity_name_updated?: {
config?: {};
rule: "user_identity_name_updated";
};
};
climate_rules?: {
rules: {
reservation_created?: {
automated_occupied_preset?: {
cooling_set_point_celsius?: (...)
| (...);
cooling_set_point_fahrenheit?: (...) | (...);
fan_mode: (...) | (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
is_override_allowed: boolean;
max_override_period_minutes: number;
mode: (...) | (...) | (...);
};
automated_unoccupied_preset?: {
cooling_set_point_celsius?: (...)
| (...);
cooling_set_point_fahrenheit?: (...) | (...);
fan_mode: (...) | (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
is_override_allowed: boolean;
max_override_period_minutes: number;
mode: (...) | (...) | (...);
};
occupied_preset_key?: string;
precondition_minutes_before_reservation?: number;
unoccupied_preset_key?: string;
};
reservation_deleted?: {};
reservation_time_updated?: {};
};
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/automations/get";
}
/seam/customer/v1/automations/update
"/seam/customer/v1/automations/update": {
commonParams: {};
formData: {};
jsonBody: {
access_rules?: {
reservation_created?: {
config: {
access_methods: ((...) | (...) | (...))[];
method_issuance_strategy:
| "first_available"
| "first_two_available"
| "all_available";
};
rule: "reservation_created";
};
reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
reservation_spaces_updated?: {
config?: {};
rule: "reservation_spaces_updated";
};
reservation_time_updated?: {
config?: {};
rule: "reservation_time_updated";
};
space_name_updated?: { config?: {}; rule: "space_name_updated" };
staff_member_created?: { config: {}; rule: "staff_member_created" };
staff_member_name_updated?: {
config?: {};
rule: "staff_member_name_updated";
};
user_identity_name_updated?: {
config?: {};
rule: "user_identity_name_updated";
};
};
climate_rules?: {
rules?: {
reservation_created?: {
automated_occupied_preset?: {
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
fan_mode: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
is_override_allowed: ...;
max_override_period_minutes: ...;
mode: ...;
};
automated_unoccupied_preset?: {
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
fan_mode: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
is_override_allowed: ...;
max_override_period_minutes: ...;
mode: ...;
};
occupied_preset_key?: string;
precondition_minutes_before_reservation?: number;
unoccupied_preset_key?: string;
};
reservation_deleted?: {};
reservation_time_updated?: {};
};
};
};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/seam/customer/v1/automations/update";
}
/seam/customer/v1/connector_customers/list
"/seam/customer/v1/connector_customers/list": {
commonParams: { connector_id?: string };
formData: {};
jsonBody: {};
jsonResponse: {
connector_customers: {
connector_customer_id: string;
connector_id: string;
created_at: string;
customer_key: string;
initial_sync_completed: boolean;
initial_sync_status: string | null;
instance_config: { [x: string]: any } | null;
status: string | null;
updated_at: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/connector_customers/list";
}
/seam/customer/v1/connectors/authorize
"/seam/customer/v1/connectors/authorize": {
commonParams: { connector_name?: string; slug: string };
formData: {};
jsonBody: {};
jsonResponse: {
connector_authorize: { authorize_url: string; connector_type: string };
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/connectors/authorize";
}
/seam/customer/v1/connectors/connector_types
"/seam/customer/v1/connectors/connector_types": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
connector_types: {
connector_type: string;
description?: string;
display_name: string;
editable_fields: {
description: string;
display_name: string;
name: string;
required: boolean;
type: "string" | "string[]" | "number" | "boolean";
}[];
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/connectors/connector_types";
}
/seam/customer/v1/connectors/create
"/seam/customer/v1/connectors/create": {
commonParams: {};
formData: {};
jsonBody: {
config: { [x: string]: unknown };
connector_type: "mock" | "mews" | "rms" | "cloudbeds" | "smoobu" | "zonal";
customer_key?: string;
};
jsonResponse: {
connector: {
connector_id: string;
connector_type: string;
error?: string;
status: "active"
| "inactive"
| "error";
webhook_subscription?: {
events: string[];
status: "active" | "inactive" | "error";
subscription_id: string;
webhook_url: string;
};
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/customer/v1/connectors/create";
}
/seam/customer/v1/connectors/delete
"/seam/customer/v1/connectors/delete": {
commonParams: {};
formData: {};
jsonBody: {
connector_customer_id?: string;
connector_id: string;
customer_id?: string;
customer_key?: string;
unique_provider_resource_key?: string;
};
jsonResponse: {
connector: {
connector_id: string;
connector_type: string;
status: "deleted";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/customer/v1/connectors/delete";
}
/seam/customer/v1/connectors/list
"/seam/customer/v1/connectors/list": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
connectors: {
config: { [x: string]: any };
connector_id: string;
connector_type: string;
created_at: string;
status: "active" | "inactive" | "error";
updated_at: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/connectors/list";
}
"/seam/customer/v1/connectors/sync": {
commonParams: {
connector_customer_id?: string | null;
connector_id: string;
connector_type: string;
customer_key: string;
unique_provider_resource_key?: string | null;
};
formData: {};
jsonBody: {};
jsonResponse: { connector_sync: { message: string; status: string } };
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/customer/v1/connectors/sync";
}
/seam/customer/v1/connectors/update
"/seam/customer/v1/connectors/update": {
commonParams: {};
formData: {};
jsonBody: {
config:
| {}
| {
access_token?: string;
client?: string;
client_token?: string;
enterprise_id?: string;
enterprise_ids?: string[];
is_demo?: boolean;
}
| {
auth_token?: string;
client_id: string;
client_password: string;
property_id?: string
| number;
}
| { access_token?: string; property_id?: string; refresh_token?: string }
| { api_key: string; base_api_url?: string }
| {
api_key: string;
auth_token?: string;
hotel_id: string;
id: string;
is_staging?: boolean;
secret: string;
};
connector_id: string;
customer_key?: string;
};
jsonResponse: {
connector: {
connector_id: string;
connector_type: string;
error?: string;
status: "active"
| "inactive"
| "error";
webhook_subscription?: {
events: string[];
status: "active" | "inactive" | "error";
subscription_id: string;
webhook_url: string;
};
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/customer/v1/connectors/update";
}
/seam/customer/v1/customers/list
"/seam/customer/v1/customers/list": {
commonParams: {
limit?: number;
page_cursor?: string | undefined | null;
};
formData: {};
jsonBody: {};
jsonResponse: {
customers: {
created_at: string;
customer_key: string;
workspace_id: string;
}[];
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/customers/list";
}
/seam/customer/v1/customers/open_portal
"/seam/customer/v1/customers/open_portal": {
commonParams: { customer_key: string };
formData: {};
jsonBody: {};
jsonResponse: {
magic_link: {
created_at: string;
customer_key: string;
expires_at: string;
url: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/customer/v1/customers/open_portal";
}
/seam/customer/v1/events/list
"/seam/customer/v1/events/list": {
commonParams: {
between?: (string | Date)[];
event_type?:
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "access_grant.created"
| "access_grant.deleted"
| "access_grant.access_granted_to_all_doors"
| "access_grant.access_granted_to_door"
| "access_grant.access_to_door_lost"
| "access_grant.access_times_changed"
| "access_grant.could_not_create_requested_access_methods"
| "access_method.issued"
| "access_method.revoked"
| "access_method.card_encoding_required"
| "access_method.deleted"
| "access_method.reissued"
| "acs_system.connected"
| "acs_system.added"
| "acs_system.disconnected"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_credential.reissued"
| "acs_credential.invalidated"
| "acs_user.created"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "acs_access_group.deleted"
| "acs_entrance.added"
| "acs_entrance.removed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "connected_account.reauthorization_requested"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "thermostat.temperature_reached_set_point"
| "thermostat.temperature_changed"
| "device.name_changed"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "space.device_membership_changed"
| "space.created"
| "space.deleted";
event_types?: (
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "access_grant.created"
| "access_grant.deleted"
| "access_grant.access_granted_to_all_doors"
| "access_grant.access_granted_to_door"
| "access_grant.access_to_door_lost"
| "access_grant.access_times_changed"
| "access_grant.could_not_create_requested_access_methods"
| "access_method.issued"
| "access_method.revoked"
| "access_method.card_encoding_required"
| "access_method.deleted"
| "access_method.reissued"
| "acs_system.connected"
| "acs_system.added"
| "acs_system.disconnected"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_credential.reissued"
| "acs_credential.invalidated"
| "acs_user.created"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "acs_access_group.deleted"
| "acs_entrance.added"
| "acs_entrance.removed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "connected_account.reauthorization_requested"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "thermostat.temperature_reached_set_point"
| "thermostat.temperature_changed"
| "device.name_changed"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "space.device_membership_changed"
| "space.created"
| "space.deleted"
)[];
limit?: number;
since?: string;
space_id: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
events: (
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.changed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.scheduled_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.removed_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_setting_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string
| null;
connected_account_custom_metadata?: { [x: string]: string | boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_removing_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_remove_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.modified_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.deleted_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
backup_access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.backup_access_code_pulled";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.failed_to_convert_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.removed";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.created";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_all_doors";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_door";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_to_door_lost";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
access_grant_key?: string;
created_at: string;
ends_at?: string;
event_id: string;
event_type: "access_grant.access_times_changed";
occurred_at: string;
starts_at?: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
error_message: string;
event_id: string;
event_type: "access_grant.could_not_create_requested_access_methods";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.issued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.revoked";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.card_encoding_required";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: string[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.reissued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.connected";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.issued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.reissued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.invalidated";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.created";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.removed";
occurred_at: string;
workspace_id: string;
}
| {
acs_access_group_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_access_group.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.removed";
occurred_at: string;
workspace_id: string;
}
| {
client_session_id: string;
created_at: string;
event_id: string;
event_type: "client_session.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.connected";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.created";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.successful_login";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_errors: (
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
salto_ks_metadata: ...;
}
)[];
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
connected_account_type?: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync_after_reconnection";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.reauthorization_requested";
occurred_at: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connect_webview.login_succeeded";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
created_at: string;
event_id: string;
event_type: "connect_webview.login_failed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.added";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.converted_to_unmanaged";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.unmanaged.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.unmanaged.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.tampered";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.low_battery";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
battery_status: "critical"
| "low"
| "good"
| "full";
connected_account_custom_metadata?: { [x: string]: string | boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.battery_status_changed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.removed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_no_longer_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_activated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_deactivated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connection_became_flaky";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.connection_stabilized";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required.resolved";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "noise_sensor.noise_threshold_triggered";
minut_metadata?: { [x: string]: unknown };
noise_level_decibels?: number;
noise_level_nrs?: number;
noise_threshold_id?: string;
noise_threshold_name?: string;
noiseaware_metadata?: { [x: string]: unknown };
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "lock.locked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
acs_entrance_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id?: string;
event_id: string;
event_type: "lock.unlocked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
user_identity_id?: string;
workspace_id: string;
}
| {
access_code_id?: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "lock.access_denied";
occurred_at: string;
workspace_id: string;
}
| {
climate_preset_key: string;
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.climate_preset_activated";
is_fallback_climate_preset: boolean;
occurred_at: string;
thermostat_schedule_id: string | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
cooling_set_point_celsius?: number | undefined;
cooling_set_point_fahrenheit?: number | undefined;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.manually_adjusted";
fan_mode_setting?: (...) | undefined;
heating_set_point_celsius?: number | undefined;
heating_set_point_fahrenheit?: number | undefined;
hvac_mode_setting?: (...) | undefined;
method: "seam" | "external";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_no_longer_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
desired_temperature_celsius?: number;
desired_temperature_fahrenheit?: number;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_reached_set_point";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_changed";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: string]: string
| boolean };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: string]: string | boolean };
device_id: string;
device_name: string;
event_id: string;
event_type: "device.name_changed";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
enrollment_automation_id: string;
event_id: string;
event_type: "enrollment_automation.deleted";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
device_custom_metadata?: { [x: string]: string
| boolean };
device_id: string;
event_id: string;
event_type: "phone.deactivated";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.device_membership_changed";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.created";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.deleted";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
)[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/events/list";
}
/seam/customer/v1/portals/get
"/seam/customer/v1/portals/get": {
commonParams: { customer_portal_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
customer_portal: {
business_vertical?:
| "short_term_rental"
| "hospitality"
| "multi_family"
| "gym_management"
| "property_tours";
customization_profile_id?: string;
features?: {
configure?: {
allow_access_automation_rule_customization?: boolean;
allow_climate_automation_rule_customization?: boolean;
allow_instant_key_customization?: boolean;
exclude?: boolean;
};
connect?: {
accepted_providers?: string[];
exclude?: boolean;
excluded_providers?: string[];
};
manage?: {
exclude?: boolean;
exclude_reservation_management?: boolean;
exclude_staff_management?: boolean;
};
manage_devices?: { exclude?: boolean };
organize?: { exclude?: boolean };
};
is_embedded?: boolean;
landing_page?: {
manage?: | | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...) | (...) | (...);
};
locale?: "en-US"
| "pt-PT"
| "fr-FR"
| "it-IT"
| "es-ES";
property_listing_filter?: { [x: string]: string | boolean };
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/portals/get";
}
/seam/customer/v1/reservations/get
"/seam/customer/v1/reservations/get": {
commonParams: { reservation_id?: string; reservation_key?: string };
formData: {};
jsonBody: {};
jsonResponse: {
reservation: {
access_methods: {
access_method_id: string;
code?: string | null;
instant_key_url?: string;
is_card_encoding_required?: boolean;
is_issued: boolean;
mode: string;
}[];
created_at: string;
ends_at: string
| null;
guest_name: string | null;
name: string | null;
reservation_id: string;
reservation_key: string;
spaces: {
name: string | null;
space_id: string | null;
space_key: string;
}[];
starts_at: string
| null;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/reservations/get";
}
/seam/customer/v1/reservations/list
"/seam/customer/v1/reservations/list": {
commonParams: {
created_before?: Date;
limit?: number;
page_cursor?: string | undefined | null;
search?: string;
space_id?: string;
space_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
reservations: {
access_methods: {
access_method_id: string;
is_issued: boolean;
mode: string;
}[];
created_at: string;
ends_at: string
| null;
guest_name: string | null;
name: string | null;
reservation_id: string;
reservation_key: string;
spaces: {
name: string | null;
space_id: string | null;
space_key: string;
}[];
starts_at: string
| null;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/reservations/list";
}
/seam/customer/v1/settings/get
"/seam/customer/v1/settings/get": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
business_vertical?:
| "short_term_rental"
| "hospitality"
| "multi_family"
| "gym_management"
| "property_tours";
slug?: string
| null;
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/settings/get";
}
/seam/customer/v1/settings/update
"/seam/customer/v1/settings/update": {
commonParams: {};
formData: {};
jsonBody: {
business_vertical?:
| "short_term_rental"
| "hospitality"
| "multi_family"
| "gym_management"
| "property_tours";
slug?: string
| null;
};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/seam/customer/v1/settings/update";
}
/seam/customer/v1/spaces/create
"/seam/customer/v1/spaces/create": {
commonParams: {};
formData: {};
jsonBody: {
acs_entrance_ids?: string[];
device_ids?: string[];
name: string;
parent_space_key?: string;
parent_space_name?: string;
space_key?: string;
};
jsonResponse: {
space: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/customer/v1/spaces/create";
}
/seam/customer/v1/spaces/list
"/seam/customer/v1/spaces/list": {
commonParams: {
connected_account_id?: string;
search?: string;
space_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
spaces: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/spaces/list";
}
/seam/customer/v1/spaces/list_reservations
"/seam/customer/v1/spaces/list_reservations": {
commonParams: {
issued_status?: "issued" | "pending";
space_key: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
reservations: {
access_methods: {
access_method_id: string;
is_issued: boolean;
mode: string;
}[];
created_at: string;
ends_at: string
| null;
guest_name: string | null;
has_issued_access: boolean;
name: string | null;
reservation_id: string;
reservation_key: string;
starts_at: string | null;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/spaces/list_reservations";
}
/seam/customer/v1/staff_members/get
"/seam/customer/v1/staff_members/get": {
commonParams: { staff_member_key: string };
formData: {};
jsonBody: {};
jsonResponse: {
access_grant: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string | null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
};
spaces: { child_space_keys?: string[]; space_key: string }[];
staff_member: {
email_address?: string;
name: string;
phone_number?: string;
space_keys?: string[];
staff_member_key: string;
user_identity_id?: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/staff_members/get";
}
/seam/customer/v1/staff_members/list
"/seam/customer/v1/staff_members/list": {
commonParams: {
created_before?: Date;
limit?: number;
page_cursor?: string | undefined | null;
space_id?: string;
space_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
staff_members: {
email_address?: string;
name: string;
phone_number?: string;
space_keys?: string[];
staff_member_key: string;
user_identity_id?: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/customer/v1/staff_members/list";
}
/seam/instant_key/v1/client_sessions/exchange_short_code
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
commonParams: {};
formData: {};
jsonBody: { short_code: string };
jsonResponse: {
client_session: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string | null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/instant_key/v1/client_sessions/exchange_short_code";
}
/seam/instant_key/v1/preview/get
"/seam/instant_key/v1/preview/get": {
commonParams: {};
formData: {};
jsonBody: { instant_key_url: string };
jsonResponse: {
instant_key_preview: {
access: {
available: boolean;
hours?: string;
icon: string;
location?: string;
name: string;
}[];
created_at: string;
expires_at: string;
guest: {
check_in_date: string;
check_out_date: string;
email: string;
first_name: string;
full_name: string;
last_name: string;
};
hotel: {
accent_color: string;
hotel_name: string;
logo_url?: string;
primary_color: string;
secondary_color: string;
verified: boolean;
};
key_status: "ready"
| "expired"
| "used";
room: { floor: number; room_number: string; room_type: string };
shortcode: string;
support_email: string;
support_phone: string;
updated_at: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/instant_key/v1/preview/get";
}
/seam/mobile_sdk/v1/acs/credentials/list
"/seam/mobile_sdk/v1/acs/credentials/list": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
acs_credentials: {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: string[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: string[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: string[];
credential_id?: string;
guest_acs_entrance_ids?: string[];
is_valid?: boolean;
joiner_acs_credential_ids?: string[];
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "waiting_to_be_issued";
}
| {
created_at: string;
message: string;
warning_code: "schedule_externally_modified";
}
| {
created_at: string;
message: string;
warning_code: "schedule_modified";
}
| { created_at: string; message: string; warning_code: "being_deleted" }
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_credential";
}
| {
created_at: string;
message: string;
warning_code: "needs_to_be_reissued";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/mobile_sdk/v1/acs/credentials/list";
}
/seam/mobile_sdk/v1/phone_sessions/get_or_create
"/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
commonParams: {};
formData: {};
jsonBody: {
custom_sdk_installation_id: string;
phone_device_metadata?: {
manufacturer?: string;
model?: string;
os_version?: string;
};
phone_os: "ios"
| "android";
};
jsonResponse: {
phone_session: {
is_sandbox_workspace: boolean;
provider_sessions: {
acs_credentials: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string | null;
acs_credential_pool_id?: string;
acs_entrances: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: (...) | (...);
can_belong_to_reservation?: (...) | (...);
can_unlock_with_card?: (...) | (...);
can_unlock_with_code?: (...) | (...);
can_unlock_with_mobile_key?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: (...) | (...);
dormakaba_community_metadata?: (...) | (...);
errors: (...)[];
hotek_metadata?: (...) | (...);
latch_metadata?: (...) | (...);
salto_ks_metadata?: (...) | (...);
salto_space_metadata?: (...) | (...);
space_ids: (...)[];
visionline_metadata?: (...) | (...);
}[];
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;
code?: (...) | (...) | null;
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: string;
errors: { error_code: string; message: string }[];
external_type?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: (...) | (...) | null;
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: 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;
}[];
phone_registration: {
is_being_activated: boolean;
phone_registration_id: string;
provider_name: string
| null;
provider_state?: any;
};
}[];
user_identity: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string
| null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
user_identity_key: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "acs_user_profile_does_not_match_user_identity";
}
)[];
workspace_id: string;
};
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/mobile_sdk/v1/phone_sessions/get_or_create";
}
/seam/mobile_sdk/v1/report_salto_space_audit_trail
"/seam/mobile_sdk/v1/report_salto_space_audit_trail": {
commonParams: {};
formData: {};
jsonBody: {
acs_system_id: string;
salto_space_metadata: { justin_mobile_sdk_audit_trail_data: string };
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/mobile_sdk/v1/report_salto_space_audit_trail";
}
/seam/partner/v1/building_blocks/spaces/auto_map
"/seam/partner/v1/building_blocks/spaces/auto_map": {
commonParams: { collection_key?: string };
formData: {};
jsonBody: {};
jsonResponse: {
spaces: {
acs_entrances: {
acs_entrance_id: string;
connected_account_id: string;
name: string;
}[];
devices: {
connected_account_id: string;
device_id: string;
device_type: string;
name: string;
}[];
is_common_area?: boolean;
is_draft?: boolean;
name: string;
needs_review?: boolean;
parent_partner_resource_key?: string;
partner_resource_key: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/seam/partner/v1/building_blocks/spaces/auto_map";
}
/seam/v1/customers/push_data
"/seam/v1/customers/push_data": {
commonParams: {
access_grants?: {
access_grant_key: string;
building_keys?: string[];
common_area_keys?: string[];
ends_at?: string;
facility_keys?: string[];
guest_key?: string;
listing_keys?: string[];
name?: string;
preferred_code?: string;
property_keys?: string[];
resident_key?: string;
room_keys?: string[];
space_keys?: string[];
starts_at?: string;
tenant_key?: string;
unit_keys?: string[];
user_identity_key?: string;
user_key?: string;
}[];
bookings?: {
booking_key: string;
building_keys?: string[];
common_area_keys?: string[];
ends_at?: string;
facility_keys?: string[];
guest_key?: string;
listing_keys?: string[];
name?: string;
preferred_code?: string;
property_keys?: string[];
resident_key?: string;
room_keys?: string[];
space_keys?: string[];
starts_at?: string;
tenant_key?: string;
unit_keys?: string[];
user_identity_key?: string;
user_key?: string;
}[];
buildings?: { building_key: string; name: string }[];
common_areas?: {
common_area_key: string;
name: string;
parent_site_key?: string;
}[];
facilities?: { facility_key: string; name: string }[];
guests?: {
email_address?: string;
guest_key: string;
name: string;
phone_number?: string;
}[];
listings?: { listing_key: string; name: string }[];
properties?: { name: string; property_key: string }[];
property_listings?: {
custom_metadata?: { [x: string]: null | string | boolean };
name: string;
property_listing_key: string;
}[];
reservations?: {
building_keys?: string[];
common_area_keys?: string[];
ends_at?: string;
facility_keys?: string[];
guest_key?: string;
listing_keys?: string[];
name?: string;
preferred_code?: string;
property_keys?: string[];
reservation_key: string;
resident_key?: string;
room_keys?: string[];
space_keys?: string[];
starts_at?: string;
tenant_key?: string;
unit_keys?: string[];
user_identity_key?: string;
user_key?: string;
}[];
residents?: {
email_address?: string;
name: string;
phone_number?: string;
resident_key: string;
}[];
rooms?: { name: string; parent_site_key?: string; room_key: string }[];
sites?: { name: string; site_key: string }[];
spaces?: { name: string; space_key: string }[];
staff_members?: {
building_keys?: string[];
common_area_keys?: string[];
email_address?: string;
facility_keys?: string[];
listing_keys?: string[];
name: string;
phone_number?: string;
property_keys?: string[];
property_listing_keys?: string[];
room_keys?: string[];
site_keys?: string[];
space_keys?: string[];
staff_member_key: string;
unit_keys?: string[];
}[];
tenants?: {
email_address?: string;
name: string;
phone_number?: string;
tenant_key: string;
}[];
units?: { name: string; parent_site_key?: string; unit_key: string }[];
user_identities?: {
email_address?: string;
name: string;
phone_number?: string;
user_identity_key: string;
}[];
users?: {
email_address?: string;
name: string;
phone_number?: string;
user_key: string;
}[];
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/seam/v1/customers/push_data";
}
/spaces/add_acs_entrances
"/spaces/add_acs_entrances": {
commonParams: {};
formData: {};
jsonBody: { acs_entrance_ids: string[]; space_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST" | "PUT";
queryParams: {};
route: "/spaces/add_acs_entrances";
}
/spaces/add_devices
"/spaces/add_devices": {
commonParams: {};
formData: {};
jsonBody: { device_ids: string[]; space_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST" | "PUT";
queryParams: {};
route: "/spaces/add_devices";
}
/spaces/create
"/spaces/create": {
commonParams: {};
formData: {};
jsonBody: {
acs_entrance_ids?: string[];
customer_key?: string;
device_ids?: string[];
name: string;
space_key?: string;
};
jsonResponse: {
space: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/spaces/create";
}
/spaces/delete
"/spaces/delete": {
commonParams: {};
formData: {};
jsonBody: { space_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/spaces/delete";
}
/spaces/get
"/spaces/get": {
commonParams: { space_id: string } | { space_key: string };
formData: {};
jsonBody: {};
jsonResponse: {
space: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/spaces/get";
}
"/spaces/get_related": {
commonParams: {
exclude?: (
| "spaces"
| "devices"
| "acs_entrances"
| "connected_accounts"
| "acs_systems"
)[];
include?: (
| "spaces"
| "devices"
| "acs_entrances"
| "connected_accounts"
| "acs_systems"
)[];
space_ids?: string[];
space_keys?: string[];
};
formData: {};
jsonBody: {};
jsonResponse: {
batch: {
acs_entrances?: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor"
| "EntranceDoor"
| "GuestDoor"
| "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: (...)[];
};
}[];
acs_systems?: {
acs_access_group_count?: number;
acs_system_id: string;
acs_user_count?: number;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: string
| null;
errors: (
| { created_at: ...; error_code: ...; message: ... }
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
message: ...;
}
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
)[];
external_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: { time_zone: string
| null };
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| {
created_at: ...;
message: ...;
misconfigured_acs_entrance_ids?: ...;
warning_code: ...;
}
)[];
workspace_id: string;
}[];
connected_accounts?: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
account_type?: string;
account_type_display_name: string;
automatically_manage_new_devices: boolean;
connected_account_id: string;
created_at?: string;
custom_metadata: { [x: string]: string | boolean };
customer_key?: string;
display_name: string;
errors: (
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
salto_ks_metadata: ...;
}
)[];
image_url?: string;
user_identifier?: {
api_url?: string;
email?: string;
exclusive?: boolean;
phone?: string;
username?: string;
};
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
| {
created_at: ...;
message: ...;
salto_ks_metadata: ...;
warning_code: ...;
}
| { created_at: ...; message: ...; warning_code: ... }
)[];
}[];
devices?: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: (...) & {
akiles_metadata?: ...;
assa_abloy_vostio_metadata?: ...;
august_metadata?: ...;
avigilon_alta_metadata?: ...;
brivo_metadata?: ...;
controlbyweb_metadata?: ...;
dormakaba_oracode_metadata?: ...;
ecobee_metadata?: ...;
four_suites_metadata?: ...;
genie_metadata?: ...;
honeywell_resideo_metadata?: ...;
hubitat_metadata?: ...;
igloo_metadata?: ...;
igloohome_metadata?: ...;
keynest_metadata?: ...;
korelock_metadata?: ...;
kwikset_metadata?: ...;
lockly_metadata?: ...;
minut_metadata?: ...;
nest_metadata?: ...;
noiseaware_metadata?: ...;
nuki_metadata?: ...;
salto_ks_metadata?: ...;
salto_metadata?: ...;
schlage_metadata?: ...;
seam_bridge_metadata?: ...;
sensi_metadata?: ...;
smartthings_metadata?: ...;
tado_metadata?: ...;
tedee_metadata?: ...;
ttlock_metadata?: ...;
two_n_metadata?: ...;
ultraloq_metadata?: ...;
visionline_metadata?: ...;
wyze_metadata?: ...;
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: ...;
available_climate_presets?: ...;
available_fan_mode_settings?: ...;
available_hvac_mode_settings?: ...;
current_climate_setting?: ...;
default_climate_setting?: ...;
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: ...;
is_fan_running?: ...;
is_heating?: ...;
is_temporary_manual_override_active?: ...;
max_cooling_set_point_celsius?: ...;
max_cooling_set_point_fahrenheit?: ...;
max_heating_set_point_celsius?: ...;
max_heating_set_point_fahrenheit?: ...;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: ...;
min_cooling_set_point_fahrenheit?: ...;
min_heating_cooling_delta_celsius?: ...;
min_heating_cooling_delta_fahrenheit?: ...;
min_heating_set_point_celsius?: ...;
min_heating_set_point_fahrenheit?: ...;
relative_humidity?: ...;
temperature_celsius?: ...;
temperature_fahrenheit?: ...;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
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: ... }
| { 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: ... }
| { 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: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
spaces?: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
}[];
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/spaces/get_related";
}
/spaces/list
"/spaces/list": {
commonParams: {
connected_account_id?: string;
customer_key?: string;
search?: string;
space_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
spaces: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/spaces/list";
}
/spaces/remove_acs_entrances
"/spaces/remove_acs_entrances": {
commonParams: { acs_entrance_ids: string[]; space_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST" | "DELETE";
queryParams: {};
route: "/spaces/remove_acs_entrances";
}
/spaces/remove_devices
"/spaces/remove_devices": {
commonParams: { device_ids: string[]; space_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST" | "DELETE";
queryParams: {};
route: "/spaces/remove_devices";
}
/spaces/update
"/spaces/update": {
commonParams: {};
formData: {};
jsonBody: {
acs_entrance_ids?: string[];
customer_key?: string;
device_ids?: string[];
name?: string;
space_id?: string;
space_key?: string;
};
jsonResponse: {
space: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/spaces/update";
}
/thermostats/activate_climate_preset
"/thermostats/activate_climate_preset": {
commonParams: {};
formData: {};
jsonBody: { climate_preset_key: string; device_id: string };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/activate_climate_preset";
}
/thermostats/cool
"/thermostats/cool": {
commonParams: {};
formData: {};
jsonBody: {
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
sync?: boolean;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/cool";
}
/thermostats/create_climate_preset
"/thermostats/create_climate_preset": {
commonParams: {};
formData: {};
jsonBody: {
climate_preset_key: string;
climate_preset_mode?:
| "home"
| "away"
| "wake"
| "sleep"
| "occupied"
| "unoccupied";
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
ecobee_metadata?: {
climate_ref: string;
is_optimized: boolean;
owner: "user"
| "system";
};
fan_mode_setting?: "auto"
| "on"
| "circulate";
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool" | "eco";
manual_override_allowed?: boolean;
name?: string | null;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/create_climate_preset";
}
/thermostats/daily_programs/create
"/thermostats/daily_programs/create": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
name: string;
periods: { climate_preset_key: string; starts_at_time: string }[];
};
jsonResponse: {
thermostat_daily_program: {
created_at: string;
device_id: string;
name: string
| null;
periods: { climate_preset_key: string; starts_at_time: string }[];
thermostat_daily_program_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/daily_programs/create";
}
/thermostats/daily_programs/delete
"/thermostats/daily_programs/delete": {
commonParams: { thermostat_daily_program_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/thermostats/daily_programs/delete";
}
/thermostats/daily_programs/update
"/thermostats/daily_programs/update": {
commonParams: {};
formData: {};
jsonBody: {
name: string;
periods: { climate_preset_key: string; starts_at_time: string }[];
thermostat_daily_program_id: string;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/thermostats/daily_programs/update";
}
/thermostats/delete_climate_preset
"/thermostats/delete_climate_preset": {
commonParams: {};
formData: {};
jsonBody: { climate_preset_key: string; device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST" | "DELETE";
queryParams: {};
route: "/thermostats/delete_climate_preset";
}
/thermostats/get
"/thermostats/get": {
commonParams: { device_id?: string; name?: string };
formData: {};
jsonBody: {};
jsonResponse: {
thermostat: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: (...) | (...);
appearance: { name: ... };
battery?: (...) | (...);
battery_level?: (...) | (...);
currently_triggering_noise_threshold_ids?: (...) | (...);
has_direct_power?: (...) | (...);
image_alt_text?: (...) | (...);
image_url?: (...) | (...);
manufacturer?: (...) | (...);
model: {
accessory_keypad_supported?: ...;
can_connect_accessory_keypad?: ...;
display_name: ...;
has_built_in_keypad?: ...;
manufacturer_display_name: ...;
offline_access_codes_supported?: ...;
online_access_codes_supported?: ...;
};
name: string;
noise_level_decibels?: (...)
| (...);
offline_access_codes_enabled?: (...) | (...);
online: boolean;
online_access_codes_enabled?: (...) | (...);
serial_number?: (...) | (...);
supports_accessory_keypad?: (...) | (...);
supports_offline_access_codes?: (...) | (...);
} & {
assa_abloy_credential_service_metadata?: (...)
| (...);
salto_space_credential_service_metadata?: (...) | (...);
} & {
akiles_metadata?: {
_member_group_id?: (...)
| (...);
gadget_id: string;
gadget_name: string;
product_name: string;
};
assa_abloy_vostio_metadata?: { encoder_name: string };
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
entry_relays_total_count: number;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
activation_enabled?: (...)
| (...);
device_name?: (...) | (...);
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...)
| (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...)
| (...);
door_id?: (...) | (...);
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: (...) | (...);
site_name: string;
};
ecobee_metadata?: { device_name: string; ecobee_device_id: string };
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: { device_name: string; door_name: string };
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...)
| (...);
};
igloohome_metadata?: {
bridge_id?: (...)
| (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
is_keypad_linked_to_bridge?: (...) | (...);
keypad_id?: (...) | (...);
};
keynest_metadata?: {
address?: (...)
| (...);
current_or_last_store_id?: (...) | (...);
current_status?: (...) | (...);
current_user_company?: (...) | (...);
current_user_email?: (...) | (...);
current_user_name?: (...) | (...);
current_user_phone_number?: (...) | (...);
default_office_id?: (...) | (...);
device_name?: (...) | (...);
fob_id?: (...) | (...);
handover_method?: (...) | (...);
has_photo?: (...) | (...);
is_quadient_locker?: (...) | (...);
key_id?: (...) | (...);
key_notes?: (...) | (...);
keynest_app_user?: (...) | (...);
last_movement?: (...) | (...);
property_id?: (...) | (...);
property_postcode?: (...) | (...);
status_type?: (...) | (...);
subscription_plan?: (...) | (...);
};
korelock_metadata?: {
device_id?: (...)
| (...);
device_name?: (...) | (...);
firmware_version?: (...) | (...);
model_code?: (...) | (...);
serial_number?: (...) | (...);
wifi_signal_strength?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
device_custom_name: string;
device_name: string;
display_name?: (...)
| (...);
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...)
| (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...)
| (...);
keypad_battery_critical?: (...) | (...);
keypad_paired?: (...) | (...);
};
salto_ks_metadata?: {
battery_level: string;
customer_reference: string;
has_custom_pin_subscription?: (...)
| (...);
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...)
| (...);
};
schlage_metadata?: {
device_id: string;
device_name: string;
model?: (...)
| (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...)
| (...);
};
sensi_metadata?: {
device_id: string;
device_name: string;
product_type: string;
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...)
| (...);
model?: (...) | (...);
};
tado_metadata?: { device_type: string; serial_no: string };
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
feature_value: string;
features: {
incomplete_keyboard_passcode: ...;
lock_command: ...;
passcode: ...;
passcode_management: ...;
unlock_via_gateway: ...;
wifi: ...;
};
has_gateway?: (...)
| (...);
lock_alias: string;
lock_id: number;
wireless_keypads?: (...) | (...);
};
two_n_metadata?: { device_id: number; device_name: string };
ultraloq_metadata?: {
device_id: string;
device_name: string;
device_type: string;
time_zone: (...) | (...);
};
visionline_metadata?: { encoder_id: string };
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: | (...)
| (...);
code_constraints?: (...) | (...);
door_open?: (...) | (...);
has_native_entry_events?: (...) | (...);
keypad_battery?: (...) | (...);
locked?: (...) | (...);
max_active_codes_supported?: (...) | (...);
supported_code_lengths?: (...) | (...);
supports_backup_access_code_pool?: (...) | (...);
} & {
active_thermostat_schedule?: (...)
| (...);
active_thermostat_schedule_id?: (...) | (...);
available_climate_preset_modes?: (...)[];
available_climate_presets?: {
can_delete: ...;
can_edit: ...;
can_use_with_thermostat_daily_programs: ...;
climate_preset_key: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed: ...;
name?: ...;
}[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: (...) | (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
default_climate_setting?: {
can_delete?: (...)
| (...);
can_edit?: (...) | (...);
can_use_with_thermostat_daily_programs?: (...) | (...);
climate_preset_key?: (...) | (...);
climate_preset_mode?: (...) | (...);
cooling_set_point_celsius?: (...) | (...);
cooling_set_point_fahrenheit?: (...) | (...);
display_name?: (...) | (...);
ecobee_metadata?: (...) | (...);
fan_mode_setting?: (...) | (...);
heating_set_point_celsius?: (...) | (...);
heating_set_point_fahrenheit?: (...) | (...);
hvac_mode_setting?: (...) | (...);
manual_override_allowed?: (...) | (...);
name?: (...) | (...);
};
fallback_climate_preset_key?: (...)
| (...);
fan_mode_setting?: (...) | (...) | (...);
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: (...) | (...);
max_unique_climate_presets_per_thermostat_weekly_program?: (...) | (...);
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: (...) | (...);
thermostat_daily_program_period_precision_minutes?: (...) | (...);
thermostat_daily_programs?: (...) | (...);
thermostat_weekly_program?: (...) | (...);
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/thermostats/get";
}
/thermostats/heat
"/thermostats/heat": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
sync?: boolean;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/heat";
}
/thermostats/heat_cool
"/thermostats/heat_cool": {
commonParams: {};
formData: {};
jsonBody: {
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
sync?: boolean;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/heat_cool";
}
/thermostats/list
"/thermostats/list": {
commonParams: {
connect_webview_id?: string;
connected_account_id?: string;
connected_account_ids?: string[];
created_before?: Date;
custom_metadata_has?: { [x: string]: string | boolean };
customer_key?: string;
device_ids?: string[];
device_type?:
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat";
device_types?: (
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
)[];
exclude_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
include_if?: (
| "can_remotely_unlock"
| "can_remotely_lock"
| "can_program_offline_access_codes"
| "can_program_online_access_codes"
| "can_hvac_heat"
| "can_hvac_cool"
| "can_hvac_heat_cool"
| "can_turn_off_hvac"
| "can_simulate_removal"
| "can_simulate_connection"
| "can_simulate_disconnection"
| "can_unlock_with_code"
| "can_run_thermostat_programs"
| "can_program_thermostat_programs_as_weekday_weekend"
| "can_program_thermostat_programs_as_different_each_day"
| "can_program_thermostat_programs_as_same_each_day"
| "can_simulate_hub_connection"
| "can_simulate_hub_disconnection"
| "can_simulate_paid_subscription"
)[];
limit?: number;
manufacturer?: | "ecobee"
| "honeywell_resideo"
| "nest"
| "sensi"
| "smartthings"
| "tado";
page_cursor?: string | undefined
| null;
search?: string;
space_id?: string;
unstable_location_id?: string | null;
user_identifier_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
thermostats: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/thermostats/list";
}
/thermostats/off
"/thermostats/off": {
commonParams: {};
formData: {};
jsonBody: { device_id: string; sync?: boolean };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/off";
}
/thermostats/schedules/create
"/thermostats/schedules/create": {
commonParams: {};
formData: {};
jsonBody: {
climate_preset_key: string;
device_id: string;
ends_at: string;
is_override_allowed?: boolean;
max_override_period_minutes?: number | null;
name?: string;
starts_at: string;
};
jsonResponse: {
thermostat_schedule: {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors: { error_code: string; message: string }[];
is_override_allowed?: boolean;
max_override_period_minutes?: number | null;
name: string | null;
starts_at: string;
thermostat_schedule_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/schedules/create";
}
/thermostats/schedules/delete
"/thermostats/schedules/delete": {
commonParams: { thermostat_schedule_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/thermostats/schedules/delete";
}
/thermostats/schedules/get
"/thermostats/schedules/get": {
commonParams: { thermostat_schedule_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
thermostat_schedule: {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors: { error_code: string; message: string }[];
is_override_allowed?: boolean;
max_override_period_minutes?: number | null;
name: string | null;
starts_at: string;
thermostat_schedule_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/thermostats/schedules/get";
}
/thermostats/schedules/list
"/thermostats/schedules/list": {
commonParams: { device_id: string; user_identifier_key?: string };
formData: {};
jsonBody: {};
jsonResponse: {
thermostat_schedules: {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors: { error_code: string; message: string }[];
is_override_allowed?: boolean;
max_override_period_minutes?: number | null;
name: string | null;
starts_at: string;
thermostat_schedule_id: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/thermostats/schedules/list";
}
/thermostats/schedules/update
"/thermostats/schedules/update": {
commonParams: {};
formData: {};
jsonBody: {
climate_preset_key?: string;
ends_at?: string;
is_override_allowed?: boolean;
max_override_period_minutes?: number | null;
name?: string;
starts_at?: string;
thermostat_schedule_id: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/thermostats/schedules/update";
}
/thermostats/set_fallback_climate_preset
"/thermostats/set_fallback_climate_preset": {
commonParams: {};
formData: {};
jsonBody: { climate_preset_key: string; device_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/set_fallback_climate_preset";
}
/thermostats/set_fan_mode
"/thermostats/set_fan_mode": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
fan_mode?: "auto" | "on" | "circulate";
fan_mode_setting?: "auto" | "on" | "circulate";
sync?: boolean;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/set_fan_mode";
}
/thermostats/set_hvac_mode
"/thermostats/set_hvac_mode": {
commonParams: {};
formData: {};
jsonBody:
| { device_id: string; hvac_mode_setting: "off" }
| {
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
hvac_mode_setting: "cool";
}
| {
device_id: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting: "heat";
}
| {
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting: "heat_cool";
}
| { device_id: string; hvac_mode_setting: "eco" };
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/set_hvac_mode";
}
/thermostats/set_temperature_threshold
"/thermostats/set_temperature_threshold": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
lower_limit_celsius?: number | undefined | null;
lower_limit_fahrenheit?: number | undefined | null;
upper_limit_celsius?: number | undefined | null;
upper_limit_fahrenheit?: number | undefined | null;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/thermostats/set_temperature_threshold";
}
/thermostats/simulate/hvac_mode_adjusted
"/thermostats/simulate/hvac_mode_adjusted": {
commonParams: {};
formData: {};
jsonBody:
| { device_id: string; hvac_mode: "off" }
| {
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
hvac_mode: "cool";
}
| {
device_id: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode: "heat";
}
| {
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode: "heat_cool";
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/simulate/hvac_mode_adjusted";
}
/thermostats/simulate/temperature_reached
"/thermostats/simulate/temperature_reached": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
temperature_celsius?: number;
temperature_fahrenheit?: number;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/simulate/temperature_reached";
}
/thermostats/update_climate_preset
"/thermostats/update_climate_preset": {
commonParams: {};
formData: {};
jsonBody: {
climate_preset_key: string;
climate_preset_mode?:
| "home"
| "away"
| "wake"
| "sleep"
| "occupied"
| "unoccupied";
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
device_id: string;
ecobee_metadata?: {
climate_ref: string;
is_optimized: boolean;
owner: "user"
| "system";
};
fan_mode_setting?: "auto"
| "on"
| "circulate";
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool" | "eco";
manual_override_allowed?: boolean;
name?: string | null;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/thermostats/update_climate_preset";
}
/thermostats/update_weekly_program
"/thermostats/update_weekly_program": {
commonParams: {};
formData: {};
jsonBody: {
device_id: string;
friday_program_id?: string | undefined | null;
monday_program_id?: string | undefined | null;
saturday_program_id?: string | undefined | null;
sunday_program_id?: string | undefined | null;
thursday_program_id?: string | undefined | null;
tuesday_program_id?: string | undefined | null;
wednesday_program_id?: string | undefined | null;
};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/thermostats/update_weekly_program";
}
/unstable_partner/building_blocks/connect_accounts
"/unstable_partner/building_blocks/connect_accounts": {
commonParams: { customer_key: string };
formData: {};
jsonBody: {};
jsonResponse: {
magic_link: {
created_at: string;
customer_key: string;
expires_at: string;
url: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/unstable_partner/building_blocks/connect_accounts";
}
/unstable_partner/building_blocks/generate_magic_link
"/unstable_partner/building_blocks/generate_magic_link": {
commonParams: {
building_block_type:
| "connect_accounts"
| "organize_spaces"
| "console"
| "manage_devices";
customer_key: string;
spaces?: { name: string; space_key: string }[];
};
formData: {};
jsonBody: {};
jsonResponse: {
magic_link: {
created_at: string;
customer_key: string;
expires_at: string;
url: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST"
| "GET";
queryParams: {};
route: "/unstable_partner/building_blocks/generate_magic_link";
}
/unstable_partner/building_blocks/manage_devices
"/unstable_partner/building_blocks/manage_devices": {
commonParams: { customer_key: string };
formData: {};
jsonBody: {};
jsonResponse: {
magic_link: {
created_at: string;
customer_key: string;
expires_at: string;
url: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/unstable_partner/building_blocks/manage_devices";
}
/unstable_partner/building_blocks/organize_spaces
"/unstable_partner/building_blocks/organize_spaces": {
commonParams: {
customer_key: string;
spaces?: { name: string; space_key: string }[];
};
formData: {};
jsonBody: {};
jsonResponse: {
magic_link: {
created_at: string;
customer_key: string;
expires_at: string;
url: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/unstable_partner/building_blocks/organize_spaces";
}
/user_identities/add_acs_user
"/user_identities/add_acs_user": {
commonParams: {
acs_user_id: string;
user_identity_id?: string;
user_identity_key?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PUT";
queryParams: {};
route: "/user_identities/add_acs_user";
}
/user_identities/create
"/user_identities/create": {
commonParams: {
acs_system_ids?: string[];
email_address?: string | null;
full_name?: string | null;
phone_number?: string | null;
user_identity_key?: string | null;
};
formData: {};
jsonBody: {};
jsonResponse: {
user_identity: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string
| null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
user_identity_key: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "acs_user_profile_does_not_match_user_identity";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/user_identities/create";
}
/user_identities/delete
"/user_identities/delete": {
commonParams: { user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/user_identities/delete";
}
/user_identities/enrollment_automations/delete
"/user_identities/enrollment_automations/delete": {
commonParams: { enrollment_automation_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/user_identities/enrollment_automations/delete";
}
/user_identities/enrollment_automations/get
"/user_identities/enrollment_automations/get": {
commonParams: { enrollment_automation_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
enrollment_automation: {
created_at: string;
credential_manager_acs_system_id: string;
enrollment_automation_id: string;
user_identity_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/enrollment_automations/get";
}
/user_identities/enrollment_automations/launch
"/user_identities/enrollment_automations/launch": {
commonParams: {
acs_credential_pool_id?: string;
create_credential_manager_user?: boolean;
credential_manager_acs_system_id: string;
credential_manager_acs_user_id?: string;
user_identity_id: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
enrollment_automation: {
created_at: string;
credential_manager_acs_system_id: string;
enrollment_automation_id: string;
user_identity_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/user_identities/enrollment_automations/launch";
}
/user_identities/enrollment_automations/list
"/user_identities/enrollment_automations/list": {
commonParams: { user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
enrollment_automations: {
created_at: string;
credential_manager_acs_system_id: string;
enrollment_automation_id: string;
user_identity_id: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/enrollment_automations/list";
}
/user_identities/generate_instant_key
"/user_identities/generate_instant_key": {
commonParams: {
customization_profile_id?: string;
max_use_count?: number;
user_identity_id: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
instant_key: {
client_session_id: string;
created_at: string;
customization?: {
logo_url?: string;
primary_color?: string;
secondary_color?: string;
};
customization_profile_id?: string;
expires_at: string;
instant_key_id: string;
instant_key_url: string;
user_identity_id: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/user_identities/generate_instant_key";
}
/user_identities/get
"/user_identities/get": {
commonParams:
| { user_identity_id: string }
| { user_identity_key: string };
formData: {};
jsonBody: {};
jsonResponse: {
user_identity: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string | null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
user_identity_key: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "acs_user_profile_does_not_match_user_identity";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/get";
}
/user_identities/grant_access_to_device
"/user_identities/grant_access_to_device": {
commonParams: { device_id: string; user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "PUT" | "POST";
queryParams: {};
route: "/user_identities/grant_access_to_device";
}
/user_identities/list
"/user_identities/list": {
commonParams: {
created_before?: Date;
credential_manager_acs_system_id?: string;
limit?: number;
page_cursor?: string | undefined | null;
search?: string;
user_identity_ids?: string[];
};
formData: {};
jsonBody: {};
jsonResponse: {
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
user_identities: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string
| null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
user_identity_key: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "acs_user_profile_does_not_match_user_identity";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/list";
}
/user_identities/list_accessible_devices
"/user_identities/list_accessible_devices": {
commonParams: { user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
accessible_devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
devices: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
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: "bridge_disconnected";
is_bridge_error?: boolean;
is_connected_account_error?: boolean;
message: string;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: {
accessory_keypad?: ...;
appearance: ...;
battery?: ...;
battery_level?: ...;
currently_triggering_noise_threshold_ids?: ...;
has_direct_power?: ...;
image_alt_text?: ...;
image_url?: ...;
manufacturer?: ...;
model: ...;
name: ...;
noise_level_decibels?: ...;
offline_access_codes_enabled?: ...;
online: ...;
online_access_codes_enabled?: ...;
serial_number?: ...;
supports_accessory_keypad?: ...;
supports_offline_access_codes?: ...;
} & {
assa_abloy_credential_service_metadata?: ...;
salto_space_credential_service_metadata?: ...;
} & {
akiles_metadata?: {
_member_group_id?: ...;
gadget_id: ...;
gadget_name: ...;
product_name: ...;
};
assa_abloy_vostio_metadata?: { encoder_name: ... };
august_metadata?: {
has_keypad: ...;
house_id?: ...;
house_name: ...;
keypad_battery_level?: ...;
lock_id: ...;
lock_name: ...;
model?: ...;
};
avigilon_alta_metadata?: {
entry_name: ...;
entry_relays_total_count: ...;
org_name: ...;
site_id: ...;
site_name: ...;
zone_id: ...;
zone_name: ...;
};
brivo_metadata?: { activation_enabled?: ...; device_name?: ... };
controlbyweb_metadata?: {
device_id: ...;
device_name: ...;
relay_name: ...;
};
dormakaba_oracode_metadata?: {
device_id?: ...;
door_id?: ...;
door_is_wireless: ...;
door_name: ...;
iana_timezone?: ...;
predefined_time_slots?: ...;
site_id: ...;
site_name: ...;
};
ecobee_metadata?: { device_name: ...; ecobee_device_id: ... };
four_suites_metadata?: {
device_id: ...;
device_name: ...;
reclose_delay_in_seconds: ...;
};
genie_metadata?: { device_name: ...; door_name: ... };
honeywell_resideo_metadata?: {
device_name: ...;
honeywell_resideo_device_id: ...;
};
hubitat_metadata?: {
device_id: ...;
device_label: ...;
device_name: ...;
};
igloo_metadata?: { bridge_id: ...; device_id: ...; model?: ... };
igloohome_metadata?: {
bridge_id?: ...;
bridge_name?: ...;
device_id: ...;
device_name: ...;
is_keypad_linked_to_bridge?: ...;
keypad_id?: ...;
};
keynest_metadata?: {
address?: ...;
current_or_last_store_id?: ...;
current_status?: ...;
current_user_company?: ...;
current_user_email?: ...;
current_user_name?: ...;
current_user_phone_number?: ...;
default_office_id?: ...;
device_name?: ...;
fob_id?: ...;
handover_method?: ...;
has_photo?: ...;
is_quadient_locker?: ...;
key_id?: ...;
key_notes?: ...;
keynest_app_user?: ...;
last_movement?: ...;
property_id?: ...;
property_postcode?: ...;
status_type?: ...;
subscription_plan?: ...;
};
korelock_metadata?: {
device_id?: ...;
device_name?: ...;
firmware_version?: ...;
model_code?: ...;
serial_number?: ...;
wifi_signal_strength?: ...;
};
kwikset_metadata?: {
device_id: ...;
device_name: ...;
model_number: ...;
};
lockly_metadata?: { device_id: ...; device_name: ...; model?: ... };
minut_metadata?: {
device_id: ...;
device_name: ...;
latest_sensor_values: ...;
};
nest_metadata?: {
device_custom_name: ...;
device_name: ...;
display_name?: ...;
nest_device_id: ...;
};
noiseaware_metadata?: {
device_id: ...;
device_model: ...;
device_name: ...;
noise_level_decibel: ...;
noise_level_nrs: ...;
};
nuki_metadata?: {
device_id: ...;
device_name: ...;
keypad_2_paired?: ...;
keypad_battery_critical?: ...;
keypad_paired?: ...;
};
salto_ks_metadata?: {
battery_level: ...;
customer_reference: ...;
has_custom_pin_subscription?: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
salto_metadata?: {
battery_level: ...;
customer_reference: ...;
lock_id: ...;
lock_type: ...;
locked_state: ...;
model?: ...;
};
schlage_metadata?: { device_id: ...; device_name: ...; model?: ... };
seam_bridge_metadata?: {
device_num: ...;
name: ...;
unlock_method?: ...;
};
sensi_metadata?: { device_id: ...; device_name: ...; product_type: ... };
smartthings_metadata?: {
device_id: ...;
device_name: ...;
location_id?: ...;
model?: ...;
};
tado_metadata?: { device_type: ...; serial_no: ... };
tedee_metadata?: {
bridge_id: ...;
bridge_name: ...;
device_id: ...;
device_model: ...;
device_name: ...;
keypad_id?: ...;
serial_number: ...;
};
ttlock_metadata?: {
feature_value: ...;
features: ...;
has_gateway?: ...;
lock_alias: ...;
lock_id: ...;
wireless_keypads?: ...;
};
two_n_metadata?: { device_id: ...; device_name: ... };
ultraloq_metadata?: {
device_id: ...;
device_name: ...;
device_type: ...;
time_zone: ...;
};
visionline_metadata?: { encoder_id: ... };
wyze_metadata?: {
device_id: ...;
device_info_model: ...;
device_name: ...;
keypad_uuid?: ...;
locker_status_hardlock?: ...;
product_model: ...;
product_name: ...;
product_type: ...;
};
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: (...)[];
available_climate_presets?: (...)[];
available_fan_mode_settings?: (...)[];
available_hvac_mode_settings?: (...)[];
current_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
default_climate_setting?: {
can_delete?: ...;
can_edit?: ...;
can_use_with_thermostat_daily_programs?: ...;
climate_preset_key?: ...;
climate_preset_mode?: ...;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
display_name?: ...;
ecobee_metadata?: ...;
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
manual_override_allowed?: ...;
name?: ...;
};
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: boolean;
is_fan_running?: boolean;
is_heating?: boolean;
is_temporary_manual_override_active?: boolean;
max_cooling_set_point_celsius?: number;
max_cooling_set_point_fahrenheit?: number;
max_heating_set_point_celsius?: number;
max_heating_set_point_fahrenheit?: number;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: number;
min_cooling_set_point_fahrenheit?: number;
min_heating_cooling_delta_celsius?: number;
min_heating_cooling_delta_fahrenheit?: number;
min_heating_set_point_celsius?: number;
min_heating_set_point_fahrenheit?: number;
relative_humidity?: number;
temperature_celsius?: number;
temperature_fahrenheit?: number;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
warnings: (
| {
created_at: string;
message: string;
warning_code: "partial_backup_access_code_pool";
}
| {
created_at: string;
message: string;
warning_code: "many_active_backup_codes";
}
| {
created_at: string;
message: string;
warning_code: "wyze_device_missing_gateway";
}
| {
created_at: string;
message: string;
warning_code: "third_party_integration_detected";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
| {
created_at: string;
message: string;
warning_code: "ttlock_weak_gateway_signal";
}
| {
created_at: string;
message: string;
warning_code: "power_saving_mode";
}
| {
created_at: string;
message: string;
warning_code: "temperature_threshold_exceeded";
}
| {
created_at: string;
message: string;
warning_code: "device_communication_degraded";
}
| {
created_at: string;
message: string;
warning_code: "scheduled_maintenance_window";
}
| {
created_at: string;
message: string;
warning_code: "device_has_flaky_connection";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_office_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_privacy_mode";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_phone";
}
| {
created_at: string;
message: string;
warning_code: "lockly_time_zone_not_configured";
}
| {
created_at: string;
message: string;
warning_code: "ultraloq_time_zone_unknown";
}
| {
created_at: string;
message: string;
warning_code: "hub_required_for_additional_capabilities";
}
| {
created_at: string;
message: string;
warning_code: "keynest_unsupported_locker";
}
| {
created_at: string;
message: string;
warning_code: "accessory_keypad_setup_required";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/list_accessible_devices";
}
/user_identities/list_acs_systems
"/user_identities/list_acs_systems": {
commonParams: { user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_systems: {
acs_access_group_count?: number;
acs_system_id: string;
acs_user_count?: number;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: string | null;
errors: (
| {
created_at: string;
error_code: "seam_bridge_disconnected";
message: string;
}
| {
created_at: string;
error_code: "bridge_disconnected";
is_bridge_error?: boolean;
message: string;
}
| {
created_at: string;
error_code: "visionline_instance_unreachable";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "acs_system_disconnected";
message: string;
}
| {
created_at: string;
error_code: "account_disconnected";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_certification_expired";
message: string;
}
)[];
external_type?: | "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: { time_zone: string
| null };
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: (
| {
created_at: string;
message: string;
warning_code: "salto_ks_subscription_limit_almost_reached";
}
| {
created_at: string;
message: string;
misconfigured_acs_entrance_ids?: (...)[];
warning_code: "time_zone_does_not_match_location";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/list_acs_systems";
}
/user_identities/list_acs_users
"/user_identities/list_acs_users": {
commonParams: { user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
acs_users: {
access_schedule?: { ends_at: string | null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| {
created_at: string;
error_code: "deleted_externally";
message: string;
}
| {
created_at: string;
error_code: "salto_ks_subscription_limit_exceeded";
message: string;
}
| {
created_at: string;
error_code: "failed_to_create_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_update_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "failed_to_delete_on_acs_system";
message: string;
}
| {
created_at: string;
error_code: "latch_conflict_with_resident_user";
message: string;
}
)[];
external_type?: | "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: true;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
| { created_at: string; message: string; mutation_code: "creating" }
| { created_at: string; message: string; mutation_code: "deleting" }
| {
created_at: string;
message: string;
mutation_code: "deferring_creation";
scheduled_at?: (...) | (...);
}
| {
created_at: string;
from: { email_address?: ...; full_name?: ...; phone_number?: ... };
message: string;
mutation_code: "updating_user_information";
to: { email_address?: ...; full_name?: ...; phone_number?: ... };
}
| {
created_at: string;
from: { ends_at: ...; starts_at: ... };
message: string;
mutation_code: "updating_access_schedule";
to: { ends_at: ...; starts_at: ... };
}
| {
created_at: string;
from: { is_suspended: ... };
message: string;
mutation_code: "updating_suspension_state";
to: { is_suspended: ... };
}
| {
created_at: string;
from: { acs_access_group_id: ... };
message: string;
mutation_code: "updating_group_membership";
to: { acs_access_group_id: ... };
}
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "salto_ks_user_not_subscribed";
}
| {
created_at: string;
message: string;
warning_code: "unknown_issue_with_acs_user";
}
| {
created_at: string;
message: string;
warning_code: "latch_resident_user";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/list_acs_users";
}
/user_identities/remove_acs_user
"/user_identities/remove_acs_user": {
commonParams: { acs_user_id: string; user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/user_identities/remove_acs_user";
}
/user_identities/revoke_access_to_device
"/user_identities/revoke_access_to_device": {
commonParams: { device_id: string; user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/user_identities/revoke_access_to_device";
}
/user_identities/unmanaged/get
"/user_identities/unmanaged/get": {
commonParams: { user_identity_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
user_identity: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string | null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "acs_user_profile_does_not_match_user_identity";
}
)[];
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/unmanaged/get";
}
/user_identities/unmanaged/list
"/user_identities/unmanaged/list": {
commonParams: {
created_before?: Date;
limit?: number;
page_cursor?: string | undefined | null;
search?: string;
};
formData: {};
jsonBody: {};
jsonResponse: {
pagination: {
has_next_page: boolean;
next_page_cursor: string
| null;
next_page_url: string | null;
};
user_identities: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string
| null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
warnings: (
| {
created_at: string;
message: string;
warning_code: "being_deleted";
}
| {
created_at: string;
message: string;
warning_code: "acs_user_profile_does_not_match_user_identity";
}
)[];
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/user_identities/unmanaged/list";
}
/user_identities/unmanaged/update
"/user_identities/unmanaged/update": {
commonParams: {};
formData: {};
jsonBody: {
is_managed: true;
user_identity_id: string;
user_identity_key?: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/user_identities/unmanaged/update";
}
/user_identities/update
"/user_identities/update": {
commonParams: {};
formData: {};
jsonBody: {
email_address?: string | null;
full_name?: string | null;
phone_number?: string | null;
user_identity_id: string;
user_identity_key?: string | null;
};
jsonResponse: {};
maxDuration: undefined;
method: "PATCH"
| "POST";
queryParams: {};
route: "/user_identities/update";
}
/webhooks/create
"/webhooks/create": {
commonParams: {};
formData: {};
jsonBody: { event_types?: string[]; url: string };
jsonResponse: {
webhook: {
event_types?: string[];
secret?: string;
url: string;
webhook_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/webhooks/create";
}
/webhooks/delete
"/webhooks/delete": {
commonParams: { webhook_id: string };
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "DELETE" | "POST";
queryParams: {};
route: "/webhooks/delete";
}
/webhooks/get
"/webhooks/get": {
commonParams: { webhook_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
webhook: {
event_types?: string[];
secret?: string;
url: string;
webhook_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/webhooks/get";
}
/webhooks/list
"/webhooks/list": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
webhooks: {
event_types?: string[];
secret?: string;
url: string;
webhook_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/webhooks/list";
}
/webhooks/update
"/webhooks/update": {
commonParams: {};
formData: {};
jsonBody: { event_types: string[]; webhook_id: string };
jsonResponse: {};
maxDuration: undefined;
method: "PUT" | "POST";
queryParams: {};
route: "/webhooks/update";
}
/workspaces/create
"/workspaces/create": {
commonParams: {};
formData: {};
jsonBody: {
company_name?: string;
connect_partner_name?: string | null | null;
connect_webview_customization?: {
logo_shape?: "circle" | "square" | null;
primary_button_color?: string | null;
primary_button_text_color?: string | null;
success_message?: string | null;
};
is_sandbox?: boolean;
name: string;
webview_logo_shape?: "circle"
| "square";
webview_primary_button_color?: string;
webview_primary_button_text_color?: string;
webview_success_message?: string;
};
jsonResponse: {
workspace: {
company_name: string;
connect_partner_name: string | null
| null;
connect_webview_customization: {
inviter_logo_url?: string;
logo_shape?: "circle" | "square";
primary_button_color?: string;
primary_button_text_color?: string;
success_message?: string;
};
is_publishable_key_auth_enabled: boolean;
is_sandbox: boolean;
is_suspended: boolean;
name: string;
publishable_key?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/workspaces/create";
}
/workspaces/customization_profiles/create
"/workspaces/customization_profiles/create": {
commonParams: {};
formData: {};
jsonBody: {
customer_portal_theme?: {
primary_color?: string;
primary_foreground_color?: string;
secondary_color?: string;
secondary_foreground_color?: string;
};
name?: string
| null;
primary_color?: string;
secondary_color?: string;
};
jsonResponse: {
customization_profile: {
created_at: string;
customer_portal_theme?: {
primary_color?: string;
primary_foreground_color?: string;
secondary_color?: string;
secondary_foreground_color?: string;
};
customization_profile_id: string;
logo_url?: string;
name: string
| null;
primary_color?: string;
secondary_color?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/workspaces/customization_profiles/create";
}
/workspaces/customization_profiles/get
"/workspaces/customization_profiles/get": {
commonParams: { customization_profile_id: string };
formData: {};
jsonBody: {};
jsonResponse: {
customization_profile: {
created_at: string;
customer_portal_theme?: {
primary_color?: string;
primary_foreground_color?: string;
secondary_color?: string;
secondary_foreground_color?: string;
};
customization_profile_id: string;
logo_url?: string;
name: string
| null;
primary_color?: string;
secondary_color?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "POST"
| "GET";
queryParams: {};
route: "/workspaces/customization_profiles/get";
}
/workspaces/customization_profiles/list
"/workspaces/customization_profiles/list": {
commonParams: { customer_key?: string };
formData: {};
jsonBody: {};
jsonResponse: {
customization_profiles: {
created_at: string;
customer_portal_theme?: {
primary_color?: string;
primary_foreground_color?: string;
secondary_color?: string;
secondary_foreground_color?: string;
};
customization_profile_id: string;
logo_url?: string;
name: string
| null;
primary_color?: string;
secondary_color?: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "POST"
| "GET";
queryParams: {};
route: "/workspaces/customization_profiles/list";
}
/workspaces/customization_profiles/update
"/workspaces/customization_profiles/update": {
commonParams: {};
formData: {};
jsonBody: {
customer_portal_theme?:
| | {
primary_color?: string;
primary_foreground_color?: string;
secondary_color?: string;
secondary_foreground_color?: string;
}
| undefined
| null;
customization_profile_id: string;
name?: string | undefined
| null;
primary_color?: string;
secondary_color?: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/workspaces/customization_profiles/update";
}
/workspaces/customization_profiles/upload_images
"/workspaces/customization_profiles/upload_images": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/workspaces/customization_profiles/upload_images";
}
/workspaces/find_anything
"/workspaces/find_anything": {
commonParams: { search: string };
formData: {};
jsonBody: {};
jsonResponse: {
batch: {
access_codes?: {
access_code_id: string;
code: string | null;
common_code_key: string | null;
created_at: string;
device_id: string;
ends_at?: string | null;
errors: (
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
)[];
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: string
| null;
pulled_backup_access_code_id?: string | null;
starts_at?: string | null;
status: "setting" | "set" | "unset" | "removing" | "unknown";
type: "time_bound" | "ongoing";
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: ... }
| { 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: ... }
| { created_at?: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
access_grants?: {
access_grant_id: string;
access_grant_key?: string;
access_method_ids: string[];
client_session_token?: string;
created_at: string;
customization_profile_id?: string;
display_name: string;
ends_at: string
| null;
errors: {
created_at: string;
error_code: "cannot_create_requested_access_methods";
message: string;
}[];
instant_key_url?: string;
location_ids: string[];
name: string
| null;
requested_access_methods: {
code?: string;
created_access_method_ids: string[];
created_at: string;
display_name: string;
mode: "code" | "card" | "mobile_key";
}[];
reservation_key?: string;
space_ids: string[];
starts_at: string;
user_identity_id: string;
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
access_methods?: {
access_method_id: string;
client_session_token?: string;
code?: string
| null;
created_at: string;
customization_profile_id?: string;
display_name: string;
instant_key_url?: string;
is_encoding_required?: boolean;
is_issued: boolean;
issued_at: string | null;
mode: "code" | "card" | "mobile_key";
warnings: {
created_at: string;
message: string;
warning_code: "being_deleted";
}[];
workspace_id: string;
}[];
acs_access_groups?: {
access_group_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
access_group_type_display_name: string;
acs_access_group_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
external_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
external_type_display_name: string;
is_managed: true;
name: string;
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
acs_credentials?: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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;
}[];
acs_encoders?: {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
errors: {
created_at: string;
error_code: "acs_encoder_removed";
message: string;
}[];
workspace_id: string;
}[];
acs_entrances?: {
acs_entrance_id: string;
acs_system_id: string;
assa_abloy_vostio_metadata?: {
door_name: string;
door_number?: number;
door_type: "CommonDoor"
| "EntranceDoor"
| "GuestDoor"
| "Elevator";
pms_id?: string;
stand_open?: boolean;
};
can_belong_to_reservation?: boolean;
can_unlock_with_card?: boolean;
can_unlock_with_code?: boolean;
can_unlock_with_mobile_key?: boolean;
connected_account_id: string;
created_at: string;
display_name: string;
dormakaba_ambiance_metadata?: { access_point_name: string };
dormakaba_community_metadata?: { access_point_profile: string };
errors: { error_code: string; message: string }[];
hotek_metadata?: {
common_area_name?: string;
common_area_number?: string;
room_number?: string;
};
latch_metadata?: {
accessibility_type: string;
door_name: string;
door_type: string;
is_connected: boolean;
};
salto_ks_metadata?: {
battery_level: string;
door_name: string;
intrusion_alarm?: boolean;
left_open_alarm?: boolean;
lock_type: string;
locked_state: string;
online?: boolean;
privacy_mode?: boolean;
};
salto_space_metadata?: {
audit_on_keys?: boolean;
door_description?: string;
door_id?: string;
door_name?: string;
ext_door_id?: string;
room_description?: string;
room_name?: string;
};
space_ids: string[];
visionline_metadata?: {
door_category: | "entrance"
| "guest"
| "elevator reader"
| "common"
| "common (PMS)";
door_name: string;
profiles?: (...)[];
};
}[];
acs_systems?: {
acs_access_group_count?: number;
acs_system_id: string;
acs_user_count?: number;
connected_account_id: string;
connected_account_ids: string[];
created_at: string;
default_credential_manager_acs_system_id?: string
| null;
errors: (
| { created_at: ...; error_code: ...; message: ... }
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
message: ...;
}
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
)[];
external_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
external_type_display_name?: string;
image_alt_text: string;
image_url: string;
is_credential_manager: boolean;
location: { time_zone: string
| null };
name: string;
system_type?:
| "pti_site"
| "alta_org"
| "salto_ks_site"
| "salto_space_system"
| "brivo_account"
| "hid_credential_manager_organization"
| "visionline_system"
| "assa_abloy_credential_service"
| "latch_building"
| "dormakaba_community_site"
| "dormakaba_ambiance_site"
| "legic_connect_credential_service"
| "assa_abloy_vostio"
| "assa_abloy_vostio_credential_service"
| "hotek_site";
system_type_display_name?: string;
visionline_metadata?: {
lan_address: string;
mobile_access_uuid: string;
system_id: string;
};
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| {
created_at: ...;
message: ...;
misconfigured_acs_entrance_ids?: ...;
warning_code: ...;
}
)[];
workspace_id: string;
}[];
acs_users?: {
access_schedule?: { ends_at: string
| null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
)[];
external_type?:
| "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: true;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
action_attempts?: (
| {
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: (...)
| (...);
acs_credential_on_seam: (...) | (...);
warnings: (...)[];
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SCAN_CREDENTIAL";
error: | { message: ...; type: ... }
| { message: ...; type: ... }
| { message: ...; type: ... }
| { message: ...; type: ... };
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: ...;
acs_credential_id: ...;
acs_credential_pool_id?: ...;
acs_system_id: ...;
acs_user_id?: ...;
assa_abloy_vostio_metadata?: ...;
card_number?: ...;
code?: ...;
connected_account_id: ...;
created_at: ...;
display_name: ...;
ends_at?: ...;
errors: ...;
external_type?: ...;
external_type_display_name?: ...;
is_issued?: ...;
is_latest_desired_state_synced_with_provider?: ...;
is_managed: ...;
is_multi_phone_sync_credential?: ...;
is_one_time_use?: ...;
issued_at?: ...;
latest_desired_state_synced_with_provider_at?: ...;
parent_acs_credential_id?: ...;
starts_at?: ...;
user_identity_id?: ...;
visionline_metadata?: ...;
warnings: ...;
workspace_id: ...;
}
| {
access_method: ...;
acs_credential_id: ...;
acs_credential_pool_id?: ...;
acs_system_id: ...;
acs_user_id?: ...;
assa_abloy_vostio_metadata?: ...;
card_number?: ...;
code?: ...;
connected_account_id: ...;
created_at: ...;
display_name: ...;
ends_at?: ...;
errors: ...;
external_type?: ...;
external_type_display_name?: ...;
is_issued?: ...;
is_latest_desired_state_synced_with_provider?: ...;
is_managed: ...;
is_multi_phone_sync_credential?: ...;
is_one_time_use?: ...;
issued_at?: ...;
latest_desired_state_synced_with_provider_at?: ...;
parent_acs_credential_id?: ...;
starts_at?: ...;
user_identity_id?: ...;
visionline_metadata?: ...;
warnings: ...;
workspace_id: ...;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "ENCODE_CREDENTIAL";
error: | { message: ...; type: ... }
| { message: ...; type: ... }
| { message: ...; type: ... }
| { message: ...; type: ... }
| { message: ...; type: ... }
| { message: ...; type: ... };
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";
}
)[];
client_sessions?: {
client_session_id: string;
connect_webview_ids: string[];
connected_account_ids: string[];
created_at: string;
customer_key?: string;
device_count: number;
expires_at: string;
token: string;
user_identifier_key: string
| null;
user_identity_id?: string;
user_identity_ids: string[];
workspace_id: string;
}[];
connect_webviews?: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
accepted_devices: string[];
accepted_providers: string[];
any_device_allowed: boolean;
any_provider_allowed: boolean;
authorized_at: string | null;
automatically_manage_new_devices: boolean;
connect_webview_id: string;
connected_account_id: string | null;
created_at: string;
custom_metadata: { [x: string]: string | boolean };
custom_redirect_failure_url: string | null;
custom_redirect_url: string | null;
customer_key?: string;
device_selection_mode: "none" | "single" | "multiple";
login_successful: boolean;
selected_provider: string | null;
status: "pending" | "failed" | "authorized";
url: string;
wait_for_device_creation: boolean;
workspace_id: string;
}[];
connected_accounts?: {
accepted_capabilities: (
"lock"
| "thermostat"
| "noise_sensor"
| "access_control"
)[];
account_type?: string;
account_type_display_name: string;
automatically_manage_new_devices: boolean;
connected_account_id: string;
created_at?: string;
custom_metadata: { [x: string]: string | boolean };
customer_key?: string;
display_name: string;
errors: (
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
salto_ks_metadata: ...;
}
)[];
image_url?: string;
user_identifier?: {
api_url?: string;
email?: string;
exclusive?: boolean;
phone?: string;
username?: string;
};
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
| {
created_at: ...;
message: ...;
salto_ks_metadata: ...;
warning_code: ...;
}
| { created_at: ...; message: ...; warning_code: ... }
)[];
}[];
customization_profiles?: {
created_at: string;
customer_portal_theme?: {
primary_color?: string;
primary_foreground_color?: string;
secondary_color?: string;
secondary_foreground_color?: string;
};
customization_profile_id: string;
logo_url?: string;
name: string
| null;
primary_color?: string;
secondary_color?: string;
workspace_id: string;
}[];
devices?: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_manufacturer?: {
display_name: string;
image_url?: string;
manufacturer: string;
};
device_provider?: {
device_provider_name: string;
display_name: string;
image_url?: string;
provider_category: string;
};
device_type: | | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
display_name: string;
errors: (
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
)[];
is_managed: true;
location: { location_name?: string; timezone?: string }
| null;
nickname?: string;
properties: (...) & {
akiles_metadata?: ...;
assa_abloy_vostio_metadata?: ...;
august_metadata?: ...;
avigilon_alta_metadata?: ...;
brivo_metadata?: ...;
controlbyweb_metadata?: ...;
dormakaba_oracode_metadata?: ...;
ecobee_metadata?: ...;
four_suites_metadata?: ...;
genie_metadata?: ...;
honeywell_resideo_metadata?: ...;
hubitat_metadata?: ...;
igloo_metadata?: ...;
igloohome_metadata?: ...;
keynest_metadata?: ...;
korelock_metadata?: ...;
kwikset_metadata?: ...;
lockly_metadata?: ...;
minut_metadata?: ...;
nest_metadata?: ...;
noiseaware_metadata?: ...;
nuki_metadata?: ...;
salto_ks_metadata?: ...;
salto_metadata?: ...;
schlage_metadata?: ...;
seam_bridge_metadata?: ...;
sensi_metadata?: ...;
smartthings_metadata?: ...;
tado_metadata?: ...;
tedee_metadata?: ...;
ttlock_metadata?: ...;
two_n_metadata?: ...;
ultraloq_metadata?: ...;
visionline_metadata?: ...;
wyze_metadata?: ...;
} & {
_experimental_supported_code_from_access_codes_lengths?: ...;
code_constraints?: ...;
door_open?: ...;
has_native_entry_events?: ...;
keypad_battery?: ...;
locked?: ...;
max_active_codes_supported?: ...;
supported_code_lengths?: ...;
supports_backup_access_code_pool?: ...;
} & {
active_thermostat_schedule?: ...;
active_thermostat_schedule_id?: ...;
available_climate_preset_modes?: ...;
available_climate_presets?: ...;
available_fan_mode_settings?: ...;
available_hvac_mode_settings?: ...;
current_climate_setting?: ...;
default_climate_setting?: ...;
fallback_climate_preset_key?: ...;
fan_mode_setting?: ...;
is_cooling?: ...;
is_fan_running?: ...;
is_heating?: ...;
is_temporary_manual_override_active?: ...;
max_cooling_set_point_celsius?: ...;
max_cooling_set_point_fahrenheit?: ...;
max_heating_set_point_celsius?: ...;
max_heating_set_point_fahrenheit?: ...;
max_thermostat_daily_program_periods_per_day?: ...;
max_unique_climate_presets_per_thermostat_weekly_program?: ...;
min_cooling_set_point_celsius?: ...;
min_cooling_set_point_fahrenheit?: ...;
min_heating_cooling_delta_celsius?: ...;
min_heating_cooling_delta_fahrenheit?: ...;
min_heating_set_point_celsius?: ...;
min_heating_set_point_fahrenheit?: ...;
relative_humidity?: ...;
temperature_celsius?: ...;
temperature_fahrenheit?: ...;
temperature_threshold?: ...;
thermostat_daily_program_period_precision_minutes?: ...;
thermostat_daily_programs?: ...;
thermostat_weekly_program?: ...;
};
space_ids: string[];
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: ... }
| { 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: ... }
| { 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: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
events?: (
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.changed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.scheduled_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.removed_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_setting_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_set_on_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
code: string
| null;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.delay_in_removing_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.failed_to_remove_from_device";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.modified_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.deleted_external_to_seam";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
backup_access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.backup_access_code_pulled";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.failed_to_convert_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.created";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "access_code.unmanaged.removed";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.created";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_all_doors";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_granted_to_door";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
acs_entrance_id: string;
created_at: string;
event_id: string;
event_type: "access_grant.access_to_door_lost";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_id: string;
access_grant_key?: string;
created_at: string;
ends_at?: string;
event_id: string;
event_type: "access_grant.access_times_changed";
occurred_at: string;
starts_at?: string;
workspace_id: string;
}
| {
access_grant_id: string;
created_at: string;
error_message: string;
event_id: string;
event_type: "access_grant.could_not_create_requested_access_methods";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: (...)[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.issued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: (...)[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.revoked";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: (...)[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.card_encoding_required";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: (...)[];
access_method_id: string;
created_at: string;
event_id: string;
event_type: "access_method.deleted";
occurred_at: string;
workspace_id: string;
}
| {
access_grant_ids: string[];
access_grant_keys?: (...)[];
access_method_id: string;
code?: string;
created_at: string;
event_id: string;
event_type: "access_method.reissued";
is_backup_code?: boolean;
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.connected";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_system.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.issued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.reissued";
occurred_at: string;
workspace_id: string;
}
| {
acs_credential_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_credential.invalidated";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.created";
occurred_at: string;
workspace_id: string;
}
| {
acs_system_id: string;
acs_user_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_user.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_encoder_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_encoder.removed";
occurred_at: string;
workspace_id: string;
}
| {
acs_access_group_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_access_group.deleted";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.added";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_id: string;
acs_system_id: string;
connected_account_id?: string;
created_at: string;
event_id: string;
event_type: "acs_entrance.removed";
occurred_at: string;
workspace_id: string;
}
| {
client_session_id: string;
created_at: string;
event_id: string;
event_type: "client_session.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id?: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.connected";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.created";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.successful_login";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_errors: (...)[];
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
connected_account_type?: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connected_account.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.completed_first_sync_after_reconnection";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
event_id: string;
event_type: "connected_account.reauthorization_requested";
occurred_at: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.lock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.succeeded";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
action_attempt_id: string;
action_type: string;
created_at: string;
event_id: string;
event_type: "action_attempt.unlock_door.failed";
occurred_at: string;
status: string;
workspace_id: string;
}
| {
connect_webview_id: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
customer_key?: string;
event_id: string;
event_type: "connect_webview.login_succeeded";
occurred_at: string;
workspace_id: string;
}
| {
connect_webview_id: string;
created_at: string;
event_id: string;
event_type: "connect_webview.login_failed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.added";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.converted_to_unmanaged";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.unmanaged.converted_to_managed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.unmanaged.connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
error_code:
| "account_disconnected"
| "hub_disconnected"
| "device_disconnected";
event_id: string;
event_type: "device.unmanaged.disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.tampered";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.low_battery";
occurred_at: string;
workspace_id: string;
}
| {
battery_level: number;
battery_status: "critical"
| "low"
| "good"
| "full";
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.battery_status_changed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.removed";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.deleted";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.third_party_integration_no_longer_detected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_activated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.salto.privacy_mode_deactivated";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.connection_became_flaky";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.connection_stabilized";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.error.subscription_required.resolved";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_connected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "device.accessory_keypad_disconnected";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "noise_sensor.noise_threshold_triggered";
minut_metadata?: { [x: ...]: ... };
noise_level_decibels?: number;
noise_level_nrs?: number;
noise_threshold_id?: string;
noise_threshold_name?: string;
noiseaware_metadata?: { [x: ...]: ... };
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "lock.locked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
workspace_id: string;
}
| {
access_code_id?: string;
access_code_is_managed?: boolean;
acs_entrance_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id?: string;
event_id: string;
event_type: "lock.unlocked";
method: "keycode" | "manual" | "automatic" | "unknown" | "seamapi";
occurred_at: string;
user_identity_id?: string;
workspace_id: string;
}
| {
access_code_id?: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "lock.access_denied";
occurred_at: string;
workspace_id: string;
}
| {
climate_preset_key: string;
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "thermostat.climate_preset_activated";
is_fallback_climate_preset: boolean;
occurred_at: string;
thermostat_schedule_id: string | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
cooling_set_point_celsius?: ...;
cooling_set_point_fahrenheit?: ...;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "thermostat.manually_adjusted";
fan_mode_setting?: ...;
heating_set_point_celsius?: ...;
heating_set_point_fahrenheit?: ...;
hvac_mode_setting?: ...;
method: "seam" | "external";
occurred_at: string;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_threshold_no_longer_exceeded";
lower_limit_celsius: number | null;
lower_limit_fahrenheit: number | null;
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
upper_limit_celsius: number | null;
upper_limit_fahrenheit: number | null;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
desired_temperature_celsius?: number;
desired_temperature_fahrenheit?: number;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_reached_set_point";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "thermostat.temperature_changed";
occurred_at: string;
temperature_celsius: number;
temperature_fahrenheit: number;
workspace_id: string;
}
| {
connected_account_custom_metadata?: { [x: ...]: ... };
connected_account_id: string;
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
device_name: string;
event_id: string;
event_type: "device.name_changed";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
enrollment_automation_id: string;
event_id: string;
event_type: "enrollment_automation.deleted";
occurred_at: string;
workspace_id: string;
}
| {
created_at: string;
device_custom_metadata?: { [x: ...]: ... };
device_id: string;
event_id: string;
event_type: "phone.deactivated";
occurred_at: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.device_membership_changed";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.created";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
| {
acs_entrance_ids: string[];
created_at: string;
device_ids: string[];
event_id: string;
event_type: "space.deleted";
occurred_at: string;
space_id: string;
space_key?: string;
workspace_id: string;
}
)[];
instant_keys?: {
client_session_id: string;
created_at: string;
customization?: {
logo_url?: string;
primary_color?: string;
secondary_color?: string;
};
customization_profile_id?: string;
expires_at: string;
instant_key_id: string;
instant_key_url: string;
user_identity_id: string;
workspace_id: string;
}[];
noise_thresholds?: {
device_id: string;
ends_daily_at: string;
name: string;
noise_threshold_decibels: number;
noise_threshold_id: string;
noise_threshold_nrs?: number;
starts_daily_at: string;
}[];
spaces?: {
acs_entrance_count: number;
created_at: string;
device_count: number;
display_name: string;
name: string;
parent_space_id?: string;
parent_space_key?: string;
space_id: string;
space_key?: string;
workspace_id: string;
}[];
thermostat_daily_programs?: {
created_at: string;
device_id: string;
name: string
| null;
periods: { climate_preset_key: string; starts_at_time: string }[];
thermostat_daily_program_id: string;
workspace_id: string;
}[];
thermostat_schedules?: {
climate_preset_key: string;
created_at: string;
device_id: string;
ends_at: string;
errors: { error_code: string; message: string }[];
is_override_allowed?: boolean;
max_override_period_minutes?: number | null;
name: string | null;
starts_at: string;
thermostat_schedule_id: string;
workspace_id: string;
}[];
unmanaged_access_codes?: {
access_code_id: string;
code: string
| null;
created_at: string;
device_id: string;
ends_at?: string | null;
errors: (
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at?: ...;
error_code: ...;
is_access_code_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
)[];
is_managed: false;
name: string
| null;
starts_at?: string | null;
status: "set";
type: "time_bound" | "ongoing";
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: ... }
| { 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: ... }
| { created_at?: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
unmanaged_acs_access_groups?: {
access_group_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
access_group_type_display_name: string;
acs_access_group_id: string;
acs_system_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
external_type: | "pti_unit"
| "pti_access_level"
| "salto_ks_access_group"
| "brivo_group"
| "salto_space_group"
| "dormakaba_community_access_group"
| "dormakaba_ambiance_access_group";
external_type_display_name: string;
is_managed: false;
name: string;
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
unmanaged_acs_credentials?: {
access_method: "code"
| "card"
| "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
assa_abloy_vostio_metadata?: {
auto_join?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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;
}[];
unmanaged_acs_users?: {
access_schedule?: { ends_at: string
| null; starts_at: string };
acs_system_id: string;
acs_user_id: string;
connected_account_id: string;
created_at: string;
display_name: string;
email?: string;
email_address?: string;
errors: (
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
| { created_at: ...; error_code: ...; message: ... }
)[];
external_type?:
| "pti_user"
| "brivo_user"
| "hid_credential_manager_user"
| "salto_site_user"
| "latch_user"
| "dormakaba_community_user"
| "salto_space_user";
external_type_display_name?: string;
full_name?: string;
hid_acs_system_id?: string;
is_managed: false;
is_suspended?: boolean;
last_successful_sync_at: string
| null;
pending_mutations?: (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
phone_number?: string;
salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
user_identity_email_address?: string | null;
user_identity_full_name?: string | null;
user_identity_id?: string;
user_identity_phone_number?: string | null;
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
unmanaged_devices?: {
can_hvac_cool?: boolean;
can_hvac_heat?: boolean;
can_hvac_heat_cool?: boolean;
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_program_thermostat_programs_as_different_each_day?: boolean;
can_program_thermostat_programs_as_same_each_day?: boolean;
can_program_thermostat_programs_as_weekday_weekend?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_run_thermostat_programs?: boolean;
can_simulate_connection?: boolean;
can_simulate_disconnection?: boolean;
can_simulate_hub_connection?: boolean;
can_simulate_hub_disconnection?: boolean;
can_simulate_paid_subscription?: boolean;
can_simulate_removal?: boolean;
can_turn_off_hvac?: boolean;
can_unlock_with_code?: boolean;
capabilities_supported: (
| "access_code"
| "lock"
| "noise_detection"
| "thermostat"
| "battery"
| "phone"
)[];
connected_account_id: string;
created_at: string;
custom_metadata: { [x: string]: string
| boolean };
device_id: string;
device_type:
| | "akuvox_lock"
| "august_lock"
| "brivo_access_point"
| "butterflymx_panel"
| "avigilon_alta_entry"
| "doorking_lock"
| "genie_door"
| "igloo_lock"
| "linear_lock"
| "lockly_lock"
| "kwikset_lock"
| "nuki_lock"
| "salto_lock"
| "schlage_lock"
| "seam_relay"
| "smartthings_lock"
| "wyze_lock"
| "yale_lock"
| "two_n_intercom"
| "controlbyweb_device"
| "ttlock_lock"
| "igloohome_lock"
| "hubitat_lock"
| "four_suites_door"
| "dormakaba_oracode_door"
| "tedee_lock"
| "akiles_lock"
| "ultraloq_lock"
| "korelock_lock"
| "keynest_key"
| "noiseaware_activity_zone"
| "minut_sensor"
|
| "ecobee_thermostat"
| "nest_thermostat"
| "honeywell_resideo_thermostat"
| "tado_thermostat"
| "sensi_thermostat"
| "smartthings_thermostat"
| "ios_phone"
| "android_phone";
errors: (
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_connected_account_error: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_device_error: ...;
message: ...;
}
| {
created_at: ...;
error_code: ...;
is_bridge_error?: ...;
is_connected_account_error?: ...;
message: ...;
}
)[];
is_managed: false;
location: { location_name?: string; timezone?: string }
| null;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
battery?: { level: number; status: (...)
| (...)
| (...)
| (...) };
battery_level?: number;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
};
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: ... }
| { 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: ... }
| { 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: ... }
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
user_identities?: {
acs_user_ids: string[];
created_at: string;
display_name: string;
email_address: string
| null;
errors: {
acs_system_id: string;
acs_user_id: string;
created_at: string;
error_code: "issue_with_acs_user";
message: string;
}[];
full_name: string
| null;
phone_number: string | null;
user_identity_id: string;
user_identity_key: string | null;
warnings: (
| { created_at: ...; message: ...; warning_code: ... }
| { created_at: ...; message: ...; warning_code: ... }
)[];
workspace_id: string;
}[];
workspaces?: {
company_name: string;
connect_partner_name: string | null
| null;
connect_webview_customization: {
inviter_logo_url?: string;
logo_shape?: (...) | (...);
primary_button_color?: string;
primary_button_text_color?: string;
success_message?: string;
};
is_publishable_key_auth_enabled: boolean;
is_sandbox: boolean;
is_suspended: boolean;
name: string;
publishable_key?: string;
workspace_id: string;
}[];
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/workspaces/find_anything";
}
/workspaces/get
"/workspaces/get": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
workspace: {
company_name: string;
connect_partner_name: string | null | null;
connect_webview_customization: {
inviter_logo_url?: string;
logo_shape?: "circle" | "square";
primary_button_color?: string;
primary_button_text_color?: string;
success_message?: string;
};
is_publishable_key_auth_enabled: boolean;
is_sandbox: boolean;
is_suspended: boolean;
name: string;
publishable_key?: string;
workspace_id: string;
};
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/workspaces/get";
}
/workspaces/list
"/workspaces/list": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
workspaces: {
company_name: string;
connect_partner_name: string | null | null;
connect_webview_customization: {
inviter_logo_url?: string;
logo_shape?: "circle" | "square";
primary_button_color?: string;
primary_button_text_color?: string;
success_message?: string;
};
is_publishable_key_auth_enabled: boolean;
is_sandbox: boolean;
is_suspended: boolean;
name: string;
publishable_key?: string;
workspace_id: string;
}[];
};
maxDuration: undefined;
method: "GET"
| "POST";
queryParams: {};
route: "/workspaces/list";
}
/workspaces/reset_sandbox
"/workspaces/reset_sandbox": {
commonParams: {};
formData: {};
jsonBody: {};
jsonResponse: {
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: | {
card_number: string
| null;
created_at: string | null;
ends_at: string | null;
is_issued: boolean | null;
starts_at: string | null;
visionline_metadata?: {
cancelled: boolean;
card_format: (...) | (...);
card_holder?: (...) | (...);
card_id: string;
common_acs_entrance_ids?: (...) | (...);
discarded: boolean;
expired: boolean;
guest_acs_entrance_ids?: (...) | (...);
number_of_issued_cards: number;
overridden?: (...) | (...);
overwritten: boolean;
pending_auto_update: boolean;
};
}
| null;
acs_credential_on_seam: | | {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: true;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| {
access_method: (...)
| (...)
| (...);
acs_credential_id: string;
acs_credential_pool_id?: (...) | (...);
acs_system_id: string;
acs_user_id?: (...) | (...);
assa_abloy_vostio_metadata?: (...) | (...);
card_number?: (...) | (...);
code?: (...) | (...);
connected_account_id: string;
created_at: string;
display_name: string;
ends_at?: (...) | (...);
errors: (...)[];
external_type?: (...) | (...);
external_type_display_name?: (...) | (...);
is_issued?: (...) | (...);
is_latest_desired_state_synced_with_provider?: (...) | (...);
is_managed: false;
is_multi_phone_sync_credential?: (...) | (...);
is_one_time_use?: (...) | (...);
issued_at?: (...) | (...);
latest_desired_state_synced_with_provider_at?: (...) | (...);
parent_acs_credential_id?: (...) | (...);
starts_at?: (...) | (...);
user_identity_id?: (...) | (...);
visionline_metadata?: (...) | (...);
warnings: (...)[];
workspace_id: string;
}
| null;
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" }
| { message: string; type: "no_card_on_encoder" };
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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?: boolean;
door_names?: (...)[];
endpoint_id?: string;
key_id?: string;
key_issuing_request_id?: string;
override_guest_acs_entrance_ids?: (...)[];
};
card_number?: string | undefined
| null;
code?: string | undefined | null;
connected_account_id: 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"
| "dormakaba_ambiance_credential"
| "hotek_card";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean
| null;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: string | undefined | null;
latest_desired_state_synced_with_provider_at?: string | null;
parent_acs_credential_id?: string;
starts_at?: string;
user_identity_id?: string;
visionline_metadata?: {
auto_join?: boolean;
card_function_type: "guest" | "staff";
card_id?: string;
common_acs_entrance_ids?: (...)[];
credential_id?: string;
guest_acs_entrance_ids?: (...)[];
is_valid?: boolean;
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" }
| { message: string; type: "no_card_on_encoder" };
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";
};
};
maxDuration: undefined;
method: "POST";
queryParams: {};
route: "/workspaces/reset_sandbox";
}
/workspaces/update
"/workspaces/update": {
commonParams: {};
formData: {};
jsonBody: {
connect_partner_name?: string;
connect_webview_customization?: {
logo_shape?: "circle" | "square" | null;
primary_button_color?: string | null;
primary_button_text_color?: string | null;
success_message?: string | null;
};
is_publishable_key_auth_enabled?: boolean;
is_suspended?: boolean;
name?: string;
};
jsonResponse: {};
maxDuration: undefined;
method: "POST"
| "PATCH";
queryParams: {};
route: "/workspaces/update";
}