Interface Routes

interface Routes {
    /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;
            starts_at?: string;
            sync?: boolean;
            use_backup_access_code_pool?: boolean;
            use_offline_access_code?: boolean;
        };
        jsonResponse: {
            access_code: {
                access_code_id: string;
                code: null | string;
                common_code_key: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_backup?: boolean;
                is_backup_access_code_available: boolean;
                is_external_modification_allowed: boolean;
                is_managed: true;
                is_offline_access_code: boolean;
                is_one_time_use: boolean;
                is_scheduled_on_device?: boolean;
                is_waiting_for_code_assignment?: boolean;
                name: null | string;
                pulled_backup_access_code_id?: null | string;
                starts_at?: null | string;
                status: "set" | "unknown" | "setting" | "unset" | "removing";
                type: "time_bound" | "ongoing";
                warnings?: any;
            };
            action_attempt: {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST";
        queryParams: {};
        route: "/access_codes/create";
    };
    /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;
            is_offline_access_code?: boolean;
            is_one_time_use?: boolean;
            max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
            name?: string;
            prefer_native_scheduling?: boolean;
            starts_at?: string;
            use_backup_access_code_pool?: boolean;
            use_offline_access_code?: boolean;
        };
        jsonResponse: {
            access_codes: {
                access_code_id: string;
                code: null | string;
                common_code_key: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_backup?: boolean;
                is_backup_access_code_available: boolean;
                is_external_modification_allowed: boolean;
                is_managed: true;
                is_offline_access_code: boolean;
                is_one_time_use: boolean;
                is_scheduled_on_device?: boolean;
                is_waiting_for_code_assignment?: boolean;
                name: null | string;
                pulled_backup_access_code_id?: null | string;
                starts_at?: null | string;
                status: "set" | "unknown" | "setting" | "unset" | "removing";
                type: "time_bound" | "ongoing";
                warnings?: any;
            }[];
        };
        method: "POST" | "PUT";
        queryParams: {};
        route: "/access_codes/create_multiple";
    };
    /access_codes/delete: {
        commonParams: {
            access_code_id: string;
            device_id?: string;
            sync?: boolean;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            action_attempt: {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/access_codes/delete";
    };
    /access_codes/generate_code: {
        commonParams: {
            device_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            generated_code: {
                code: string;
                device_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/access_codes/generate_code";
    };
    /access_codes/get: {
        commonParams: {
            access_code_id?: string;
            code?: string;
            device_id?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            access_code: {
                access_code_id: string;
                code: null | string;
                common_code_key: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_backup?: boolean;
                is_backup_access_code_available: boolean;
                is_external_modification_allowed: boolean;
                is_managed: true;
                is_offline_access_code: boolean;
                is_one_time_use: boolean;
                is_scheduled_on_device?: boolean;
                is_waiting_for_code_assignment?: boolean;
                name: null | string;
                pulled_backup_access_code_id?: null | string;
                starts_at?: null | string;
                status: "set" | "unknown" | "setting" | "unset" | "removing";
                type: "time_bound" | "ongoing";
                warnings?: any;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/access_codes/get";
    };
    /access_codes/list: {
        commonParams: {
            access_code_ids?: string[];
            device_id?: string;
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            access_codes: {
                access_code_id: string;
                code: null | string;
                common_code_key: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_backup?: boolean;
                is_backup_access_code_available: boolean;
                is_external_modification_allowed: boolean;
                is_managed: true;
                is_offline_access_code: boolean;
                is_one_time_use: boolean;
                is_scheduled_on_device?: boolean;
                is_waiting_for_code_assignment?: boolean;
                name: null | string;
                pulled_backup_access_code_id?: null | string;
                starts_at?: null | string;
                status: "set" | "unknown" | "setting" | "unset" | "removing";
                type: "time_bound" | "ongoing";
                warnings?: any;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/access_codes/list";
    };
    /access_codes/pull_backup_access_code: {
        commonParams: {};
        formData: {};
        jsonBody: {
            access_code_id: string;
        };
        jsonResponse: {
            backup_access_code: {
                access_code_id: string;
                code: null | string;
                common_code_key: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_backup?: boolean;
                is_backup_access_code_available: boolean;
                is_external_modification_allowed: boolean;
                is_managed: true;
                is_offline_access_code: boolean;
                is_one_time_use: boolean;
                is_scheduled_on_device?: boolean;
                is_waiting_for_code_assignment?: boolean;
                name: null | string;
                pulled_backup_access_code_id?: null | string;
                starts_at?: null | string;
                status: "set" | "unknown" | "setting" | "unset" | "removing";
                type: "time_bound" | "ongoing";
                warnings?: any;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/access_codes/pull_backup_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: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_managed: false;
                name: null | string;
                starts_at?: null | string;
                status: "set";
                type: "time_bound" | "ongoing";
                warnings?: any;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/access_codes/simulate/create_unmanaged_access_code";
    };
    /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: {};
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/access_codes/unmanaged/convert_to_managed";
    };
    /access_codes/unmanaged/delete: {
        commonParams: {
            access_code_id: string;
            sync?: boolean;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            action_attempt: {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/access_codes/unmanaged/delete";
    };
    /access_codes/unmanaged/get: {
        commonParams: {
            access_code_id?: string;
            code?: string;
            device_id?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            access_code: {
                access_code_id: string;
                code: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_managed: false;
                name: null | string;
                starts_at?: null | string;
                status: "set";
                type: "time_bound" | "ongoing";
                warnings?: any;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/access_codes/unmanaged/get";
    };
    /access_codes/unmanaged/list: {
        commonParams: {
            device_id: string;
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            access_codes: {
                access_code_id: string;
                code: null | string;
                created_at: string;
                device_id: string;
                ends_at?: null | string;
                errors?: any;
                is_managed: false;
                name: null | string;
                starts_at?: null | string;
                status: "set";
                type: "time_bound" | "ongoing";
                warnings?: any;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/access_codes/unmanaged/list";
    };
    /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: {};
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/access_codes/unmanaged/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;
            starts_at?: string;
            sync?: boolean;
            type?: "time_bound" | "ongoing";
            use_backup_access_code_pool?: boolean;
            use_offline_access_code?: boolean;
        };
        jsonResponse: {
            action_attempt: {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST" | "PUT" | "PATCH";
        queryParams: {};
        route: "/access_codes/update";
    };
    /acs/access_groups/add_user: {
        commonParams: {
            acs_access_group_id: string;
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "PUT";
        queryParams: {};
        route: "/acs/access_groups/add_user";
    };
    /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_access_group" | "brivo_group";
                access_group_type_display_name: string;
                acs_access_group_id: string;
                acs_system_id: string;
                created_at: string;
                external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
                external_type_display_name: string;
                name: string;
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/access_groups/get";
    };
    /acs/access_groups/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_access_group" | "brivo_group";
                access_group_type_display_name: string;
                acs_access_group_id: string;
                acs_system_id: string;
                created_at: string;
                external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
                external_type_display_name: string;
                name: string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/access_groups/list";
    };
    /acs/access_groups/list_users: {
        commonParams: {
            acs_access_group_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_users: {
                acs_system_id: string;
                acs_user_id: string;
                created_at: string;
                display_name: string;
                email?: string;
                email_address?: string;
                ends_at?: string;
                external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
                external_type_display_name?: string;
                full_name?: string;
                hid_acs_system_id?: string;
                is_suspended: boolean;
                is_virtual: boolean;
                phone_number?: string;
                starts_at?: string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/access_groups/list_users";
    };
    /acs/access_groups/remove_user: {
        commonParams: {
            acs_access_group_id: string;
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/acs/access_groups/remove_user";
    };
    /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;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/credential_pools/list";
    };
    /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;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/acs/credential_provisioning_automations/launch";
    };
    /acs/credentials/assign: {
        commonParams: {};
        formData: {};
        jsonBody: {
            acs_credential_id: string;
            acs_user_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;
                code?: null | string;
                created_at: string;
                display_name: string;
                external_type: "pti_card" | "brivo_credential" | "hid_credential";
                external_type_display_name: string;
                workspace_id: string;
            };
        };
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/acs/credentials/assign";
    };
    /acs/credentials/create: {
        commonParams: {
            access_method: "code" | "card" | "mobile_key";
            acs_user_id: string;
            code?: 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;
                code?: null | string;
                created_at: string;
                display_name: string;
                external_type: "pti_card" | "brivo_credential" | "hid_credential";
                external_type_display_name: string;
                workspace_id: string;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/acs/credentials/create";
    };
    /acs/credentials/delete: {
        commonParams: {
            acs_credential_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/acs/credentials/delete";
    };
    /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;
                code?: null | string;
                created_at: string;
                display_name: string;
                external_type: "pti_card" | "brivo_credential" | "hid_credential";
                external_type_display_name: string;
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/credentials/get";
    };
    /acs/credentials/list: {
        commonParams: {
            acs_user_id: string;
        } | {
            acs_system_id: string;
        } | {
            acs_system_id: string;
            acs_user_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;
                code?: null | string;
                created_at: string;
                display_name: string;
                external_type: "pti_card" | "brivo_credential" | "hid_credential";
                external_type_display_name: string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/credentials/list";
    };
    /acs/credentials/unassign: {
        commonParams: {};
        formData: {};
        jsonBody: {
            acs_credential_id: string;
            acs_user_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;
                code?: null | string;
                created_at: string;
                display_name: string;
                external_type: "pti_card" | "brivo_credential" | "hid_credential";
                external_type_display_name: string;
                workspace_id: string;
            };
        };
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/acs/credentials/unassign";
    };
    /acs/credentials/update: {
        commonParams: {};
        formData: {};
        jsonBody: {
            acs_credential_id: string;
            code: 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;
                code?: null | string;
                created_at: string;
                display_name: string;
                external_type: "pti_card" | "brivo_credential" | "hid_credential";
                external_type_display_name: string;
                workspace_id: string;
            };
        };
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/acs/credentials/update";
    };
    /acs/entrances/get: {
        commonParams: {
            acs_entrance_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_entrance: {
                acs_entrance_id: string;
                acs_system_id: string;
                created_at: string;
                display_name: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/entrances/get";
    };
    /acs/entrances/grant_access: {
        commonParams: {};
        formData: {};
        jsonBody: {
            acs_entrance_id: string;
            acs_user_id: string;
        };
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/acs/entrances/grant_access";
    };
    /acs/entrances/list: {
        commonParams: {
            acs_system_id?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_entrances: {
                acs_entrance_id: string;
                acs_system_id: string;
                created_at: string;
                display_name: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/entrances/list";
    };
    /acs/systems/get: {
        commonParams: {
            acs_system_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_system: {
                acs_system_id: string;
                connected_account_ids: string[];
                created_at: string;
                external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
                external_type_display_name: string;
                name: string;
                system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
                system_type_display_name: string;
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/systems/get";
    };
    /acs/systems/list: {
        commonParams: {
            connected_account_id?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_systems: {
                acs_system_id: string;
                connected_account_ids: string[];
                created_at: string;
                external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
                external_type_display_name: string;
                name: string;
                system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
                system_type_display_name: string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/systems/list";
    };
    /acs/users/add_to_access_group: {
        commonParams: {
            acs_access_group_id: string;
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "PUT";
        queryParams: {};
        route: "/acs/users/add_to_access_group";
    };
    /acs/users/create: {
        commonParams: {};
        formData: {};
        jsonBody: {
            access_schedule?: {
                ends_at: string;
                starts_at: string;
            };
            acs_access_group_ids?: string[];
            acs_system_id: string;
            email?: string;
            email_address?: string;
            full_name?: string;
            phone_number?: string;
        };
        jsonResponse: {
            acs_user: {
                acs_system_id: string;
                acs_user_id: string;
                created_at: string;
                display_name: string;
                email?: string;
                email_address?: string;
                ends_at?: string;
                external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
                external_type_display_name?: string;
                full_name?: string;
                hid_acs_system_id?: string;
                is_suspended: boolean;
                is_virtual: boolean;
                phone_number?: string;
                starts_at?: string;
                workspace_id: string;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/acs/users/create";
    };
    /acs/users/delete: {
        commonParams: {
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/acs/users/delete";
    };
    /acs/users/get: {
        commonParams: {
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_user: {
                acs_system_id: string;
                acs_user_id: string;
                created_at: string;
                display_name: string;
                email?: string;
                email_address?: string;
                ends_at?: string;
                external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
                external_type_display_name?: string;
                full_name?: string;
                hid_acs_system_id?: string;
                is_suspended: boolean;
                is_virtual: boolean;
                phone_number?: string;
                starts_at?: string;
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/users/get";
    };
    /acs/users/list: {
        commonParams: {
            acs_system_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_users: {
                acs_system_id: string;
                acs_user_id: string;
                created_at: string;
                display_name: string;
                email?: string;
                email_address?: string;
                ends_at?: string;
                external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
                external_type_display_name?: string;
                full_name?: string;
                hid_acs_system_id?: string;
                is_suspended: boolean;
                is_virtual: boolean;
                phone_number?: string;
                starts_at?: string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/acs/users/list";
    };
    /acs/users/remove_from_access_group: {
        commonParams: {
            acs_access_group_id: string;
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/acs/users/remove_from_access_group";
    };
    /acs/users/suspend: {
        commonParams: {
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/acs/users/suspend";
    };
    /acs/users/unsuspend: {
        commonParams: {
            acs_user_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/acs/users/unsuspend";
    };
    /acs/users/update: {
        commonParams: {};
        formData: {};
        jsonBody: {
            acs_user_id: string;
            email?: string;
            email_address?: string;
            full_name?: string;
            hid_acs_system_id?: string;
            phone_number?: string;
        };
        jsonResponse: {};
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/acs/users/update";
    };
    /action_attempts/get: {
        commonParams: {
            action_attempt_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            action_attempt: {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/action_attempts/get";
    };
    /action_attempts/list: {
        commonParams: {
            action_attempt_ids: string[];
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            action_attempts: ({
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            })[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/action_attempts/list";
    };
    /client_sessions/create: {
        commonParams: {};
        formData: {};
        jsonBody: {
            connect_webview_ids?: string[];
            connected_account_ids?: string[];
            expires_at?: Date;
            user_identifier_key?: string;
            user_identity_ids?: string[];
        };
        jsonResponse: {
            client_session: {
                client_session_id: string;
                created_at: string;
                token: string;
                user_identifier_key: null | string;
                workspace_id: string;
            };
        };
        method: "POST" | "PUT";
        queryParams: {};
        route: "/client_sessions/create";
    };
    /client_sessions/delete: {
        commonParams: {
            client_session_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/client_sessions/delete";
    };
    /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;
                device_count: number;
                token: string;
                user_identifier_key: null | string;
                user_identity_ids: string[];
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/client_sessions/get";
    };
    /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_ids?: string[];
        };
        jsonResponse: {
            client_session: {
                client_session_id: string;
                created_at: string;
                token: string;
                user_identifier_key: null | string;
                workspace_id: string;
            };
        };
        method: "POST" | "PUT";
        queryParams: {};
        route: "/client_sessions/get_or_create";
    };
    /client_sessions/grant_access: {
        commonParams: {
            client_session_id?: string;
            connect_webview_ids?: string[];
            connected_account_ids?: string[];
            user_identifier_key?: 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;
                device_count: number;
                token: string;
                user_identifier_key: null | string;
                user_identity_ids: string[];
                workspace_id: string;
            };
        };
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/client_sessions/grant_access";
    };
    /client_sessions/list: {
        commonParams: {
            client_session_id?: string;
            connect_webview_id?: string;
            user_identifier_key?: 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;
                device_count: number;
                user_identifier_key: null | string;
                user_identity_ids: string[];
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/client_sessions/list";
    };
    /client_sessions/revoke: {
        commonParams: {
            client_session_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/client_sessions/revoke";
    };
    /connect_webviews/create: {
        commonParams: {};
        formData: {};
        jsonBody: {
            accepted_providers?: ("linear" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "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" | "yale_access" | "hid_cm")[];
            automatically_manage_new_devices?: boolean;
            custom_metadata?: Record<string, null | string | number | boolean>;
            custom_redirect_failure_url?: string;
            custom_redirect_url?: string;
            device_selection_mode?: "none" | "multiple" | "single";
            provider_category?: "stable" | "consumer_smartlocks" | "internal_beta";
            wait_for_device_creation?: boolean;
        };
        jsonResponse: {
            connect_webview: {
                accepted_devices: string[];
                accepted_providers: string[];
                any_device_allowed: boolean;
                any_provider_allowed: boolean;
                authorized_at: null | string;
                automatically_manage_new_devices: boolean;
                connect_webview_id: string;
                connected_account_id?: string;
                created_at: string;
                custom_metadata: Record<string, null | string | number | boolean>;
                custom_redirect_failure_url: null | string;
                custom_redirect_url: null | string;
                device_selection_mode: "none" | "multiple" | "single";
                login_successful: boolean;
                selected_provider: null | string;
                status: "failed" | "pending" | "authorized";
                url: string;
                wait_for_device_creation: boolean;
                workspace_id: string;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/connect_webviews/create";
    };
    /connect_webviews/delete: {
        commonParams: {};
        formData: {};
        jsonBody: {
            connect_webview_id: string;
        };
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/connect_webviews/delete";
    };
    /connect_webviews/get: {
        commonParams: {
            connect_webview_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            connect_webview: {
                accepted_devices: string[];
                accepted_providers: string[];
                any_device_allowed: boolean;
                any_provider_allowed: boolean;
                authorized_at: null | string;
                automatically_manage_new_devices: boolean;
                connect_webview_id: string;
                connected_account_id?: string;
                created_at: string;
                custom_metadata: Record<string, null | string | number | boolean>;
                custom_redirect_failure_url: null | string;
                custom_redirect_url: null | string;
                device_selection_mode: "none" | "multiple" | "single";
                login_successful: boolean;
                selected_provider: null | string;
                status: "failed" | "pending" | "authorized";
                url: string;
                wait_for_device_creation: boolean;
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/connect_webviews/get";
    };
    /connect_webviews/list: {
        commonParams: {
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            connect_webviews: {
                accepted_devices: string[];
                accepted_providers: string[];
                any_device_allowed: boolean;
                any_provider_allowed: boolean;
                authorized_at: null | string;
                automatically_manage_new_devices: boolean;
                connect_webview_id: string;
                connected_account_id?: string;
                created_at: string;
                custom_metadata: Record<string, null | string | number | boolean>;
                custom_redirect_failure_url: null | string;
                custom_redirect_url: null | string;
                device_selection_mode: "none" | "multiple" | "single";
                login_successful: boolean;
                selected_provider: null | string;
                status: "failed" | "pending" | "authorized";
                url: string;
                wait_for_device_creation: boolean;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/connect_webviews/list";
    };
    /connect_webviews/view: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "GET";
        queryParams: {
            auth_token: string;
            connect_webview_id: string;
        };
        route: "/connect_webviews/view";
    };
    /connected_accounts/delete: {
        commonParams: {};
        formData: {};
        jsonBody: {
            connected_account_id: string;
            sync?: boolean;
        };
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/connected_accounts/delete";
    };
    /connected_accounts/get: {
        commonParams: {
            connected_account_id: string;
        } | {
            email: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            connected_account: {
                account_type?: string;
                account_type_display_name: string;
                automatically_manage_new_devices: boolean;
                connected_account_id?: string;
                created_at?: string;
                custom_metadata?: Record<string, null | string | number | boolean>;
                errors?: any;
                user_identifier?: {
                    api_url?: string;
                    email?: string;
                    exclusive?: boolean;
                    phone?: string;
                    username?: string;
                };
                warnings?: any;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/connected_accounts/get";
    };
    /connected_accounts/list: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            connected_accounts: {
                account_type?: string;
                account_type_display_name: string;
                automatically_manage_new_devices: boolean;
                connected_account_id?: string;
                created_at?: string;
                custom_metadata?: Record<string, null | string | number | boolean>;
                errors?: any;
                user_identifier?: {
                    api_url?: string;
                    email?: string;
                    exclusive?: boolean;
                    phone?: string;
                    username?: string;
                };
                warnings?: any;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/connected_accounts/list";
    };
    /connected_accounts/update: {
        commonParams: {};
        formData: {};
        jsonBody: {
            automatically_manage_new_devices?: boolean;
            connected_account_id: string;
        };
        jsonResponse: {
            connected_account: {
                account_type?: string;
                account_type_display_name: string;
                automatically_manage_new_devices: boolean;
                connected_account_id?: string;
                created_at?: string;
                custom_metadata?: Record<string, null | string | number | boolean>;
                errors?: any;
                user_identifier?: {
                    api_url?: string;
                    email?: string;
                    exclusive?: boolean;
                    phone?: string;
                    username?: string;
                };
                warnings?: any;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/connected_accounts/update";
    };
    /devices/delete: {
        commonParams: {
            device_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/devices/delete";
    };
    /devices/get: {
        commonParams: {
            device_id?: string;
            name?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            device: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/devices/get";
    };
    /devices/list: {
        commonParams: {
            connect_webview_id?: string;
            connected_account_id?: string;
            connected_account_ids?: string[];
            created_before?: Date;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
            limit?: number;
            manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            devices: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/devices/list";
    };
    /devices/list_device_providers: {
        commonParams: {
            provider_category?: "stable" | "consumer_smartlocks";
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            device_providers: {
                device_provider_name: string;
                display_name: string;
                image_url: string;
                provider_categories: ("stable" | "consumer_smartlocks")[];
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/devices/list_device_providers";
    };
    /devices/unmanaged/get: {
        commonParams: {
            device_id?: string;
            name?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            device: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: false;
                properties: {
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    image_alt_text?: string;
                    image_url?: string;
                    manufacturer?: string;
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        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: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/devices/unmanaged/get";
    };
    /devices/unmanaged/list: {
        commonParams: {
            connect_webview_id?: string;
            connected_account_id?: string;
            connected_account_ids?: string[];
            created_before?: Date;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
            limit?: number;
            manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            devices: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: false;
                properties: {
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    image_alt_text?: string;
                    image_url?: string;
                    manufacturer?: string;
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        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: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/devices/unmanaged/list";
    };
    /devices/unmanaged/update: {
        commonParams: {
            device_id: string;
            is_managed: true;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/devices/unmanaged/update";
    };
    /devices/update: {
        commonParams: {
            device_id: string;
            is_managed?: boolean;
            location?: {};
            name?: null | string;
            properties?: {
                name?: null | string;
            };
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/devices/update";
    };
    /events/get: {
        commonParams: {
            device_id?: string;
            event_id?: string;
            event_type?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            event?: {
                created_at: string;
                device_id?: string;
                event_id: string;
                event_type: string;
                occurred_at: string;
                workspace_id: string;
            };
            message?: string;
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/events/get";
    };
    /events/list: {
        commonParams: {
            access_code_id?: string;
            access_code_ids?: string[];
            between?: (string | Date)[];
            connected_account_id?: string;
            device_id?: string;
            device_ids?: string[];
            event_type?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled";
            event_types?: ("device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled")[];
            since?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            events?: {
                created_at: string;
                device_id?: string;
                event_id: string;
                event_type: string;
                occurred_at: string;
                workspace_id: string;
            }[];
            message?: string;
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/events/list";
    };
    /health: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            last_service_evaluation_at?: string;
            msg: "I’m one with the Force. The Force is with me.";
            ok: boolean;
            service_health_statuses: {
                description: string;
                service: string;
                status: "healthy" | "degraded" | "down";
            }[];
        };
        method: "GET";
        queryParams: {};
        route: "/health";
    };
    /health/get_health: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            last_service_evaluation_at?: string;
            msg: "I’m one with the Force. The Force is with me.";
            ok: boolean;
            service_health_statuses: {
                description: string;
                service: string;
                status: "healthy" | "degraded" | "down";
            }[];
        };
        method: "GET";
        queryParams: {};
        route: "/health/get_health";
    };
    /health/get_service_health: {
        commonParams: {
            service: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            last_service_evaluation_at: string;
            ok: true;
            service_health: {
                description: string;
                service: string;
                status: "healthy" | "degraded" | "down";
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/health/get_service_health";
    };
    /health/service/[service_name]: {
        commonParams: {
            service_name: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            last_service_evaluation_at: string;
            ok: true;
            service_health: {
                description: string;
                service: string;
                status: "healthy" | "degraded" | "down";
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/health/service/[service_name]";
    };
    /locks/get: {
        commonParams: {
            device_id?: string;
            name?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            device: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            };
            lock: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/locks/get";
    };
    /locks/list: {
        commonParams: {
            connect_webview_id?: string;
            connected_account_id?: string;
            connected_account_ids?: string[];
            created_before?: Date;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
            limit?: number;
            manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            devices: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            }[];
            locks: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/locks/list";
    };
    /locks/lock_door: {
        commonParams: {};
        formData: {};
        jsonBody: {
            device_id: string;
            sync?: boolean;
        };
        jsonResponse: {
            action_attempt: {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST";
        queryParams: {};
        route: "/locks/lock_door";
    };
    /locks/unlock_door: {
        commonParams: {};
        formData: {};
        jsonBody: {
            device_id: string;
            sync?: boolean;
        };
        jsonResponse: {
            action_attempt: {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST";
        queryParams: {};
        route: "/locks/unlock_door";
    };
    /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: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                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;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/noise_sensors/noise_thresholds/create";
    };
    /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: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/noise_sensors/noise_thresholds/delete";
    };
    /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;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/noise_sensors/noise_thresholds/get";
    };
    /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;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/noise_sensors/noise_thresholds/list";
    };
    /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: string;
                error: null;
                result?: any;
                status: "success";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: null;
                result: null;
                status: "pending";
            } | {
                action_attempt_id: string;
                action_type: string;
                error: {
                    message: string;
                    type: string;
                };
                result: null;
                status: "error";
            };
        };
        method: "POST" | "PUT" | "PATCH";
        queryParams: {};
        route: "/noise_sensors/noise_thresholds/update";
    };
    /noise_sensors/simulate/trigger_noise_threshold: {
        commonParams: {};
        formData: {};
        jsonBody: {
            device_id: string;
        };
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/noise_sensors/simulate/trigger_noise_threshold";
    };
    /thermostats/climate_setting_schedules/create: {
        commonParams: {};
        formData: {};
        jsonBody: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            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?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type?: "time_bound";
        };
        jsonResponse: {
            climate_setting_schedule: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
        };
        method: "POST";
        queryParams: {};
        route: "/thermostats/climate_setting_schedules/create";
    };
    /thermostats/climate_setting_schedules/delete: {
        commonParams: {
            climate_setting_schedule_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "PUT" | "DELETE";
        queryParams: {};
        route: "/thermostats/climate_setting_schedules/delete";
    };
    /thermostats/climate_setting_schedules/get: {
        commonParams: {
            climate_setting_schedule_id?: string;
            device_id?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            climate_setting_schedule: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/thermostats/climate_setting_schedules/get";
    };
    /thermostats/climate_setting_schedules/list: {
        commonParams: {
            device_id: string;
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            climate_setting_schedules: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/thermostats/climate_setting_schedules/list";
    };
    /thermostats/climate_setting_schedules/update: {
        commonParams: {};
        formData: {};
        jsonBody: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at?: string;
            schedule_starts_at?: string;
            schedule_type?: "time_bound";
        };
        jsonResponse: {
            climate_setting_schedule: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
        };
        method: "POST" | "PUT" | "PATCH";
        queryParams: {};
        route: "/thermostats/climate_setting_schedules/update";
    };
    /thermostats/cool: {
        commonParams: {};
        formData: {};
        jsonBody: {
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            device_id: string;
            sync?: boolean;
        };
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/thermostats/cool";
    };
    /thermostats/get: {
        commonParams: {
            device_id?: string;
            name?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            thermostat: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/thermostats/get";
    };
    /thermostats/heat: {
        commonParams: {};
        formData: {};
        jsonBody: {
            device_id: string;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            sync?: boolean;
        };
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/thermostats/heat";
    };
    /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: {};
        method: "POST";
        queryParams: {};
        route: "/thermostats/heat_cool";
    };
    /thermostats/list: {
        commonParams: {
            connect_webview_id?: string;
            connected_account_id?: string;
            connected_account_ids?: string[];
            created_before?: Date;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
            limit?: number;
            manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
            user_identifier_key?: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            thermostats: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/thermostats/list";
    };
    /thermostats/off: {
        commonParams: {};
        formData: {};
        jsonBody: {
            device_id: string;
            sync?: boolean;
        };
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/thermostats/off";
    };
    /thermostats/set_fan_mode: {
        commonParams: {};
        formData: {};
        jsonBody: {
            device_id: string;
            fan_mode?: "auto" | "on";
            fan_mode_setting?: "auto" | "on";
            sync?: boolean;
        };
        jsonResponse: {};
        method: "POST";
        queryParams: {};
        route: "/thermostats/set_fan_mode";
    };
    /thermostats/update: {
        commonParams: {};
        formData: {};
        jsonBody: {
            default_climate_setting: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
            };
            device_id: string;
        };
        jsonResponse: {};
        method: "POST" | "PATCH";
        queryParams: {};
        route: "/thermostats/update";
    };
    /user_identities/add_acs_user: {
        commonParams: {
            acs_user_id: string;
            user_identity_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "PUT";
        queryParams: {};
        route: "/user_identities/add_acs_user";
    };
    /user_identities/create: {
        commonParams: {
            email_address?: null | string;
            first_name?: null | string;
            last_name?: null | string;
            user_identity_key?: null | string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            user_identity: {
                created_at: string;
                email_address?: null | string;
                first_name?: null | string;
                last_name?: null | string;
                user_identity_id: string;
                user_identity_key?: null | string;
                workspace_id: string;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/user_identities/create";
    };
    /user_identities/get: {
        commonParams: {
            user_identity_id: string;
        } | {
            user_identity_key: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            user_identity: {
                created_at: string;
                email_address?: null | string;
                first_name?: null | string;
                last_name?: null | string;
                user_identity_id: string;
                user_identity_key?: null | string;
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/user_identities/get";
    };
    /user_identities/grant_access_to_device: {
        commonParams: {
            device_id: string;
            user_identity_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "PUT";
        queryParams: {};
        route: "/user_identities/grant_access_to_device";
    };
    /user_identities/list: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            user_identities: {
                created_at: string;
                email_address?: null | string;
                first_name?: null | string;
                last_name?: null | string;
                user_identity_id: string;
                user_identity_key?: null | string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/user_identities/list";
    };
    /user_identities/list_accessible_devices: {
        commonParams: {
            user_identity_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            accessible_devices: {
                capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
                connected_account_id: string;
                created_at: string;
                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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
                errors: {
                    error_code: string;
                    message: string;
                }[];
                is_managed: true;
                location: null | {
                    location_name?: string;
                    timezone?: string;
                };
                properties: {
                    active_climate_setting_schedule?: {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    } | {
                        automatic_cooling_enabled?: boolean;
                        automatic_heating_enabled?: boolean;
                        climate_setting_schedule_id: string;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        created_at: string;
                        device_id: string;
                        errors?: any;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed?: boolean;
                        name?: string;
                        schedule_ends_at: string;
                        schedule_starts_at: string;
                        schedule_type: "time_bound";
                    };
                    august_metadata?: {
                        has_keypad: boolean;
                        house_id?: string;
                        house_name: string;
                        keypad_battery_level?: string;
                        lock_id: string;
                        lock_name: string;
                        model?: string;
                    };
                    available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                    avigilon_alta_metadata?: {
                        entry_name: string;
                        org_name: string;
                        site_id: number;
                        site_name: string;
                        zone_id: number;
                        zone_name: string;
                    };
                    battery?: {
                        level: number;
                        status: "low" | "full" | "critical" | "good";
                    };
                    battery_level?: number;
                    brivo_metadata?: {
                        device_name: string;
                    };
                    can_enable_automatic_cooling?: boolean;
                    can_enable_automatic_heating?: boolean;
                    code_constraints?: ({
                        constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                    } | {
                        constraint_type: "name_length";
                        max_length?: number;
                        min_length?: number;
                    })[];
                    controlbyweb_metadata?: {
                        device_id: string;
                        device_name: string;
                        relay_name: null | string;
                    };
                    current_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    default_climate_setting?: {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    } | {
                        automatic_cooling_enabled: boolean;
                        automatic_heating_enabled: boolean;
                        cooling_set_point_celsius?: number;
                        cooling_set_point_fahrenheit?: number;
                        heating_set_point_celsius?: number;
                        heating_set_point_fahrenheit?: number;
                        hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                        manual_override_allowed: boolean;
                    };
                    door_open?: boolean;
                    dormakaba_oracode_metadata?: {
                        device_id?: number;
                        door_id: number;
                        door_name: string;
                        iana_timezone?: string;
                        predefined_time_slots?: {
                            check_in_time: string;
                            check_out_time: string;
                            dormakaba_oracode_user_level_id: string;
                            ext_dormakaba_oracode_user_level_prefix: number;
                            is_24_hour: boolean;
                            is_biweekly_mode: boolean;
                            is_master: boolean;
                            is_one_shot: boolean;
                            name: string;
                            prefix: number;
                        }[];
                        site_id: number;
                        site_name: string;
                    };
                    ecobee_metadata?: {
                        device_name: string;
                        ecobee_device_id: string;
                    };
                    fan_mode_setting?: "auto" | "on";
                    four_suites_metadata?: {
                        device_id: number;
                        device_name: string;
                        reclose_delay_in_seconds: number;
                    };
                    genie_metadata?: {
                        device_name: string;
                        door_name: string;
                    };
                    has_direct_power?: boolean;
                    has_native_entry_events?: boolean;
                    hubitat_metadata?: {
                        device_id: string;
                        device_label: string;
                        device_name: string;
                    };
                    igloo_metadata?: {
                        bridge_id: string;
                        device_id: string;
                        model?: string;
                    };
                    igloohome_metadata?: {
                        bridge_id?: string;
                        bridge_name?: string;
                        device_id: string;
                        device_name: string;
                    };
                    image_alt_text?: string;
                    image_url?: string;
                    is_climate_setting_schedule_active?: boolean;
                    is_cooling?: boolean;
                    is_cooling_available?: boolean;
                    is_fan_running?: boolean;
                    is_heating?: boolean;
                    is_heating_available?: boolean;
                    is_temporary_manual_override_active?: boolean;
                    keypad_battery?: {
                        level: number;
                    };
                    kwikset_metadata?: {
                        device_id: string;
                        device_name: string;
                        model_number: string;
                    };
                    locked?: boolean;
                    lockly_metadata?: {
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    manufacturer?: string;
                    max_active_codes_supported?: number;
                    minut_metadata?: {
                        device_id: string;
                        device_name: string;
                        latest_sensor_values: {
                            accelerometer_z: {
                                time: string;
                                value: number;
                            };
                            humidity: {
                                time: string;
                                value: number;
                            };
                            pressure: {
                                time: string;
                                value: number;
                            };
                            sound: {
                                time: string;
                                value: number;
                            };
                            temperature: {
                                time: string;
                                value: number;
                            };
                        };
                    };
                    model: {
                        accessory_keypad_supported?: boolean;
                        display_name: string;
                        manufacturer_display_name: string;
                        offline_access_codes_supported?: boolean;
                        online_access_codes_supported?: boolean;
                    };
                    name: string;
                    nest_metadata?: {
                        custom_name: string;
                        device_name: string;
                        nest_device_id: string;
                    };
                    noiseaware_metadata?: {
                        device_id: string;
                        device_model: "indoor" | "outdoor";
                        device_name: string;
                        noise_level_decibel: number;
                        noise_level_nrs: number;
                    };
                    nuki_metadata?: {
                        device_id: string;
                        device_name: string;
                        keypad_battery_critical?: boolean;
                    };
                    offline_access_codes_enabled?: boolean;
                    online: boolean;
                    online_access_codes_enabled?: boolean;
                    relative_humidity?: number;
                    salto_metadata?: {
                        battery_level: string;
                        customer_reference: string;
                        lock_id: string;
                        lock_type: string;
                        locked_state: string;
                        model?: string;
                    };
                    schlage_metadata?: {
                        access_code_length: number;
                        device_id: string;
                        device_name: string;
                        model?: string;
                    };
                    seam_bridge_metadata?: {
                        device_num: number;
                        name: string;
                        unlock_method?: "bridge" | "doorking";
                    };
                    serial_number?: string;
                    smartthings_metadata?: {
                        device_id: string;
                        device_name: string;
                        location_id?: string;
                        model?: string;
                    };
                    supported_code_lengths?: number[];
                    supports_accessory_keypad?: boolean;
                    supports_backup_access_code_pool?: boolean;
                    supports_offline_access_codes?: boolean;
                    temperature_celsius?: number;
                    temperature_fahrenheit?: number;
                    ttlock_metadata?: {
                        lock_alias: string;
                        lock_id: number;
                    };
                    two_n_metadata?: {
                        device_id: number;
                        device_name: string;
                    };
                    wyze_metadata?: {
                        device_id: string;
                        device_info_model: string;
                        device_name: string;
                        product_model: string;
                        product_name: string;
                        product_type: string;
                    };
                };
                warnings: {
                    message: string;
                    warning_code: string;
                }[];
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/user_identities/list_accessible_devices";
    };
    /user_identities/list_acs_users: {
        commonParams: {
            user_identity_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            acs_users: {
                acs_system_id: string;
                acs_user_id: string;
                created_at: string;
                display_name: string;
                email?: string;
                email_address?: string;
                ends_at?: string;
                external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
                external_type_display_name?: string;
                full_name?: string;
                hid_acs_system_id?: string;
                is_suspended: boolean;
                is_virtual: boolean;
                phone_number?: string;
                starts_at?: string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/user_identities/list_acs_users";
    };
    /user_identities/remove_acs_user: {
        commonParams: {
            acs_user_id: string;
            user_identity_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/user_identities/remove_acs_user";
    };
    /user_identities/revoke_access_to_device: {
        commonParams: {
            device_id: string;
            user_identity_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/user_identities/revoke_access_to_device";
    };
    /webhooks/create: {
        commonParams: {};
        formData: {};
        jsonBody: {
            event_types?: string[];
            url: string;
        };
        jsonResponse: {
            webhook: {
                event_types?: string[];
                secret?: string;
                url: string;
                webhook_id: string;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/webhooks/create";
    };
    /webhooks/delete: {
        commonParams: {
            webhook_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {};
        method: "POST" | "DELETE";
        queryParams: {};
        route: "/webhooks/delete";
    };
    /webhooks/get: {
        commonParams: {
            webhook_id: string;
        };
        formData: {};
        jsonBody: {};
        jsonResponse: {
            webhook: {
                event_types?: string[];
                secret?: string;
                url: string;
                webhook_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/webhooks/get";
    };
    /webhooks/list: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            webhooks: {
                event_types?: string[];
                secret?: string;
                url: string;
                webhook_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/webhooks/list";
    };
    /workspaces/create: {
        commonParams: {};
        formData: {};
        jsonBody: {
            connect_partner_name: string;
            is_sandbox?: boolean;
            name: string;
            webview_logo_shape?: "square" | "circle";
            webview_primary_button_color?: string;
        };
        jsonResponse: {
            workspace: {
                connect_partner_name: null | string;
                is_sandbox: boolean;
                name: string;
                workspace_id: string;
            };
        };
        method: "POST";
        queryParams: {};
        route: "/workspaces/create";
    };
    /workspaces/get: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            workspace?: {
                connect_partner_name: null | string;
                is_sandbox: boolean;
                name: string;
                workspace_id: string;
            };
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/workspaces/get";
    };
    /workspaces/list: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            workspaces: {
                connect_partner_name: null | string;
                is_sandbox: boolean;
                name: string;
                workspace_id: string;
            }[];
        };
        method: "POST" | "GET";
        queryParams: {};
        route: "/workspaces/list";
    };
    /workspaces/reset_sandbox: {
        commonParams: {};
        formData: {};
        jsonBody: {};
        jsonResponse: {
            message: string;
        };
        method: "POST";
        queryParams: {};
        route: "/workspaces/reset_sandbox";
    };
}

Index

Properties

/access_codes/create /access_codes/create_multiple /access_codes/delete /access_codes/generate_code /access_codes/get /access_codes/list /access_codes/pull_backup_access_code /access_codes/simulate/create_unmanaged_access_code /access_codes/unmanaged/convert_to_managed /access_codes/unmanaged/delete /access_codes/unmanaged/get /access_codes/unmanaged/list /access_codes/unmanaged/update /access_codes/update /acs/access_groups/add_user /acs/access_groups/get /acs/access_groups/list /acs/access_groups/list_users /acs/access_groups/remove_user /acs/credential_pools/list /acs/credential_provisioning_automations/launch /acs/credentials/assign /acs/credentials/create /acs/credentials/delete /acs/credentials/get /acs/credentials/list /acs/credentials/unassign /acs/credentials/update /acs/entrances/get /acs/entrances/grant_access /acs/entrances/list /acs/systems/get /acs/systems/list /acs/users/add_to_access_group /acs/users/create /acs/users/delete /acs/users/get /acs/users/list /acs/users/remove_from_access_group /acs/users/suspend /acs/users/unsuspend /acs/users/update /action_attempts/get /action_attempts/list /client_sessions/create /client_sessions/delete /client_sessions/get /client_sessions/get_or_create /client_sessions/grant_access /client_sessions/list /client_sessions/revoke /connect_webviews/create /connect_webviews/delete /connect_webviews/get /connect_webviews/list /connect_webviews/view /connected_accounts/delete /connected_accounts/get /connected_accounts/list /connected_accounts/update /devices/delete /devices/get /devices/list /devices/list_device_providers /devices/unmanaged/get /devices/unmanaged/list /devices/unmanaged/update /devices/update /events/get /events/list /health /health/get_health /health/get_service_health /health/service/[service_name] /locks/get /locks/list /locks/lock_door /locks/unlock_door /noise_sensors/noise_thresholds/create /noise_sensors/noise_thresholds/delete /noise_sensors/noise_thresholds/get /noise_sensors/noise_thresholds/list /noise_sensors/noise_thresholds/update /noise_sensors/simulate/trigger_noise_threshold /thermostats/climate_setting_schedules/create /thermostats/climate_setting_schedules/delete /thermostats/climate_setting_schedules/get /thermostats/climate_setting_schedules/list /thermostats/climate_setting_schedules/update /thermostats/cool /thermostats/get /thermostats/heat /thermostats/heat_cool /thermostats/list /thermostats/off /thermostats/set_fan_mode /thermostats/update /user_identities/add_acs_user /user_identities/create /user_identities/get /user_identities/grant_access_to_device /user_identities/list /user_identities/list_accessible_devices /user_identities/list_acs_users /user_identities/remove_acs_user /user_identities/revoke_access_to_device /webhooks/create /webhooks/delete /webhooks/get /webhooks/list /workspaces/create /workspaces/get /workspaces/list /workspaces/reset_sandbox

Properties

/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;
        starts_at?: string;
        sync?: boolean;
        use_backup_access_code_pool?: boolean;
        use_offline_access_code?: boolean;
    };
    jsonResponse: {
        access_code: {
            access_code_id: string;
            code: null | string;
            common_code_key: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_backup?: boolean;
            is_backup_access_code_available: boolean;
            is_external_modification_allowed: boolean;
            is_managed: true;
            is_offline_access_code: boolean;
            is_one_time_use: boolean;
            is_scheduled_on_device?: boolean;
            is_waiting_for_code_assignment?: boolean;
            name: null | string;
            pulled_backup_access_code_id?: null | string;
            starts_at?: null | string;
            status: "set" | "unknown" | "setting" | "unset" | "removing";
            type: "time_bound" | "ongoing";
            warnings?: any;
        };
        action_attempt: {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST";
    queryParams: {};
    route: "/access_codes/create";
}

Type declaration

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;
    starts_at?: string;
    sync?: boolean;
    use_backup_access_code_pool?: boolean;
    use_offline_access_code?: boolean;
}
- Optional allow_external_modification?: boolean
- Optional attempt_for_offline_device?: boolean
- Optional code?: string
- Optional common_code_key?: string
- device_id: string
- Optional ends_at?: string
- Optional is_external_modification_allowed?: boolean
- Optional is_offline_access_code?: boolean
- Optional is_one_time_use?: boolean
- Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"
- Optional name?: string
- Optional prefer_native_scheduling?: boolean
- Optional starts_at?: string
- Optional sync?: boolean
- Optional use_backup_access_code_pool?: boolean
- Optional use_offline_access_code?: boolean
jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- access_code: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }
  - access_code_id: string
    Unique identifier for the access code.
  - code: null | string
    Code used for access. Typically, a numeric or alphanumeric string.
  - common_code_key: null | string
    Unique identifier for a group of access codes that share the same code.
  - created_at: string
    Date and time at which the access code was created.
  - device_id: string
    Unique identifier for the device associated with the access code.
  - Optional ends_at?: null | string
    Date and time after which the time-bound access code becomes inactive.
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - Optional is_backup?: boolean
    Indicates whether the access code is a backup code.
  - is_backup_access_code_available: boolean
    Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
  - is_external_modification_allowed: boolean
    Indicates whether changes to the access code from external sources are permitted.
  - is_managed: true
    Indicates whether Seam manages the access code.
  - is_offline_access_code: boolean
    Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.
  - is_one_time_use: boolean
    Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.
  - Optional is_scheduled_on_device?: boolean
    Indicates whether the code is set on the device according to a preconfigured schedule.
  - Optional is_waiting_for_code_assignment?: boolean
    Indicates whether the access code is waiting for a code assignment.
  - name: null | string
    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
  - Optional pulled_backup_access_code_id?: null | string
    Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
  - Optional starts_at?: null | string
    Date and time at which the time-bound access code becomes active.
  - status: "set" | "unknown" | "setting" | "unset" | "removing"
    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
  - type: "time_bound" | "ongoing"
    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.
  - Optional warnings?: any
    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
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;
        is_offline_access_code?: boolean;
        is_one_time_use?: boolean;
        max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
        name?: string;
        prefer_native_scheduling?: boolean;
        starts_at?: string;
        use_backup_access_code_pool?: boolean;
        use_offline_access_code?: boolean;
    };
    jsonResponse: {
        access_codes: {
            access_code_id: string;
            code: null | string;
            common_code_key: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_backup?: boolean;
            is_backup_access_code_available: boolean;
            is_external_modification_allowed: boolean;
            is_managed: true;
            is_offline_access_code: boolean;
            is_one_time_use: boolean;
            is_scheduled_on_device?: boolean;
            is_waiting_for_code_assignment?: boolean;
            name: null | string;
            pulled_backup_access_code_id?: null | string;
            starts_at?: null | string;
            status: "set" | "unknown" | "setting" | "unset" | "removing";
            type: "time_bound" | "ongoing";
            warnings?: any;
        }[];
    };
    method: "POST" | "PUT";
    queryParams: {};
    route: "/access_codes/create_multiple";
}

Type declaration

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;
    is_offline_access_code?: boolean;
    is_one_time_use?: boolean;
    max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
    name?: string;
    prefer_native_scheduling?: boolean;
    starts_at?: string;
    use_backup_access_code_pool?: boolean;
    use_offline_access_code?: boolean;
}
- Optional allow_external_modification?: boolean
- Optional attempt_for_offline_device?: boolean
- Optional behavior_when_code_cannot_be_shared?: "throw" | "create_random_code"
- Optional code?: string
- device_ids: string[]
- Optional ends_at?: string
- Optional is_external_modification_allowed?: boolean
- Optional is_offline_access_code?: boolean
- Optional is_one_time_use?: boolean
- Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"
- Optional name?: string
- Optional prefer_native_scheduling?: boolean
- Optional starts_at?: string
- Optional use_backup_access_code_pool?: boolean
- Optional use_offline_access_code?: boolean
jsonResponse: {
    access_codes: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    }[];
}
- access_codes: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]
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: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/access_codes/delete";
}

Type declaration

commonParams: {
    access_code_id: string;
    device_id?: string;
    sync?: boolean;
}
- access_code_id: string
- Optional device_id?: string
- Optional sync?: boolean
formData: {}
jsonBody: {}
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST" | "DELETE"
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;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/access_codes/generate_code";
}

Type declaration

commonParams: {
device_id: string;
}
- device_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    generated_code: {
        code: string;
        device_id: string;
    };
}
- generated_code: {
  code: string;
  device_id: string;
  }
  - code: string
  - device_id: string
method: "POST" | "GET"
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: null | string;
            common_code_key: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_backup?: boolean;
            is_backup_access_code_available: boolean;
            is_external_modification_allowed: boolean;
            is_managed: true;
            is_offline_access_code: boolean;
            is_one_time_use: boolean;
            is_scheduled_on_device?: boolean;
            is_waiting_for_code_assignment?: boolean;
            name: null | string;
            pulled_backup_access_code_id?: null | string;
            starts_at?: null | string;
            status: "set" | "unknown" | "setting" | "unset" | "removing";
            type: "time_bound" | "ongoing";
            warnings?: any;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/access_codes/get";
}

Type declaration

commonParams: {
    access_code_id?: string;
    code?: string;
    device_id?: string;
}
- Optional access_code_id?: string
- Optional code?: string
- Optional device_id?: string
formData: {}
jsonBody: {}
jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}
- access_code: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }
  - access_code_id: string
    Unique identifier for the access code.
  - code: null | string
    Code used for access. Typically, a numeric or alphanumeric string.
  - common_code_key: null | string
    Unique identifier for a group of access codes that share the same code.
  - created_at: string
    Date and time at which the access code was created.
  - device_id: string
    Unique identifier for the device associated with the access code.
  - Optional ends_at?: null | string
    Date and time after which the time-bound access code becomes inactive.
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - Optional is_backup?: boolean
    Indicates whether the access code is a backup code.
  - is_backup_access_code_available: boolean
    Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
  - is_external_modification_allowed: boolean
    Indicates whether changes to the access code from external sources are permitted.
  - is_managed: true
    Indicates whether Seam manages the access code.
  - is_offline_access_code: boolean
    Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.
  - is_one_time_use: boolean
    Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.
  - Optional is_scheduled_on_device?: boolean
    Indicates whether the code is set on the device according to a preconfigured schedule.
  - Optional is_waiting_for_code_assignment?: boolean
    Indicates whether the access code is waiting for a code assignment.
  - name: null | string
    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
  - Optional pulled_backup_access_code_id?: null | string
    Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
  - Optional starts_at?: null | string
    Date and time at which the time-bound access code becomes active.
  - status: "set" | "unknown" | "setting" | "unset" | "removing"
    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
  - type: "time_bound" | "ongoing"
    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.
  - Optional warnings?: any
    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.
method: "POST" | "GET"
queryParams: {}
route: "/access_codes/get"

/access_codes/list

/access_codes/list: {
    commonParams: {
        access_code_ids?: string[];
        device_id?: string;
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        access_codes: {
            access_code_id: string;
            code: null | string;
            common_code_key: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_backup?: boolean;
            is_backup_access_code_available: boolean;
            is_external_modification_allowed: boolean;
            is_managed: true;
            is_offline_access_code: boolean;
            is_one_time_use: boolean;
            is_scheduled_on_device?: boolean;
            is_waiting_for_code_assignment?: boolean;
            name: null | string;
            pulled_backup_access_code_id?: null | string;
            starts_at?: null | string;
            status: "set" | "unknown" | "setting" | "unset" | "removing";
            type: "time_bound" | "ongoing";
            warnings?: any;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/access_codes/list";
}

Type declaration

commonParams: {
    access_code_ids?: string[];
    device_id?: string;
    user_identifier_key?: string;
}
- Optional access_code_ids?: string[]
- Optional device_id?: string
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    access_codes: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    }[];
}
- access_codes: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]
method: "POST" | "GET"
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: {
        backup_access_code: {
            access_code_id: string;
            code: null | string;
            common_code_key: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_backup?: boolean;
            is_backup_access_code_available: boolean;
            is_external_modification_allowed: boolean;
            is_managed: true;
            is_offline_access_code: boolean;
            is_one_time_use: boolean;
            is_scheduled_on_device?: boolean;
            is_waiting_for_code_assignment?: boolean;
            name: null | string;
            pulled_backup_access_code_id?: null | string;
            starts_at?: null | string;
            status: "set" | "unknown" | "setting" | "unset" | "removing";
            type: "time_bound" | "ongoing";
            warnings?: any;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/access_codes/pull_backup_access_code";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
access_code_id: string;
}
- access_code_id: string
jsonResponse: {
    backup_access_code: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}
- backup_access_code: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }
  - access_code_id: string
    Unique identifier for the access code.
  - code: null | string
    Code used for access. Typically, a numeric or alphanumeric string.
  - common_code_key: null | string
    Unique identifier for a group of access codes that share the same code.
  - created_at: string
    Date and time at which the access code was created.
  - device_id: string
    Unique identifier for the device associated with the access code.
  - Optional ends_at?: null | string
    Date and time after which the time-bound access code becomes inactive.
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - Optional is_backup?: boolean
    Indicates whether the access code is a backup code.
  - is_backup_access_code_available: boolean
    Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
  - is_external_modification_allowed: boolean
    Indicates whether changes to the access code from external sources are permitted.
  - is_managed: true
    Indicates whether Seam manages the access code.
  - is_offline_access_code: boolean
    Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.
  - is_one_time_use: boolean
    Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.
  - Optional is_scheduled_on_device?: boolean
    Indicates whether the code is set on the device according to a preconfigured schedule.
  - Optional is_waiting_for_code_assignment?: boolean
    Indicates whether the access code is waiting for a code assignment.
  - name: null | string
    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
  - Optional pulled_backup_access_code_id?: null | string
    Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
  - Optional starts_at?: null | string
    Date and time at which the time-bound access code becomes active.
  - status: "set" | "unknown" | "setting" | "unset" | "removing"
    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
  - type: "time_bound" | "ongoing"
    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.
  - Optional warnings?: any
    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.
method: "POST"
queryParams: {}
route: "/access_codes/pull_backup_access_code"

/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: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_managed: false;
            name: null | string;
            starts_at?: null | string;
            status: "set";
            type: "time_bound" | "ongoing";
            warnings?: any;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/access_codes/simulate/create_unmanaged_access_code";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    code: string;
    device_id: string;
    name: string;
}
- code: string
- device_id: string
- name: string
jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_managed: false;
        name: null | string;
        starts_at?: null | string;
        status: "set";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}
- access_code: {
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }
  - access_code_id: string
    Unique identifier for the access code.
  - code: null | string
    Code used for access. Typically, a numeric or alphanumeric string.
  - created_at: string
    Date and time at which the access code was created.
  - device_id: string
    Unique identifier for the device associated with the access code.
  - Optional ends_at?: null | string
    Date and time after which the time-bound access code becomes inactive.
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - is_managed: false
  - name: null | string
    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
  - Optional starts_at?: null | string
    Date and time at which the time-bound access code becomes active.
  - status: "set"
  - type: "time_bound" | "ongoing"
    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.
  - Optional warnings?: any
    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.
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: {};
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/access_codes/unmanaged/convert_to_managed";
}

Type declaration

commonParams: {
    access_code_id: string;
    allow_external_modification?: boolean;
    force?: boolean;
    is_external_modification_allowed?: boolean;
    sync?: boolean;
}
- access_code_id: string
- Optional allow_external_modification?: boolean
- Optional force?: boolean
- Optional is_external_modification_allowed?: boolean
- Optional sync?: boolean
formData: {}
jsonBody: {}
jsonResponse: {}
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: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/access_codes/unmanaged/delete";
}

Type declaration

commonParams: {
access_code_id: string;
sync?: boolean;
}
- access_code_id: string
- Optional sync?: boolean
formData: {}
jsonBody: {}
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST" | "DELETE"
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: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_managed: false;
            name: null | string;
            starts_at?: null | string;
            status: "set";
            type: "time_bound" | "ongoing";
            warnings?: any;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/access_codes/unmanaged/get";
}

Type declaration

commonParams: {
    access_code_id?: string;
    code?: string;
    device_id?: string;
}
- Optional access_code_id?: string
- Optional code?: string
- Optional device_id?: string
formData: {}
jsonBody: {}
jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_managed: false;
        name: null | string;
        starts_at?: null | string;
        status: "set";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}
- access_code: {
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }
  - access_code_id: string
    Unique identifier for the access code.
  - code: null | string
    Code used for access. Typically, a numeric or alphanumeric string.
  - created_at: string
    Date and time at which the access code was created.
  - device_id: string
    Unique identifier for the device associated with the access code.
  - Optional ends_at?: null | string
    Date and time after which the time-bound access code becomes inactive.
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - is_managed: false
  - name: null | string
    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
  - Optional starts_at?: null | string
    Date and time at which the time-bound access code becomes active.
  - status: "set"
  - type: "time_bound" | "ongoing"
    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.
  - Optional warnings?: any
    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.
method: "POST" | "GET"
queryParams: {}
route: "/access_codes/unmanaged/get"

/access_codes/unmanaged/list

/access_codes/unmanaged/list: {
    commonParams: {
        device_id: string;
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        access_codes: {
            access_code_id: string;
            code: null | string;
            created_at: string;
            device_id: string;
            ends_at?: null | string;
            errors?: any;
            is_managed: false;
            name: null | string;
            starts_at?: null | string;
            status: "set";
            type: "time_bound" | "ongoing";
            warnings?: any;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/access_codes/unmanaged/list";
}

Type declaration

commonParams: {
device_id: string;
user_identifier_key?: string;
}
- device_id: string
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    access_codes: {
        access_code_id: string;
        code: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_managed: false;
        name: null | string;
        starts_at?: null | string;
        status: "set";
        type: "time_bound" | "ongoing";
        warnings?: any;
    }[];
}
- access_codes: {
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]
method: "POST" | "GET"
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: {};
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/access_codes/unmanaged/update";
}

Type declaration

commonParams: {
    access_code_id: string;
    allow_external_modification?: boolean;
    force?: boolean;
    is_external_modification_allowed?: boolean;
    is_managed: boolean;
}
- access_code_id: string
- Optional allow_external_modification?: boolean
- Optional force?: boolean
- Optional is_external_modification_allowed?: boolean
- is_managed: boolean
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "PATCH"
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;
        starts_at?: string;
        sync?: boolean;
        type?: "time_bound" | "ongoing";
        use_backup_access_code_pool?: boolean;
        use_offline_access_code?: boolean;
    };
    jsonResponse: {
        action_attempt: {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST" | "PUT" | "PATCH";
    queryParams: {};
    route: "/access_codes/update";
}

Type declaration

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;
    starts_at?: string;
    sync?: boolean;
    type?: "time_bound" | "ongoing";
    use_backup_access_code_pool?: boolean;
    use_offline_access_code?: boolean;
}
- access_code_id: string
- Optional allow_external_modification?: boolean
- Optional attempt_for_offline_device?: boolean
- Optional code?: string
- Optional device_id?: string
- Optional ends_at?: string
- Optional is_external_modification_allowed?: boolean
- Optional is_managed?: boolean
- Optional is_offline_access_code?: boolean
- Optional is_one_time_use?: boolean
- Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"
- Optional name?: string
- Optional prefer_native_scheduling?: boolean
- Optional starts_at?: string
- Optional sync?: boolean
- Optional type?: "time_bound" | "ongoing"
- Optional use_backup_access_code_pool?: boolean
- Optional use_offline_access_code?: boolean
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST" | "PUT" | "PATCH"
queryParams: {}
route: "/access_codes/update"

/acs/access_groups/add_user

/acs/access_groups/add_user: {
    commonParams: {
        acs_access_group_id: string;
        acs_user_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "PUT";
    queryParams: {};
    route: "/acs/access_groups/add_user";
}

Type declaration

commonParams: {
acs_access_group_id: string;
acs_user_id: string;
}
- acs_access_group_id: string
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "PUT"
queryParams: {}
route: "/acs/access_groups/add_user"

/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_access_group" | "brivo_group";
            access_group_type_display_name: string;
            acs_access_group_id: string;
            acs_system_id: string;
            created_at: string;
            external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
            external_type_display_name: string;
            name: string;
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/access_groups/get";
}

Type declaration

commonParams: {
acs_access_group_id: string;
}
- acs_access_group_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_access_group: {
        access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
        access_group_type_display_name: string;
        acs_access_group_id: string;
        acs_system_id: string;
        created_at: string;
        external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
        external_type_display_name: string;
        name: string;
        workspace_id: string;
    };
}
- acs_access_group: {
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }
  - access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group"
    deprecated: use external_type
  - access_group_type_display_name: string
    deprecated: use external_type_display_name
  - acs_access_group_id: string
  - acs_system_id: string
  - created_at: string
  - external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group"
  - external_type_display_name: string
  - name: string
  - workspace_id: string
method: "POST" | "GET"
queryParams: {}
route: "/acs/access_groups/get"

/acs/access_groups/list

/acs/access_groups/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_access_group" | "brivo_group";
            access_group_type_display_name: string;
            acs_access_group_id: string;
            acs_system_id: string;
            created_at: string;
            external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
            external_type_display_name: string;
            name: string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/access_groups/list";
}

Type declaration

commonParams: {
acs_system_id?: string;
acs_user_id?: string;
}
- Optional acs_system_id?: string
- Optional acs_user_id?: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_access_groups: {
        access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
        access_group_type_display_name: string;
        acs_access_group_id: string;
        acs_system_id: string;
        created_at: string;
        external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
        external_type_display_name: string;
        name: string;
        workspace_id: string;
    }[];
}
- acs_access_groups: {
      access_group_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      access_group_type_display_name: string;
      acs_access_group_id: string;
      acs_system_id: string;
      created_at: string;
      external_type: "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group";
      external_type_display_name: string;
      name: string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/acs/access_groups/list"

/acs/access_groups/list_users

/acs/access_groups/list_users: {
    commonParams: {
        acs_access_group_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_users: {
            acs_system_id: string;
            acs_user_id: string;
            created_at: string;
            display_name: string;
            email?: string;
            email_address?: string;
            ends_at?: string;
            external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
            external_type_display_name?: string;
            full_name?: string;
            hid_acs_system_id?: string;
            is_suspended: boolean;
            is_virtual: boolean;
            phone_number?: string;
            starts_at?: string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/access_groups/list_users";
}

Type declaration

commonParams: {
acs_access_group_id: string;
}
- acs_access_group_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_users: {
        acs_system_id: string;
        acs_user_id: string;
        created_at: string;
        display_name: string;
        email?: string;
        email_address?: string;
        ends_at?: string;
        external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
        external_type_display_name?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        is_suspended: boolean;
        is_virtual: boolean;
        phone_number?: string;
        starts_at?: string;
        workspace_id: string;
    }[];
}
- acs_users: {
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      ends_at?: string;
      external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
      external_type_display_name?: string;
      full_name?: string;
      hid_acs_system_id?: string;
      is_suspended: boolean;
      is_virtual: boolean;
      phone_number?: string;
      starts_at?: string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
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;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/acs/access_groups/remove_user";
}

Type declaration

commonParams: {
acs_access_group_id: string;
acs_user_id: string;
}
- acs_access_group_id: string
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
queryParams: {}
route: "/acs/access_groups/remove_user"

/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;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/credential_pools/list";
}

Type declaration

commonParams: {
acs_system_id: string;
}
- 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;
    }[];
}
- 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;
  }[]
method: "POST" | "GET"
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;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/acs/credential_provisioning_automations/launch";
}

Type declaration

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;
}
- Optional acs_credential_pool_id?: string
- Optional create_credential_manager_user?: boolean
- credential_manager_acs_system_id: string
- Optional 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;
    };
}
- 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;
  }
  - acs_credential_provisioning_automation_id: string
  - created_at: string
  - credential_manager_acs_system_id: string
  - user_identity_id: string
  - workspace_id: string
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;
    };
    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;
            code?: null | string;
            created_at: string;
            display_name: string;
            external_type: "pti_card" | "brivo_credential" | "hid_credential";
            external_type_display_name: string;
            workspace_id: string;
        };
    };
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/acs/credentials/assign";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
acs_credential_id: string;
acs_user_id: string;
}
- acs_credential_id: string
- acs_user_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;
        code?: null | string;
        created_at: string;
        display_name: string;
        external_type: "pti_card" | "brivo_credential" | "hid_credential";
        external_type_display_name: string;
        workspace_id: string;
    };
}
- 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;
      code?: null | string;
      created_at: string;
      display_name: string;
      external_type: "pti_card" | "brivo_credential" | "hid_credential";
      external_type_display_name: string;
      workspace_id: string;
  }
  - access_method: "code" | "card" | "mobile_key"
  - acs_credential_id: string
  - Optional acs_credential_pool_id?: string
  - acs_system_id: string
  - Optional acs_user_id?: string
  - Optional code?: null | string
  - created_at: string
  - display_name: string
  - external_type: "pti_card" | "brivo_credential" | "hid_credential"
  - external_type_display_name: string
  - workspace_id: string
method: "POST" | "PATCH"
queryParams: {}
route: "/acs/credentials/assign"

/acs/credentials/create

/acs/credentials/create: {
    commonParams: {
        access_method: "code" | "card" | "mobile_key";
        acs_user_id: string;
        code?: 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;
            code?: null | string;
            created_at: string;
            display_name: string;
            external_type: "pti_card" | "brivo_credential" | "hid_credential";
            external_type_display_name: string;
            workspace_id: string;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/acs/credentials/create";
}

Type declaration

commonParams: {
    access_method: "code" | "card" | "mobile_key";
    acs_user_id: string;
    code?: string;
}
- access_method: "code" | "card" | "mobile_key"
- acs_user_id: string
- Optional code?: 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;
        code?: null | string;
        created_at: string;
        display_name: string;
        external_type: "pti_card" | "brivo_credential" | "hid_credential";
        external_type_display_name: string;
        workspace_id: string;
    };
}
- 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;
      code?: null | string;
      created_at: string;
      display_name: string;
      external_type: "pti_card" | "brivo_credential" | "hid_credential";
      external_type_display_name: string;
      workspace_id: string;
  }
  - access_method: "code" | "card" | "mobile_key"
  - acs_credential_id: string
  - Optional acs_credential_pool_id?: string
  - acs_system_id: string
  - Optional acs_user_id?: string
  - Optional code?: null | string
  - created_at: string
  - display_name: string
  - external_type: "pti_card" | "brivo_credential" | "hid_credential"
  - external_type_display_name: string
  - workspace_id: string
method: "POST"
queryParams: {}
route: "/acs/credentials/create"

/acs/credentials/delete

/acs/credentials/delete: {
    commonParams: {
        acs_credential_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/acs/credentials/delete";
}

Type declaration

commonParams: {
acs_credential_id: string;
}
- acs_credential_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
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;
            code?: null | string;
            created_at: string;
            display_name: string;
            external_type: "pti_card" | "brivo_credential" | "hid_credential";
            external_type_display_name: string;
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/credentials/get";
}

Type declaration

commonParams: {
acs_credential_id: string;
}
- 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;
        code?: null | string;
        created_at: string;
        display_name: string;
        external_type: "pti_card" | "brivo_credential" | "hid_credential";
        external_type_display_name: string;
        workspace_id: string;
    };
}
- 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;
      code?: null | string;
      created_at: string;
      display_name: string;
      external_type: "pti_card" | "brivo_credential" | "hid_credential";
      external_type_display_name: string;
      workspace_id: string;
  }
  - access_method: "code" | "card" | "mobile_key"
  - acs_credential_id: string
  - Optional acs_credential_pool_id?: string
  - acs_system_id: string
  - Optional acs_user_id?: string
  - Optional code?: null | string
  - created_at: string
  - display_name: string
  - external_type: "pti_card" | "brivo_credential" | "hid_credential"
  - external_type_display_name: string
  - workspace_id: string
method: "POST" | "GET"
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;
    };
    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;
            code?: null | string;
            created_at: string;
            display_name: string;
            external_type: "pti_card" | "brivo_credential" | "hid_credential";
            external_type_display_name: string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/credentials/list";
}

Type declaration

commonParams: {
    acs_user_id: string;
} | {
    acs_system_id: string;
} | {
    acs_system_id: string;
    acs_user_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;
        code?: null | string;
        created_at: string;
        display_name: string;
        external_type: "pti_card" | "brivo_credential" | "hid_credential";
        external_type_display_name: string;
        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;
      code?: null | string;
      created_at: string;
      display_name: string;
      external_type: "pti_card" | "brivo_credential" | "hid_credential";
      external_type_display_name: string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/acs/credentials/list"

/acs/credentials/unassign

/acs/credentials/unassign: {
    commonParams: {};
    formData: {};
    jsonBody: {
        acs_credential_id: string;
        acs_user_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;
            code?: null | string;
            created_at: string;
            display_name: string;
            external_type: "pti_card" | "brivo_credential" | "hid_credential";
            external_type_display_name: string;
            workspace_id: string;
        };
    };
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/acs/credentials/unassign";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
acs_credential_id: string;
acs_user_id: string;
}
- acs_credential_id: string
- acs_user_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;
        code?: null | string;
        created_at: string;
        display_name: string;
        external_type: "pti_card" | "brivo_credential" | "hid_credential";
        external_type_display_name: string;
        workspace_id: string;
    };
}
- 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;
      code?: null | string;
      created_at: string;
      display_name: string;
      external_type: "pti_card" | "brivo_credential" | "hid_credential";
      external_type_display_name: string;
      workspace_id: string;
  }
  - access_method: "code" | "card" | "mobile_key"
  - acs_credential_id: string
  - Optional acs_credential_pool_id?: string
  - acs_system_id: string
  - Optional acs_user_id?: string
  - Optional code?: null | string
  - created_at: string
  - display_name: string
  - external_type: "pti_card" | "brivo_credential" | "hid_credential"
  - external_type_display_name: string
  - workspace_id: string
method: "POST" | "PATCH"
queryParams: {}
route: "/acs/credentials/unassign"

/acs/credentials/update

/acs/credentials/update: {
    commonParams: {};
    formData: {};
    jsonBody: {
        acs_credential_id: string;
        code: 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;
            code?: null | string;
            created_at: string;
            display_name: string;
            external_type: "pti_card" | "brivo_credential" | "hid_credential";
            external_type_display_name: string;
            workspace_id: string;
        };
    };
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/acs/credentials/update";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
acs_credential_id: string;
code: string;
}
- acs_credential_id: string
- code: 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;
        code?: null | string;
        created_at: string;
        display_name: string;
        external_type: "pti_card" | "brivo_credential" | "hid_credential";
        external_type_display_name: string;
        workspace_id: string;
    };
}
- 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;
      code?: null | string;
      created_at: string;
      display_name: string;
      external_type: "pti_card" | "brivo_credential" | "hid_credential";
      external_type_display_name: string;
      workspace_id: string;
  }
  - access_method: "code" | "card" | "mobile_key"
  - acs_credential_id: string
  - Optional acs_credential_pool_id?: string
  - acs_system_id: string
  - Optional acs_user_id?: string
  - Optional code?: null | string
  - created_at: string
  - display_name: string
  - external_type: "pti_card" | "brivo_credential" | "hid_credential"
  - external_type_display_name: string
  - workspace_id: string
method: "POST" | "PATCH"
queryParams: {}
route: "/acs/credentials/update"

/acs/entrances/get

/acs/entrances/get: {
    commonParams: {
        acs_entrance_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_entrance: {
            acs_entrance_id: string;
            acs_system_id: string;
            created_at: string;
            display_name: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/entrances/get";
}

Type declaration

commonParams: {
acs_entrance_id: string;
}
- acs_entrance_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_entrance: {
        acs_entrance_id: string;
        acs_system_id: string;
        created_at: string;
        display_name: string;
    };
}
- acs_entrance: {
      acs_entrance_id: string;
      acs_system_id: string;
      created_at: string;
      display_name: string;
  }
  - acs_entrance_id: string
  - acs_system_id: string
  - created_at: string
  - display_name: string
method: "POST" | "GET"
queryParams: {}
route: "/acs/entrances/get"

/acs/entrances/grant_access

/acs/entrances/grant_access: {
    commonParams: {};
    formData: {};
    jsonBody: {
        acs_entrance_id: string;
        acs_user_id: string;
    };
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/acs/entrances/grant_access";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
acs_entrance_id: string;
acs_user_id: string;
}
- acs_entrance_id: string
- acs_user_id: string
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/acs/entrances/grant_access"

/acs/entrances/list

/acs/entrances/list: {
    commonParams: {
        acs_system_id?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_entrances: {
            acs_entrance_id: string;
            acs_system_id: string;
            created_at: string;
            display_name: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/entrances/list";
}

Type declaration

commonParams: {
acs_system_id?: string;
}
- Optional acs_system_id?: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_entrances: {
        acs_entrance_id: string;
        acs_system_id: string;
        created_at: string;
        display_name: string;
    }[];
}
- acs_entrances: {
      acs_entrance_id: string;
      acs_system_id: string;
      created_at: string;
      display_name: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/acs/entrances/list"

/acs/systems/get

/acs/systems/get: {
    commonParams: {
        acs_system_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_system: {
            acs_system_id: string;
            connected_account_ids: string[];
            created_at: string;
            external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
            external_type_display_name: string;
            name: string;
            system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
            system_type_display_name: string;
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/systems/get";
}

Type declaration

commonParams: {
acs_system_id: string;
}
- acs_system_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_system: {
        acs_system_id: string;
        connected_account_ids: string[];
        created_at: string;
        external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
        external_type_display_name: string;
        name: string;
        system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
        system_type_display_name: string;
        workspace_id: string;
    };
}
- acs_system: {
      acs_system_id: string;
      connected_account_ids: string[];
      created_at: string;
      external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
      external_type_display_name: string;
      name: string;
      system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
      system_type_display_name: string;
      workspace_id: string;
  }
  - acs_system_id: string
  - connected_account_ids: string[]
  - created_at: string
  - external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user"
  - external_type_display_name: string
  - name: string
  - system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user"
    deprecated: use external_type
  - system_type_display_name: string
    deprecated: use external_type_display_name
  - workspace_id: string
method: "POST" | "GET"
queryParams: {}
route: "/acs/systems/get"

/acs/systems/list

/acs/systems/list: {
    commonParams: {
        connected_account_id?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_systems: {
            acs_system_id: string;
            connected_account_ids: string[];
            created_at: string;
            external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
            external_type_display_name: string;
            name: string;
            system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
            system_type_display_name: string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/systems/list";
}

Type declaration

commonParams: {
connected_account_id?: string;
}
- Optional connected_account_id?: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_systems: {
        acs_system_id: string;
        connected_account_ids: string[];
        created_at: string;
        external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
        external_type_display_name: string;
        name: string;
        system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
        system_type_display_name: string;
        workspace_id: string;
    }[];
}
- acs_systems: {
      acs_system_id: string;
      connected_account_ids: string[];
      created_at: string;
      external_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
      external_type_display_name: string;
      name: string;
      system_type: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service_user";
      system_type_display_name: string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/acs/systems/list"

/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: {};
    method: "POST" | "PUT";
    queryParams: {};
    route: "/acs/users/add_to_access_group";
}

Type declaration

commonParams: {
acs_access_group_id: string;
acs_user_id: string;
}
- acs_access_group_id: string
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "PUT"
queryParams: {}
route: "/acs/users/add_to_access_group"

/acs/users/create

/acs/users/create: {
    commonParams: {};
    formData: {};
    jsonBody: {
        access_schedule?: {
            ends_at: string;
            starts_at: string;
        };
        acs_access_group_ids?: string[];
        acs_system_id: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        phone_number?: string;
    };
    jsonResponse: {
        acs_user: {
            acs_system_id: string;
            acs_user_id: string;
            created_at: string;
            display_name: string;
            email?: string;
            email_address?: string;
            ends_at?: string;
            external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
            external_type_display_name?: string;
            full_name?: string;
            hid_acs_system_id?: string;
            is_suspended: boolean;
            is_virtual: boolean;
            phone_number?: string;
            starts_at?: string;
            workspace_id: string;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/acs/users/create";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    access_schedule?: {
        ends_at: string;
        starts_at: string;
    };
    acs_access_group_ids?: string[];
    acs_system_id: string;
    email?: string;
    email_address?: string;
    full_name?: string;
    phone_number?: string;
}
- Optional access_schedule?: {
  ends_at: string;
  starts_at: string;
  }
  - ends_at: string
  - starts_at: string
- Optional acs_access_group_ids?: string[]
- acs_system_id: string
- Optional email?: string
  Deprecated: use email_address.
- Optional email_address?: string
- Optional full_name?: string
- Optional phone_number?: string
jsonResponse: {
    acs_user: {
        acs_system_id: string;
        acs_user_id: string;
        created_at: string;
        display_name: string;
        email?: string;
        email_address?: string;
        ends_at?: string;
        external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
        external_type_display_name?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        is_suspended: boolean;
        is_virtual: boolean;
        phone_number?: string;
        starts_at?: string;
        workspace_id: string;
    };
}
- acs_user: {
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      ends_at?: string;
      external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
      external_type_display_name?: string;
      full_name?: string;
      hid_acs_system_id?: string;
      is_suspended: boolean;
      is_virtual: boolean;
      phone_number?: string;
      starts_at?: string;
      workspace_id: string;
  }
  - acs_system_id: string
  - acs_user_id: string
  - created_at: string
  - display_name: string
  - Optional email?: string
    Deprecated: use email_address.
  - Optional email_address?: string
  - Optional ends_at?: string
  - Optional external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user"
  - Optional external_type_display_name?: string
  - Optional full_name?: string
  - Optional hid_acs_system_id?: string
  - is_suspended: boolean
  - is_virtual: boolean
  - Optional phone_number?: string
  - Optional starts_at?: string
  - workspace_id: string
method: "POST"
queryParams: {}
route: "/acs/users/create"

/acs/users/delete

/acs/users/delete: {
    commonParams: {
        acs_user_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/acs/users/delete";
}

Type declaration

commonParams: {
acs_user_id: string;
}
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
queryParams: {}
route: "/acs/users/delete"

/acs/users/get

/acs/users/get: {
    commonParams: {
        acs_user_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_user: {
            acs_system_id: string;
            acs_user_id: string;
            created_at: string;
            display_name: string;
            email?: string;
            email_address?: string;
            ends_at?: string;
            external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
            external_type_display_name?: string;
            full_name?: string;
            hid_acs_system_id?: string;
            is_suspended: boolean;
            is_virtual: boolean;
            phone_number?: string;
            starts_at?: string;
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/users/get";
}

Type declaration

commonParams: {
acs_user_id: string;
}
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_user: {
        acs_system_id: string;
        acs_user_id: string;
        created_at: string;
        display_name: string;
        email?: string;
        email_address?: string;
        ends_at?: string;
        external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
        external_type_display_name?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        is_suspended: boolean;
        is_virtual: boolean;
        phone_number?: string;
        starts_at?: string;
        workspace_id: string;
    };
}
- acs_user: {
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      ends_at?: string;
      external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
      external_type_display_name?: string;
      full_name?: string;
      hid_acs_system_id?: string;
      is_suspended: boolean;
      is_virtual: boolean;
      phone_number?: string;
      starts_at?: string;
      workspace_id: string;
  }
  - acs_system_id: string
  - acs_user_id: string
  - created_at: string
  - display_name: string
  - Optional email?: string
    Deprecated: use email_address.
  - Optional email_address?: string
  - Optional ends_at?: string
  - Optional external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user"
  - Optional external_type_display_name?: string
  - Optional full_name?: string
  - Optional hid_acs_system_id?: string
  - is_suspended: boolean
  - is_virtual: boolean
  - Optional phone_number?: string
  - Optional starts_at?: string
  - workspace_id: string
method: "POST" | "GET"
queryParams: {}
route: "/acs/users/get"

/acs/users/list

/acs/users/list: {
    commonParams: {
        acs_system_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_users: {
            acs_system_id: string;
            acs_user_id: string;
            created_at: string;
            display_name: string;
            email?: string;
            email_address?: string;
            ends_at?: string;
            external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
            external_type_display_name?: string;
            full_name?: string;
            hid_acs_system_id?: string;
            is_suspended: boolean;
            is_virtual: boolean;
            phone_number?: string;
            starts_at?: string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/acs/users/list";
}

Type declaration

commonParams: {
acs_system_id: string;
}
- acs_system_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_users: {
        acs_system_id: string;
        acs_user_id: string;
        created_at: string;
        display_name: string;
        email?: string;
        email_address?: string;
        ends_at?: string;
        external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
        external_type_display_name?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        is_suspended: boolean;
        is_virtual: boolean;
        phone_number?: string;
        starts_at?: string;
        workspace_id: string;
    }[];
}
- acs_users: {
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      ends_at?: string;
      external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
      external_type_display_name?: string;
      full_name?: string;
      hid_acs_system_id?: string;
      is_suspended: boolean;
      is_virtual: boolean;
      phone_number?: string;
      starts_at?: string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/acs/users/list"

/acs/users/remove_from_access_group

/acs/users/remove_from_access_group: {
    commonParams: {
        acs_access_group_id: string;
        acs_user_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/acs/users/remove_from_access_group";
}

Type declaration

commonParams: {
acs_access_group_id: string;
acs_user_id: string;
}
- acs_access_group_id: string
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
queryParams: {}
route: "/acs/users/remove_from_access_group"

/acs/users/suspend

/acs/users/suspend: {
    commonParams: {
        acs_user_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/acs/users/suspend";
}

Type declaration

commonParams: {
acs_user_id: string;
}
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/acs/users/suspend"

/acs/users/unsuspend

/acs/users/unsuspend: {
    commonParams: {
        acs_user_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/acs/users/unsuspend";
}

Type declaration

commonParams: {
acs_user_id: string;
}
- acs_user_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/acs/users/unsuspend"

/acs/users/update

/acs/users/update: {
    commonParams: {};
    formData: {};
    jsonBody: {
        acs_user_id: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        phone_number?: string;
    };
    jsonResponse: {};
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/acs/users/update";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    acs_user_id: string;
    email?: string;
    email_address?: string;
    full_name?: string;
    hid_acs_system_id?: string;
    phone_number?: string;
}
- acs_user_id: string
- Optional email?: string
  Deprecated: use email_address.
- Optional email_address?: string
- Optional full_name?: string
- Optional hid_acs_system_id?: string
- Optional phone_number?: string
jsonResponse: {}
method: "POST" | "PATCH"
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: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/action_attempts/get";
}

Type declaration

commonParams: {
action_attempt_id: string;
}
- action_attempt_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST" | "GET"
queryParams: {}
route: "/action_attempts/get"

/action_attempts/list

/action_attempts/list: {
    commonParams: {
        action_attempt_ids: string[];
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        action_attempts: ({
            action_attempt_id: string;
            action_type: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        })[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/action_attempts/list";
}

Type declaration

commonParams: {
action_attempt_ids: string[];
}
- action_attempt_ids: string[]
formData: {}
jsonBody: {}
jsonResponse: {
    action_attempts: ({
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    })[];
}
- action_attempts: ({
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  })[]
method: "POST" | "GET"
queryParams: {}
route: "/action_attempts/list"

/client_sessions/create

/client_sessions/create: {
    commonParams: {};
    formData: {};
    jsonBody: {
        connect_webview_ids?: string[];
        connected_account_ids?: string[];
        expires_at?: Date;
        user_identifier_key?: string;
        user_identity_ids?: string[];
    };
    jsonResponse: {
        client_session: {
            client_session_id: string;
            created_at: string;
            token: string;
            user_identifier_key: null | string;
            workspace_id: string;
        };
    };
    method: "POST" | "PUT";
    queryParams: {};
    route: "/client_sessions/create";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    connect_webview_ids?: string[];
    connected_account_ids?: string[];
    expires_at?: Date;
    user_identifier_key?: string;
    user_identity_ids?: string[];
}
- Optional connect_webview_ids?: string[]
- Optional connected_account_ids?: string[]
- Optional expires_at?: Date
- Optional user_identifier_key?: string
- Optional user_identity_ids?: string[]
jsonResponse: {
    client_session: {
        client_session_id: string;
        created_at: string;
        token: string;
        user_identifier_key: null | string;
        workspace_id: string;
    };
}
- client_session: {
      client_session_id: string;
      created_at: string;
      token: string;
      user_identifier_key: null | string;
      workspace_id: string;
  }
  - client_session_id: string
  - created_at: string
  - token: string
  - user_identifier_key: null | string
  - workspace_id: string
method: "POST" | "PUT"
queryParams: {}
route: "/client_sessions/create"

/client_sessions/delete

/client_sessions/delete: {
    commonParams: {
        client_session_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/client_sessions/delete";
}

Type declaration

commonParams: {
client_session_id: string;
}
- client_session_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
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;
            device_count: number;
            token: string;
            user_identifier_key: null | string;
            user_identity_ids: string[];
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/client_sessions/get";
}

Type declaration

commonParams: {
client_session_id?: string;
user_identifier_key?: string;
}
- Optional client_session_id?: string
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    client_session: {
        client_session_id: string;
        connect_webview_ids: string[];
        connected_account_ids: string[];
        created_at: string;
        device_count: number;
        token: string;
        user_identifier_key: null | string;
        user_identity_ids: string[];
        workspace_id: string;
    };
}
- client_session: {
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      token: string;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }
  - client_session_id: string
  - connect_webview_ids: string[]
  - connected_account_ids: string[]
  - created_at: string
  - device_count: number
  - token: string
  - user_identifier_key: null | string
  - user_identity_ids: string[]
  - workspace_id: string
method: "POST" | "GET"
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_ids?: string[];
    };
    jsonResponse: {
        client_session: {
            client_session_id: string;
            created_at: string;
            token: string;
            user_identifier_key: null | string;
            workspace_id: string;
        };
    };
    method: "POST" | "PUT";
    queryParams: {};
    route: "/client_sessions/get_or_create";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    connect_webview_ids?: string[];
    connected_account_ids?: string[];
    expires_at?: Date;
    user_identifier_key?: string;
    user_identity_ids?: string[];
}
- Optional connect_webview_ids?: string[]
- Optional connected_account_ids?: string[]
- Optional expires_at?: Date
- Optional user_identifier_key?: string
- Optional user_identity_ids?: string[]
jsonResponse: {
    client_session: {
        client_session_id: string;
        created_at: string;
        token: string;
        user_identifier_key: null | string;
        workspace_id: string;
    };
}
- client_session: {
      client_session_id: string;
      created_at: string;
      token: string;
      user_identifier_key: null | string;
      workspace_id: string;
  }
  - client_session_id: string
  - created_at: string
  - token: string
  - user_identifier_key: null | string
  - workspace_id: string
method: "POST" | "PUT"
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_ids?: string[];
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        client_session: {
            client_session_id: string;
            connect_webview_ids: string[];
            connected_account_ids: string[];
            created_at: string;
            device_count: number;
            token: string;
            user_identifier_key: null | string;
            user_identity_ids: string[];
            workspace_id: string;
        };
    };
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/client_sessions/grant_access";
}

Type declaration

commonParams: {
    client_session_id?: string;
    connect_webview_ids?: string[];
    connected_account_ids?: string[];
    user_identifier_key?: string;
    user_identity_ids?: string[];
}
- Optional client_session_id?: string
- Optional connect_webview_ids?: string[]
- Optional connected_account_ids?: string[]
- Optional user_identifier_key?: string
- Optional user_identity_ids?: string[]
formData: {}
jsonBody: {}
jsonResponse: {
    client_session: {
        client_session_id: string;
        connect_webview_ids: string[];
        connected_account_ids: string[];
        created_at: string;
        device_count: number;
        token: string;
        user_identifier_key: null | string;
        user_identity_ids: string[];
        workspace_id: string;
    };
}
- client_session: {
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      token: string;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }
  - client_session_id: string
  - connect_webview_ids: string[]
  - connected_account_ids: string[]
  - created_at: string
  - device_count: number
  - token: string
  - user_identifier_key: null | string
  - user_identity_ids: string[]
  - workspace_id: string
method: "POST" | "PATCH"
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;
        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;
            device_count: number;
            user_identifier_key: null | string;
            user_identity_ids: string[];
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/client_sessions/list";
}

Type declaration

commonParams: {
    client_session_id?: string;
    connect_webview_id?: string;
    user_identifier_key?: string;
    without_user_identifier_key?: boolean;
}
- Optional client_session_id?: string
- Optional connect_webview_id?: string
- Optional user_identifier_key?: string
- Optional 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;
        device_count: number;
        user_identifier_key: null | string;
        user_identity_ids: string[];
        workspace_id: string;
    }[];
}
- client_sessions: {
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/client_sessions/list"

/client_sessions/revoke

/client_sessions/revoke: {
    commonParams: {
        client_session_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/client_sessions/revoke";
}

Type declaration

commonParams: {
client_session_id: string;
}
- client_session_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/client_sessions/revoke"

/connect_webviews/create

/connect_webviews/create: {
    commonParams: {};
    formData: {};
    jsonBody: {
        accepted_providers?: ("linear" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "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" | "yale_access" | "hid_cm")[];
        automatically_manage_new_devices?: boolean;
        custom_metadata?: Record<string, null | string | number | boolean>;
        custom_redirect_failure_url?: string;
        custom_redirect_url?: string;
        device_selection_mode?: "none" | "multiple" | "single";
        provider_category?: "stable" | "consumer_smartlocks" | "internal_beta";
        wait_for_device_creation?: boolean;
    };
    jsonResponse: {
        connect_webview: {
            accepted_devices: string[];
            accepted_providers: string[];
            any_device_allowed: boolean;
            any_provider_allowed: boolean;
            authorized_at: null | string;
            automatically_manage_new_devices: boolean;
            connect_webview_id: string;
            connected_account_id?: string;
            created_at: string;
            custom_metadata: Record<string, null | string | number | boolean>;
            custom_redirect_failure_url: null | string;
            custom_redirect_url: null | string;
            device_selection_mode: "none" | "multiple" | "single";
            login_successful: boolean;
            selected_provider: null | string;
            status: "failed" | "pending" | "authorized";
            url: string;
            wait_for_device_creation: boolean;
            workspace_id: string;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/connect_webviews/create";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    accepted_providers?: ("linear" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "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" | "yale_access" | "hid_cm")[];
    automatically_manage_new_devices?: boolean;
    custom_metadata?: Record<string, null | string | number | boolean>;
    custom_redirect_failure_url?: string;
    custom_redirect_url?: string;
    device_selection_mode?: "none" | "multiple" | "single";
    provider_category?: "stable" | "consumer_smartlocks" | "internal_beta";
    wait_for_device_creation?: boolean;
}
- Optional accepted_providers?: ("linear" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "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" | "yale_access" | "hid_cm")[]
- Optional automatically_manage_new_devices?: boolean
- Optional custom_metadata?: Record<string, null | string | number | boolean>
- Optional custom_redirect_failure_url?: string
- Optional custom_redirect_url?: string
- Optional device_selection_mode?: "none" | "multiple" | "single"
- Optional provider_category?: "stable" | "consumer_smartlocks" | "internal_beta"
- Optional wait_for_device_creation?: boolean
jsonResponse: {
    connect_webview: {
        accepted_devices: string[];
        accepted_providers: string[];
        any_device_allowed: boolean;
        any_provider_allowed: boolean;
        authorized_at: null | string;
        automatically_manage_new_devices: boolean;
        connect_webview_id: string;
        connected_account_id?: string;
        created_at: string;
        custom_metadata: Record<string, null | string | number | boolean>;
        custom_redirect_failure_url: null | string;
        custom_redirect_url: null | string;
        device_selection_mode: "none" | "multiple" | "single";
        login_successful: boolean;
        selected_provider: null | string;
        status: "failed" | "pending" | "authorized";
        url: string;
        wait_for_device_creation: boolean;
        workspace_id: string;
    };
}
- connect_webview: {
      accepted_devices: string[];
      accepted_providers: string[];
      any_device_allowed: boolean;
      any_provider_allowed: boolean;
      authorized_at: null | string;
      automatically_manage_new_devices: boolean;
      connect_webview_id: string;
      connected_account_id?: string;
      created_at: string;
      custom_metadata: Record<string, null | string | number | boolean>;
      custom_redirect_failure_url: null | string;
      custom_redirect_url: null | string;
      device_selection_mode: "none" | "multiple" | "single";
      login_successful: boolean;
      selected_provider: null | string;
      status: "failed" | "pending" | "authorized";
      url: string;
      wait_for_device_creation: boolean;
      workspace_id: string;
  }
  - accepted_devices: string[]
  - accepted_providers: string[]
  - any_device_allowed: boolean
  - any_provider_allowed: boolean
  - authorized_at: null | string
  - automatically_manage_new_devices: boolean
  - connect_webview_id: string
  - Optional connected_account_id?: string
  - created_at: string
  - custom_metadata: Record<string, null | string | number | boolean>
  - custom_redirect_failure_url: null | string
  - custom_redirect_url: null | string
  - device_selection_mode: "none" | "multiple" | "single"
  - login_successful: boolean
  - selected_provider: null | string
  - status: "failed" | "pending" | "authorized"
  - url: string
  - wait_for_device_creation: boolean
  - workspace_id: string
method: "POST"
queryParams: {}
route: "/connect_webviews/create"

/connect_webviews/delete

/connect_webviews/delete: {
    commonParams: {};
    formData: {};
    jsonBody: {
        connect_webview_id: string;
    };
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/connect_webviews/delete";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
connect_webview_id: string;
}
- connect_webview_id: string
jsonResponse: {}
method: "POST" | "DELETE"
queryParams: {}
route: "/connect_webviews/delete"

/connect_webviews/get

/connect_webviews/get: {
    commonParams: {
        connect_webview_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        connect_webview: {
            accepted_devices: string[];
            accepted_providers: string[];
            any_device_allowed: boolean;
            any_provider_allowed: boolean;
            authorized_at: null | string;
            automatically_manage_new_devices: boolean;
            connect_webview_id: string;
            connected_account_id?: string;
            created_at: string;
            custom_metadata: Record<string, null | string | number | boolean>;
            custom_redirect_failure_url: null | string;
            custom_redirect_url: null | string;
            device_selection_mode: "none" | "multiple" | "single";
            login_successful: boolean;
            selected_provider: null | string;
            status: "failed" | "pending" | "authorized";
            url: string;
            wait_for_device_creation: boolean;
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/connect_webviews/get";
}

Type declaration

commonParams: {
connect_webview_id: string;
}
- connect_webview_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    connect_webview: {
        accepted_devices: string[];
        accepted_providers: string[];
        any_device_allowed: boolean;
        any_provider_allowed: boolean;
        authorized_at: null | string;
        automatically_manage_new_devices: boolean;
        connect_webview_id: string;
        connected_account_id?: string;
        created_at: string;
        custom_metadata: Record<string, null | string | number | boolean>;
        custom_redirect_failure_url: null | string;
        custom_redirect_url: null | string;
        device_selection_mode: "none" | "multiple" | "single";
        login_successful: boolean;
        selected_provider: null | string;
        status: "failed" | "pending" | "authorized";
        url: string;
        wait_for_device_creation: boolean;
        workspace_id: string;
    };
}
- connect_webview: {
      accepted_devices: string[];
      accepted_providers: string[];
      any_device_allowed: boolean;
      any_provider_allowed: boolean;
      authorized_at: null | string;
      automatically_manage_new_devices: boolean;
      connect_webview_id: string;
      connected_account_id?: string;
      created_at: string;
      custom_metadata: Record<string, null | string | number | boolean>;
      custom_redirect_failure_url: null | string;
      custom_redirect_url: null | string;
      device_selection_mode: "none" | "multiple" | "single";
      login_successful: boolean;
      selected_provider: null | string;
      status: "failed" | "pending" | "authorized";
      url: string;
      wait_for_device_creation: boolean;
      workspace_id: string;
  }
  - accepted_devices: string[]
  - accepted_providers: string[]
  - any_device_allowed: boolean
  - any_provider_allowed: boolean
  - authorized_at: null | string
  - automatically_manage_new_devices: boolean
  - connect_webview_id: string
  - Optional connected_account_id?: string
  - created_at: string
  - custom_metadata: Record<string, null | string | number | boolean>
  - custom_redirect_failure_url: null | string
  - custom_redirect_url: null | string
  - device_selection_mode: "none" | "multiple" | "single"
  - login_successful: boolean
  - selected_provider: null | string
  - status: "failed" | "pending" | "authorized"
  - url: string
  - wait_for_device_creation: boolean
  - workspace_id: string
method: "POST" | "GET"
queryParams: {}
route: "/connect_webviews/get"

/connect_webviews/list

/connect_webviews/list: {
    commonParams: {
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        connect_webviews: {
            accepted_devices: string[];
            accepted_providers: string[];
            any_device_allowed: boolean;
            any_provider_allowed: boolean;
            authorized_at: null | string;
            automatically_manage_new_devices: boolean;
            connect_webview_id: string;
            connected_account_id?: string;
            created_at: string;
            custom_metadata: Record<string, null | string | number | boolean>;
            custom_redirect_failure_url: null | string;
            custom_redirect_url: null | string;
            device_selection_mode: "none" | "multiple" | "single";
            login_successful: boolean;
            selected_provider: null | string;
            status: "failed" | "pending" | "authorized";
            url: string;
            wait_for_device_creation: boolean;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/connect_webviews/list";
}

Type declaration

commonParams: {
user_identifier_key?: string;
}
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    connect_webviews: {
        accepted_devices: string[];
        accepted_providers: string[];
        any_device_allowed: boolean;
        any_provider_allowed: boolean;
        authorized_at: null | string;
        automatically_manage_new_devices: boolean;
        connect_webview_id: string;
        connected_account_id?: string;
        created_at: string;
        custom_metadata: Record<string, null | string | number | boolean>;
        custom_redirect_failure_url: null | string;
        custom_redirect_url: null | string;
        device_selection_mode: "none" | "multiple" | "single";
        login_successful: boolean;
        selected_provider: null | string;
        status: "failed" | "pending" | "authorized";
        url: string;
        wait_for_device_creation: boolean;
        workspace_id: string;
    }[];
}
- connect_webviews: {
      accepted_devices: string[];
      accepted_providers: string[];
      any_device_allowed: boolean;
      any_provider_allowed: boolean;
      authorized_at: null | string;
      automatically_manage_new_devices: boolean;
      connect_webview_id: string;
      connected_account_id?: string;
      created_at: string;
      custom_metadata: Record<string, null | string | number | boolean>;
      custom_redirect_failure_url: null | string;
      custom_redirect_url: null | string;
      device_selection_mode: "none" | "multiple" | "single";
      login_successful: boolean;
      selected_provider: null | string;
      status: "failed" | "pending" | "authorized";
      url: string;
      wait_for_device_creation: boolean;
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/connect_webviews/list"

/connect_webviews/view

/connect_webviews/view: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "GET";
    queryParams: {
        auth_token: string;
        connect_webview_id: string;
    };
    route: "/connect_webviews/view";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {}
method: "GET"
queryParams: {
auth_token: string;
connect_webview_id: string;
}
- auth_token: string
- connect_webview_id: string
route: "/connect_webviews/view"

/connected_accounts/delete

/connected_accounts/delete: {
    commonParams: {};
    formData: {};
    jsonBody: {
        connected_account_id: string;
        sync?: boolean;
    };
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/connected_accounts/delete";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
connected_account_id: string;
sync?: boolean;
}
- connected_account_id: string
- Optional sync?: boolean
jsonResponse: {}
method: "POST" | "DELETE"
queryParams: {}
route: "/connected_accounts/delete"

/connected_accounts/get

/connected_accounts/get: {
    commonParams: {
        connected_account_id: string;
    } | {
        email: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        connected_account: {
            account_type?: string;
            account_type_display_name: string;
            automatically_manage_new_devices: boolean;
            connected_account_id?: string;
            created_at?: string;
            custom_metadata?: Record<string, null | string | number | boolean>;
            errors?: any;
            user_identifier?: {
                api_url?: string;
                email?: string;
                exclusive?: boolean;
                phone?: string;
                username?: string;
            };
            warnings?: any;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/connected_accounts/get";
}

Type declaration

commonParams: {
connected_account_id: string;
} | {
email: string;
}
formData: {}
jsonBody: {}
jsonResponse: {
    connected_account: {
        account_type?: string;
        account_type_display_name: string;
        automatically_manage_new_devices: boolean;
        connected_account_id?: string;
        created_at?: string;
        custom_metadata?: Record<string, null | string | number | boolean>;
        errors?: any;
        user_identifier?: {
            api_url?: string;
            email?: string;
            exclusive?: boolean;
            phone?: string;
            username?: string;
        };
        warnings?: any;
    };
}
- connected_account: {
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | number | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }
  - Optional account_type?: string
  - account_type_display_name: string
  - automatically_manage_new_devices: boolean
  - Optional connected_account_id?: string
  - Optional created_at?: string
  - Optional custom_metadata?: Record<string, null | string | number | boolean>
  - Optional errors?: any
  - Optional user_identifier?: {
        api_url?: string;
        email?: string;
        exclusive?: boolean;
        phone?: string;
        username?: string;
    }
    - Optional api_url?: string
    - Optional email?: string
    - Optional exclusive?: boolean
    - Optional phone?: string
    - Optional username?: string
  - Optional warnings?: any
method: "POST" | "GET"
queryParams: {}
route: "/connected_accounts/get"

/connected_accounts/list

/connected_accounts/list: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        connected_accounts: {
            account_type?: string;
            account_type_display_name: string;
            automatically_manage_new_devices: boolean;
            connected_account_id?: string;
            created_at?: string;
            custom_metadata?: Record<string, null | string | number | boolean>;
            errors?: any;
            user_identifier?: {
                api_url?: string;
                email?: string;
                exclusive?: boolean;
                phone?: string;
                username?: string;
            };
            warnings?: any;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/connected_accounts/list";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
    connected_accounts: {
        account_type?: string;
        account_type_display_name: string;
        automatically_manage_new_devices: boolean;
        connected_account_id?: string;
        created_at?: string;
        custom_metadata?: Record<string, null | string | number | boolean>;
        errors?: any;
        user_identifier?: {
            api_url?: string;
            email?: string;
            exclusive?: boolean;
            phone?: string;
            username?: string;
        };
        warnings?: any;
    }[];
}
- connected_accounts: {
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | number | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/connected_accounts/list"

/connected_accounts/update

/connected_accounts/update: {
    commonParams: {};
    formData: {};
    jsonBody: {
        automatically_manage_new_devices?: boolean;
        connected_account_id: string;
    };
    jsonResponse: {
        connected_account: {
            account_type?: string;
            account_type_display_name: string;
            automatically_manage_new_devices: boolean;
            connected_account_id?: string;
            created_at?: string;
            custom_metadata?: Record<string, null | string | number | boolean>;
            errors?: any;
            user_identifier?: {
                api_url?: string;
                email?: string;
                exclusive?: boolean;
                phone?: string;
                username?: string;
            };
            warnings?: any;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/connected_accounts/update";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
automatically_manage_new_devices?: boolean;
connected_account_id: string;
}
- Optional automatically_manage_new_devices?: boolean
- connected_account_id: string
jsonResponse: {
    connected_account: {
        account_type?: string;
        account_type_display_name: string;
        automatically_manage_new_devices: boolean;
        connected_account_id?: string;
        created_at?: string;
        custom_metadata?: Record<string, null | string | number | boolean>;
        errors?: any;
        user_identifier?: {
            api_url?: string;
            email?: string;
            exclusive?: boolean;
            phone?: string;
            username?: string;
        };
        warnings?: any;
    };
}
- connected_account: {
      account_type?: string;
      account_type_display_name: string;
      automatically_manage_new_devices: boolean;
      connected_account_id?: string;
      created_at?: string;
      custom_metadata?: Record<string, null | string | number | boolean>;
      errors?: any;
      user_identifier?: {
          api_url?: string;
          email?: string;
          exclusive?: boolean;
          phone?: string;
          username?: string;
      };
      warnings?: any;
  }
  - Optional account_type?: string
  - account_type_display_name: string
  - automatically_manage_new_devices: boolean
  - Optional connected_account_id?: string
  - Optional created_at?: string
  - Optional custom_metadata?: Record<string, null | string | number | boolean>
  - Optional errors?: any
  - Optional user_identifier?: {
        api_url?: string;
        email?: string;
        exclusive?: boolean;
        phone?: string;
        username?: string;
    }
    - Optional api_url?: string
    - Optional email?: string
    - Optional exclusive?: boolean
    - Optional phone?: string
    - Optional username?: string
  - Optional warnings?: any
method: "POST"
queryParams: {}
route: "/connected_accounts/update"

/devices/delete

/devices/delete: {
    commonParams: {
        device_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/devices/delete";
}

Type declaration

commonParams: {
device_id: string;
}
- device_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
queryParams: {}
route: "/devices/delete"

/devices/get

/devices/get: {
    commonParams: {
        device_id?: string;
        name?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        device: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/devices/get";
}

Type declaration

commonParams: {
device_id?: string;
name?: string;
}
- Optional device_id?: string
- Optional name?: string
formData: {}
jsonBody: {}
jsonResponse: {
    device: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    };
}
- device: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }
  - capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[]
    Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.
  - connected_account_id: string
    Unique identifier for the account associated with the device.
  - created_at: string
    Date and time at which the device object was created.
  - device_id: string
    Unique identifier for the device.
  - 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
    Type of the device.
  - errors: {
    error_code: string;
    message: string;
    }[]
    Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
  - is_managed: true
    Indicates whether Seam manages the device.
  - location: null | {
    location_name?: string;
    timezone?: string;
    }
    Location information for the device.
  - properties: {
        active_climate_setting_schedule?: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        };
        august_metadata?: {
            has_keypad: boolean;
            house_id?: string;
            house_name: string;
            keypad_battery_level?: string;
            lock_id: string;
            lock_name: string;
            model?: string;
        };
        available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
        avigilon_alta_metadata?: {
            entry_name: string;
            org_name: string;
            site_id: number;
            site_name: string;
            zone_id: number;
            zone_name: string;
        };
        battery?: {
            level: number;
            status: "low" | "full" | "critical" | "good";
        };
        battery_level?: number;
        brivo_metadata?: {
            device_name: string;
        };
        can_enable_automatic_cooling?: boolean;
        can_enable_automatic_heating?: boolean;
        code_constraints?: ({
            constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
        } | {
            constraint_type: "name_length";
            max_length?: number;
            min_length?: number;
        })[];
        controlbyweb_metadata?: {
            device_id: string;
            device_name: string;
            relay_name: null | string;
        };
        current_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        default_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        door_open?: boolean;
        dormakaba_oracode_metadata?: {
            device_id?: number;
            door_id: number;
            door_name: string;
            iana_timezone?: string;
            predefined_time_slots?: {
                check_in_time: string;
                check_out_time: string;
                dormakaba_oracode_user_level_id: string;
                ext_dormakaba_oracode_user_level_prefix: number;
                is_24_hour: boolean;
                is_biweekly_mode: boolean;
                is_master: boolean;
                is_one_shot: boolean;
                name: string;
                prefix: number;
            }[];
            site_id: number;
            site_name: string;
        };
        ecobee_metadata?: {
            device_name: string;
            ecobee_device_id: string;
        };
        fan_mode_setting?: "auto" | "on";
        four_suites_metadata?: {
            device_id: number;
            device_name: string;
            reclose_delay_in_seconds: number;
        };
        genie_metadata?: {
            device_name: string;
            door_name: string;
        };
        has_direct_power?: boolean;
        has_native_entry_events?: boolean;
        hubitat_metadata?: {
            device_id: string;
            device_label: string;
            device_name: string;
        };
        igloo_metadata?: {
            bridge_id: string;
            device_id: string;
            model?: string;
        };
        igloohome_metadata?: {
            bridge_id?: string;
            bridge_name?: string;
            device_id: string;
            device_name: string;
        };
        image_alt_text?: string;
        image_url?: string;
        is_climate_setting_schedule_active?: boolean;
        is_cooling?: boolean;
        is_cooling_available?: boolean;
        is_fan_running?: boolean;
        is_heating?: boolean;
        is_heating_available?: boolean;
        is_temporary_manual_override_active?: boolean;
        keypad_battery?: {
            level: number;
        };
        kwikset_metadata?: {
            device_id: string;
            device_name: string;
            model_number: string;
        };
        locked?: boolean;
        lockly_metadata?: {
            device_id: string;
            device_name: string;
            model?: string;
        };
        manufacturer?: string;
        max_active_codes_supported?: number;
        minut_metadata?: {
            device_id: string;
            device_name: string;
            latest_sensor_values: {
                accelerometer_z: {
                    time: string;
                    value: number;
                };
                humidity: {
                    time: string;
                    value: number;
                };
                pressure: {
                    time: string;
                    value: number;
                };
                sound: {
                    time: string;
                    value: number;
                };
                temperature: {
                    time: string;
                    value: number;
                };
            };
        };
        model: {
            accessory_keypad_supported?: boolean;
            display_name: string;
            manufacturer_display_name: string;
            offline_access_codes_supported?: boolean;
            online_access_codes_supported?: boolean;
        };
        name: string;
        nest_metadata?: {
            custom_name: string;
            device_name: string;
            nest_device_id: string;
        };
        noiseaware_metadata?: {
            device_id: string;
            device_model: "indoor" | "outdoor";
            device_name: string;
            noise_level_decibel: number;
            noise_level_nrs: number;
        };
        nuki_metadata?: {
            device_id: string;
            device_name: string;
            keypad_battery_critical?: boolean;
        };
        offline_access_codes_enabled?: boolean;
        online: boolean;
        online_access_codes_enabled?: boolean;
        relative_humidity?: number;
        salto_metadata?: {
            battery_level: string;
            customer_reference: string;
            lock_id: string;
            lock_type: string;
            locked_state: string;
            model?: string;
        };
        schlage_metadata?: {
            access_code_length: number;
            device_id: string;
            device_name: string;
            model?: string;
        };
        seam_bridge_metadata?: {
            device_num: number;
            name: string;
            unlock_method?: "bridge" | "doorking";
        };
        serial_number?: string;
        smartthings_metadata?: {
            device_id: string;
            device_name: string;
            location_id?: string;
            model?: string;
        };
        supported_code_lengths?: number[];
        supports_accessory_keypad?: boolean;
        supports_backup_access_code_pool?: boolean;
        supports_offline_access_codes?: boolean;
        temperature_celsius?: number;
        temperature_fahrenheit?: number;
        ttlock_metadata?: {
            lock_alias: string;
            lock_id: number;
        };
        two_n_metadata?: {
            device_id: number;
            device_name: string;
        };
        wyze_metadata?: {
            device_id: string;
            device_info_model: string;
            device_name: string;
            product_model: string;
            product_name: string;
            product_type: string;
        };
    }
    Properties of the device.
    - Optional active_climate_setting_schedule?: {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      }
    - Optional august_metadata?: {
          has_keypad: boolean;
          house_id?: string;
          house_name: string;
          keypad_battery_level?: string;
          lock_id: string;
          lock_name: string;
          model?: string;
      }
      - has_keypad: boolean
      - Optional house_id?: string
      - house_name: string
      - Optional keypad_battery_level?: string
      - lock_id: string
      - lock_name: string
      - Optional model?: string
    - Optional available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[]
    - Optional avigilon_alta_metadata?: {
          entry_name: string;
          org_name: string;
          site_id: number;
          site_name: string;
          zone_id: number;
          zone_name: string;
      }
      - entry_name: string
      - org_name: string
      - site_id: number
      - site_name: string
      - zone_id: number
      - zone_name: string
    - Optional battery?: {
      level: number;
      status: "low" | "full" | "critical" | "good";
      }
      Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.
      - level: number
      - status: "low" | "full" | "critical" | "good"
    - Optional battery_level?: number
      Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
    - Optional brivo_metadata?: {
      device_name: string;
      }
      - device_name: string
    - Optional can_enable_automatic_cooling?: boolean
    - Optional can_enable_automatic_heating?: boolean
    - Optional code_constraints?: ({
          constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
      } | {
          constraint_type: "name_length";
          max_length?: number;
          min_length?: number;
      })[]
    - Optional controlbyweb_metadata?: {
          device_id: string;
          device_name: string;
          relay_name: null | string;
      }
      - device_id: string
      - device_name: string
      - relay_name: null | string
    - Optional current_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional default_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional door_open?: boolean
    - Optional dormakaba_oracode_metadata?: {
          device_id?: number;
          door_id: number;
          door_name: string;
          iana_timezone?: string;
          predefined_time_slots?: {
              check_in_time: string;
              check_out_time: string;
              dormakaba_oracode_user_level_id: string;
              ext_dormakaba_oracode_user_level_prefix: number;
              is_24_hour: boolean;
              is_biweekly_mode: boolean;
              is_master: boolean;
              is_one_shot: boolean;
              name: string;
              prefix: number;
          }[];
          site_id: number;
          site_name: string;
      }
      - Optional device_id?: number
      - door_id: number
      - door_name: string
      - Optional iana_timezone?: string
      - Optional predefined_time_slots?: {
            check_in_time: string;
            check_out_time: string;
            dormakaba_oracode_user_level_id: string;
            ext_dormakaba_oracode_user_level_prefix: number;
            is_24_hour: boolean;
            is_biweekly_mode: boolean;
            is_master: boolean;
            is_one_shot: boolean;
            name: string;
            prefix: number;
        }[]
      - site_id: number
      - site_name: string
    - Optional ecobee_metadata?: {
      device_name: string;
      ecobee_device_id: string;
      }
      - device_name: string
      - ecobee_device_id: string
    - Optional fan_mode_setting?: "auto" | "on"
    - Optional four_suites_metadata?: {
          device_id: number;
          device_name: string;
          reclose_delay_in_seconds: number;
      }
      - device_id: number
      - device_name: string
      - reclose_delay_in_seconds: number
    - Optional genie_metadata?: {
      device_name: string;
      door_name: string;
      }
      - device_name: string
      - door_name: string
    - Optional has_direct_power?: boolean
      Indicates whether the device has direct power.
    - Optional has_native_entry_events?: boolean
    - Optional hubitat_metadata?: {
          device_id: string;
          device_label: string;
          device_name: string;
      }
      - device_id: string
      - device_label: string
      - device_name: string
    - Optional igloo_metadata?: {
          bridge_id: string;
          device_id: string;
          model?: string;
      }
      - bridge_id: string
      - device_id: string
      - Optional model?: string
    - Optional igloohome_metadata?: {
          bridge_id?: string;
          bridge_name?: string;
          device_id: string;
          device_name: string;
      }
      - Optional bridge_id?: string
      - Optional bridge_name?: string
      - device_id: string
      - device_name: string
    - Optional image_alt_text?: string
      Alt text for the device image.
    - Optional image_url?: string
      Image URL for the device.
    - Optional is_climate_setting_schedule_active?: boolean
    - Optional is_cooling?: boolean
    - Optional is_cooling_available?: boolean
    - Optional is_fan_running?: boolean
    - Optional is_heating?: boolean
    - Optional is_heating_available?: boolean
    - Optional is_temporary_manual_override_active?: boolean
    - Optional keypad_battery?: {
      level: number;
      }
      - level: number
    - Optional kwikset_metadata?: {
          device_id: string;
          device_name: string;
          model_number: string;
      }
      - device_id: string
      - device_name: string
      - model_number: string
    - Optional locked?: boolean
    - Optional lockly_metadata?: {
          device_id: string;
          device_name: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional manufacturer?: string
      Manufacturer of the device.
    - Optional max_active_codes_supported?: number
    - Optional minut_metadata?: {
          device_id: string;
          device_name: string;
          latest_sensor_values: {
              accelerometer_z: {
                  time: string;
                  value: number;
              };
              humidity: {
                  time: string;
                  value: number;
              };
              pressure: {
                  time: string;
                  value: number;
              };
              sound: {
                  time: string;
                  value: number;
              };
              temperature: {
                  time: string;
                  value: number;
              };
          };
      }
      - device_id: string
      - device_name: string
      - latest_sensor_values: {
            accelerometer_z: {
                time: string;
                value: number;
            };
            humidity: {
                time: string;
                value: number;
            };
            pressure: {
                time: string;
                value: number;
            };
            sound: {
                time: string;
                value: number;
            };
            temperature: {
                time: string;
                value: number;
            };
        }
        accelerometer_z: {
            time: string;
            value: number;
        }
        time: string
        value: number
        humidity: {
            time: string;
            value: number;
        }
        time: string
        value: number
        pressure: {
            time: string;
            value: number;
        }
        time: string
        value: number
        sound: {
            time: string;
            value: number;
        }
        time: string
        value: number
        temperature: {
            time: string;
            value: number;
        }
        time: string
        value: number
    - model: {
          accessory_keypad_supported?: boolean;
          display_name: string;
          manufacturer_display_name: string;
          offline_access_codes_supported?: boolean;
          online_access_codes_supported?: boolean;
      }
      - Optional accessory_keypad_supported?: boolean
        Indicates whether the device supports an accessory keypad.
      - display_name: string
        Display name of the device model.
      - manufacturer_display_name: string
        Display name that corresponds to the manufacturer-specific terminology for the device.
      - Optional offline_access_codes_supported?: boolean
        Indicates whether the device supports offline access codes.
      - Optional online_access_codes_supported?: boolean
        Indicates whether the device supports online access codes.
    - name: string
      Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.
    - Optional nest_metadata?: {
          custom_name: string;
          device_name: string;
          nest_device_id: string;
      }
      - custom_name: string
      - device_name: string
      - nest_device_id: string
    - Optional noiseaware_metadata?: {
          device_id: string;
          device_model: "indoor" | "outdoor";
          device_name: string;
          noise_level_decibel: number;
          noise_level_nrs: number;
      }
      - device_id: string
      - device_model: "indoor" | "outdoor"
      - device_name: string
      - noise_level_decibel: number
      - noise_level_nrs: number
    - Optional nuki_metadata?: {
          device_id: string;
          device_name: string;
          keypad_battery_critical?: boolean;
      }
      - device_id: string
      - device_name: string
      - Optional keypad_battery_critical?: boolean
    - Optional offline_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use offline access codes for the device.
    - online: boolean
      Indicates whether the device is online.
    - Optional online_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use online access codes for the device.
    - Optional relative_humidity?: number
    - Optional salto_metadata?: {
          battery_level: string;
          customer_reference: string;
          lock_id: string;
          lock_type: string;
          locked_state: string;
          model?: string;
      }
      - battery_level: string
      - customer_reference: string
      - lock_id: string
      - lock_type: string
      - locked_state: string
      - Optional model?: string
    - Optional schlage_metadata?: {
          access_code_length: number;
          device_id: string;
          device_name: string;
          model?: string;
      }
      - access_code_length: number
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional seam_bridge_metadata?: {
          device_num: number;
          name: string;
          unlock_method?: "bridge" | "doorking";
      }
      - device_num: number
      - name: string
      - Optional unlock_method?: "bridge" | "doorking"
    - Optional serial_number?: string
      Serial number of the device.
    - Optional smartthings_metadata?: {
          device_id: string;
          device_name: string;
          location_id?: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional location_id?: string
      - Optional model?: string
    - Optional supported_code_lengths?: number[]
    - Optional supports_accessory_keypad?: boolean
      Deprecated. Use model.accessory_keypad_supported.
    - Optional supports_backup_access_code_pool?: boolean
    - Optional supports_offline_access_codes?: boolean
      Deprecated. Use offline_access_codes_enabled.
    - Optional temperature_celsius?: number
    - Optional temperature_fahrenheit?: number
    - Optional ttlock_metadata?: {
      lock_alias: string;
      lock_id: number;
      }
      - lock_alias: string
      - lock_id: number
    - Optional two_n_metadata?: {
      device_id: number;
      device_name: string;
      }
      - device_id: number
      - device_name: string
    - Optional wyze_metadata?: {
          device_id: string;
          device_info_model: string;
          device_name: string;
          product_model: string;
          product_name: string;
          product_type: string;
      }
      - device_id: string
      - device_info_model: string
      - device_name: string
      - product_model: string
      - product_name: string
      - product_type: string
  - warnings: {
    message: string;
    warning_code: string;
    }[]
    Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
  - workspace_id: string
    Unique identifier for the Seam workspace associated with the device.
method: "POST" | "GET"
queryParams: {}
route: "/devices/get"

/devices/list

/devices/list: {
    commonParams: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
        limit?: number;
        manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        devices: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/devices/list";
}

Type declaration

commonParams: {
    connect_webview_id?: string;
    connected_account_id?: string;
    connected_account_ids?: string[];
    created_before?: Date;
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
    limit?: number;
    manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
    user_identifier_key?: string;
}
- Optional connect_webview_id?: string
- Optional connected_account_id?: string
  List all devices owned by this connected account
- Optional connected_account_ids?: string[]
- Optional created_before?: Date
- Optional device_ids?: string[]
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[]
- Optional limit?: number
- Optional manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    devices: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    }[];
}
- devices: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/devices/list"

/devices/list_device_providers

/devices/list_device_providers: {
    commonParams: {
        provider_category?: "stable" | "consumer_smartlocks";
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        device_providers: {
            device_provider_name: string;
            display_name: string;
            image_url: string;
            provider_categories: ("stable" | "consumer_smartlocks")[];
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/devices/list_device_providers";
}

Type declaration

commonParams: {
provider_category?: "stable" | "consumer_smartlocks";
}
- Optional provider_category?: "stable" | "consumer_smartlocks"
formData: {}
jsonBody: {}
jsonResponse: {
    device_providers: {
        device_provider_name: string;
        display_name: string;
        image_url: string;
        provider_categories: ("stable" | "consumer_smartlocks")[];
    }[];
}
- device_providers: {
      device_provider_name: string;
      display_name: string;
      image_url: string;
      provider_categories: ("stable" | "consumer_smartlocks")[];
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/devices/list_device_providers"

/devices/unmanaged/get

/devices/unmanaged/get: {
    commonParams: {
        device_id?: string;
        name?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        device: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: false;
            properties: {
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                image_alt_text?: string;
                image_url?: string;
                manufacturer?: string;
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    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: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/devices/unmanaged/get";
}

Type declaration

commonParams: {
device_id?: string;
name?: string;
}
- Optional device_id?: string
- Optional name?: string
formData: {}
jsonBody: {}
jsonResponse: {
    device: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: false;
        properties: {
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            image_alt_text?: string;
            image_url?: string;
            manufacturer?: string;
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                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: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    };
}
- device: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: false;
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              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: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }
  - capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[]
    Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.
  - connected_account_id: string
    Unique identifier for the account associated with the device.
  - created_at: string
    Date and time at which the device object was created.
  - device_id: string
    Unique identifier for the device.
  - 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
    Type of the device.
  - errors: {
    error_code: string;
    message: string;
    }[]
    Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
  - is_managed: false
  - properties: {
        battery?: {
            level: number;
            status: "low" | "full" | "critical" | "good";
        };
        battery_level?: number;
        image_alt_text?: string;
        image_url?: string;
        manufacturer?: string;
        model: {
            accessory_keypad_supported?: boolean;
            display_name: string;
            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;
    }
    - Optional battery?: {
      level: number;
      status: "low" | "full" | "critical" | "good";
      }
      Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.
      - level: number
      - status: "low" | "full" | "critical" | "good"
    - Optional battery_level?: number
      Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
    - Optional image_alt_text?: string
      Alt text for the device image.
    - Optional image_url?: string
      Image URL for the device.
    - Optional manufacturer?: string
      Manufacturer of the device.
    - model: {
          accessory_keypad_supported?: boolean;
          display_name: string;
          manufacturer_display_name: string;
          offline_access_codes_supported?: boolean;
          online_access_codes_supported?: boolean;
      }
      - Optional accessory_keypad_supported?: boolean
        Indicates whether the device supports an accessory keypad.
      - display_name: string
        Display name of the device model.
      - manufacturer_display_name: string
        Display name that corresponds to the manufacturer-specific terminology for the device.
      - Optional offline_access_codes_supported?: boolean
        Indicates whether the device supports offline access codes.
      - Optional online_access_codes_supported?: boolean
        Indicates whether the device supports online access codes.
    - name: string
      Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.
    - Optional offline_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use offline access codes for the device.
    - online: boolean
      Indicates whether the device is online.
    - Optional online_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use online access codes for the device.
  - warnings: {
    message: string;
    warning_code: string;
    }[]
    Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
  - workspace_id: string
    Unique identifier for the Seam workspace associated with the device.
method: "POST" | "GET"
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;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
        limit?: number;
        manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        devices: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: false;
            properties: {
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                image_alt_text?: string;
                image_url?: string;
                manufacturer?: string;
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    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: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/devices/unmanaged/list";
}

Type declaration

commonParams: {
    connect_webview_id?: string;
    connected_account_id?: string;
    connected_account_ids?: string[];
    created_before?: Date;
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
    limit?: number;
    manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
    user_identifier_key?: string;
}
- Optional connect_webview_id?: string
- Optional connected_account_id?: string
  List all devices owned by this connected account
- Optional connected_account_ids?: string[]
- Optional created_before?: Date
- Optional device_ids?: string[]
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[]
- Optional limit?: number
- Optional manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    devices: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: false;
        properties: {
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            image_alt_text?: string;
            image_url?: string;
            manufacturer?: string;
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                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: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    }[];
}
- devices: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: false;
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              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: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/devices/unmanaged/list"

/devices/unmanaged/update

/devices/unmanaged/update: {
    commonParams: {
        device_id: string;
        is_managed: true;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/devices/unmanaged/update";
}

Type declaration

commonParams: {
device_id: string;
is_managed: true;
}
- device_id: string
- is_managed: true
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "PATCH"
queryParams: {}
route: "/devices/unmanaged/update"

/devices/update

/devices/update: {
    commonParams: {
        device_id: string;
        is_managed?: boolean;
        location?: {};
        name?: null | string;
        properties?: {
            name?: null | string;
        };
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/devices/update";
}

Type declaration

commonParams: {
    device_id: string;
    is_managed?: boolean;
    location?: {};
    name?: null | string;
    properties?: {
        name?: null | string;
    };
}
- device_id: string
- Optional is_managed?: boolean
- Optional location?: {}
- Optional name?: null | string
- Optional properties?: {
  name?: null | string;
  }
  - Optional name?: null | string
formData: {}
jsonBody: {}
jsonResponse: {}
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?: {
            created_at: string;
            device_id?: string;
            event_id: string;
            event_type: string;
            occurred_at: string;
            workspace_id: string;
        };
        message?: string;
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/events/get";
}

Type declaration

commonParams: {
    device_id?: string;
    event_id?: string;
    event_type?: string;
}
- Optional device_id?: string
- Optional event_id?: string
- Optional event_type?: string
formData: {}
jsonBody: {}
jsonResponse: {
    event?: {
        created_at: string;
        device_id?: string;
        event_id: string;
        event_type: string;
        occurred_at: string;
        workspace_id: string;
    };
    message?: string;
}
- Optional event?: {
      created_at: string;
      device_id?: string;
      event_id: string;
      event_type: string;
      occurred_at: string;
      workspace_id: string;
  }
  - created_at: string
  - Optional device_id?: string
  - event_id: string
  - event_type: string
  - occurred_at: string
  - workspace_id: string
- Optional message?: string
method: "POST" | "GET"
queryParams: {}
route: "/events/get"

/events/list

/events/list: {
    commonParams: {
        access_code_id?: string;
        access_code_ids?: string[];
        between?: (string | Date)[];
        connected_account_id?: string;
        device_id?: string;
        device_ids?: string[];
        event_type?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled";
        event_types?: ("device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled")[];
        since?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        events?: {
            created_at: string;
            device_id?: string;
            event_id: string;
            event_type: string;
            occurred_at: string;
            workspace_id: string;
        }[];
        message?: string;
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/events/list";
}

Type declaration

commonParams: {
    access_code_id?: string;
    access_code_ids?: string[];
    between?: (string | Date)[];
    connected_account_id?: string;
    device_id?: string;
    device_ids?: string[];
    event_type?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled";
    event_types?: ("device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled")[];
    since?: string;
}
- Optional access_code_id?: string
- Optional access_code_ids?: string[]
- Optional between?: (string | Date)[]
- Optional connected_account_id?: string
- Optional device_id?: string
- Optional device_ids?: string[]
- Optional event_type?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled"
- Optional event_types?: ("device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled")[]
- Optional since?: string
formData: {}
jsonBody: {}
jsonResponse: {
    events?: {
        created_at: string;
        device_id?: string;
        event_id: string;
        event_type: string;
        occurred_at: string;
        workspace_id: string;
    }[];
    message?: string;
}
- Optional events?: {
      created_at: string;
      device_id?: string;
      event_id: string;
      event_type: string;
      occurred_at: string;
      workspace_id: string;
  }[]
- Optional message?: string
method: "POST" | "GET"
queryParams: {}
route: "/events/list"

/health

/health: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        last_service_evaluation_at?: string;
        msg: "I’m one with the Force. The Force is with me.";
        ok: boolean;
        service_health_statuses: {
            description: string;
            service: string;
            status: "healthy" | "degraded" | "down";
        }[];
    };
    method: "GET";
    queryParams: {};
    route: "/health";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
    last_service_evaluation_at?: string;
    msg: "I’m one with the Force. The Force is with me.";
    ok: boolean;
    service_health_statuses: {
        description: string;
        service: string;
        status: "healthy" | "degraded" | "down";
    }[];
}
- Optional last_service_evaluation_at?: string
- msg: "I’m one with the Force. The Force is with me."
- ok: boolean
- service_health_statuses: {
      description: string;
      service: string;
      status: "healthy" | "degraded" | "down";
  }[]
method: "GET"
queryParams: {}
route: "/health"

/health/get_health

/health/get_health: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        last_service_evaluation_at?: string;
        msg: "I’m one with the Force. The Force is with me.";
        ok: boolean;
        service_health_statuses: {
            description: string;
            service: string;
            status: "healthy" | "degraded" | "down";
        }[];
    };
    method: "GET";
    queryParams: {};
    route: "/health/get_health";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
    last_service_evaluation_at?: string;
    msg: "I’m one with the Force. The Force is with me.";
    ok: boolean;
    service_health_statuses: {
        description: string;
        service: string;
        status: "healthy" | "degraded" | "down";
    }[];
}
- Optional last_service_evaluation_at?: string
- msg: "I’m one with the Force. The Force is with me."
- ok: boolean
- service_health_statuses: {
      description: string;
      service: string;
      status: "healthy" | "degraded" | "down";
  }[]
method: "GET"
queryParams: {}
route: "/health/get_health"

/health/get_service_health

/health/get_service_health: {
    commonParams: {
        service: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        last_service_evaluation_at: string;
        ok: true;
        service_health: {
            description: string;
            service: string;
            status: "healthy" | "degraded" | "down";
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/health/get_service_health";
}

Type declaration

commonParams: {
service: string;
}
- service: string
formData: {}
jsonBody: {}
jsonResponse: {
    last_service_evaluation_at: string;
    ok: true;
    service_health: {
        description: string;
        service: string;
        status: "healthy" | "degraded" | "down";
    };
}
- last_service_evaluation_at: string
- ok: true
- service_health: {
      description: string;
      service: string;
      status: "healthy" | "degraded" | "down";
  }
  - description: string
  - service: string
  - status: "healthy" | "degraded" | "down"
method: "POST" | "GET"
queryParams: {}
route: "/health/get_service_health"

/health/service/[service_name]

/health/service/[service_name]: {
    commonParams: {
        service_name: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        last_service_evaluation_at: string;
        ok: true;
        service_health: {
            description: string;
            service: string;
            status: "healthy" | "degraded" | "down";
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/health/service/[service_name]";
}

Type declaration

commonParams: {
service_name: string;
}
- service_name: string
formData: {}
jsonBody: {}
jsonResponse: {
    last_service_evaluation_at: string;
    ok: true;
    service_health: {
        description: string;
        service: string;
        status: "healthy" | "degraded" | "down";
    };
}
- last_service_evaluation_at: string
- ok: true
- service_health: {
      description: string;
      service: string;
      status: "healthy" | "degraded" | "down";
  }
  - description: string
  - service: string
  - status: "healthy" | "degraded" | "down"
method: "POST" | "GET"
queryParams: {}
route: "/health/service/[service_name]"

/locks/get

/locks/get: {
    commonParams: {
        device_id?: string;
        name?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        device: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        };
        lock: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/locks/get";
}

Type declaration

commonParams: {
device_id?: string;
name?: string;
}
- Optional device_id?: string
- Optional name?: string
formData: {}
jsonBody: {}
jsonResponse: {
    device: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    };
    lock: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    };
}
- device: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }
  - capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[]
    Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.
  - connected_account_id: string
    Unique identifier for the account associated with the device.
  - created_at: string
    Date and time at which the device object was created.
  - device_id: string
    Unique identifier for the device.
  - 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
    Type of the device.
  - errors: {
    error_code: string;
    message: string;
    }[]
    Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
  - is_managed: true
    Indicates whether Seam manages the device.
  - location: null | {
    location_name?: string;
    timezone?: string;
    }
    Location information for the device.
  - properties: {
        active_climate_setting_schedule?: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        };
        august_metadata?: {
            has_keypad: boolean;
            house_id?: string;
            house_name: string;
            keypad_battery_level?: string;
            lock_id: string;
            lock_name: string;
            model?: string;
        };
        available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
        avigilon_alta_metadata?: {
            entry_name: string;
            org_name: string;
            site_id: number;
            site_name: string;
            zone_id: number;
            zone_name: string;
        };
        battery?: {
            level: number;
            status: "low" | "full" | "critical" | "good";
        };
        battery_level?: number;
        brivo_metadata?: {
            device_name: string;
        };
        can_enable_automatic_cooling?: boolean;
        can_enable_automatic_heating?: boolean;
        code_constraints?: ({
            constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
        } | {
            constraint_type: "name_length";
            max_length?: number;
            min_length?: number;
        })[];
        controlbyweb_metadata?: {
            device_id: string;
            device_name: string;
            relay_name: null | string;
        };
        current_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        default_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        door_open?: boolean;
        dormakaba_oracode_metadata?: {
            device_id?: number;
            door_id: number;
            door_name: string;
            iana_timezone?: string;
            predefined_time_slots?: {
                check_in_time: string;
                check_out_time: string;
                dormakaba_oracode_user_level_id: string;
                ext_dormakaba_oracode_user_level_prefix: number;
                is_24_hour: boolean;
                is_biweekly_mode: boolean;
                is_master: boolean;
                is_one_shot: boolean;
                name: string;
                prefix: number;
            }[];
            site_id: number;
            site_name: string;
        };
        ecobee_metadata?: {
            device_name: string;
            ecobee_device_id: string;
        };
        fan_mode_setting?: "auto" | "on";
        four_suites_metadata?: {
            device_id: number;
            device_name: string;
            reclose_delay_in_seconds: number;
        };
        genie_metadata?: {
            device_name: string;
            door_name: string;
        };
        has_direct_power?: boolean;
        has_native_entry_events?: boolean;
        hubitat_metadata?: {
            device_id: string;
            device_label: string;
            device_name: string;
        };
        igloo_metadata?: {
            bridge_id: string;
            device_id: string;
            model?: string;
        };
        igloohome_metadata?: {
            bridge_id?: string;
            bridge_name?: string;
            device_id: string;
            device_name: string;
        };
        image_alt_text?: string;
        image_url?: string;
        is_climate_setting_schedule_active?: boolean;
        is_cooling?: boolean;
        is_cooling_available?: boolean;
        is_fan_running?: boolean;
        is_heating?: boolean;
        is_heating_available?: boolean;
        is_temporary_manual_override_active?: boolean;
        keypad_battery?: {
            level: number;
        };
        kwikset_metadata?: {
            device_id: string;
            device_name: string;
            model_number: string;
        };
        locked?: boolean;
        lockly_metadata?: {
            device_id: string;
            device_name: string;
            model?: string;
        };
        manufacturer?: string;
        max_active_codes_supported?: number;
        minut_metadata?: {
            device_id: string;
            device_name: string;
            latest_sensor_values: {
                accelerometer_z: {
                    time: string;
                    value: number;
                };
                humidity: {
                    time: string;
                    value: number;
                };
                pressure: {
                    time: string;
                    value: number;
                };
                sound: {
                    time: string;
                    value: number;
                };
                temperature: {
                    time: string;
                    value: number;
                };
            };
        };
        model: {
            accessory_keypad_supported?: boolean;
            display_name: string;
            manufacturer_display_name: string;
            offline_access_codes_supported?: boolean;
            online_access_codes_supported?: boolean;
        };
        name: string;
        nest_metadata?: {
            custom_name: string;
            device_name: string;
            nest_device_id: string;
        };
        noiseaware_metadata?: {
            device_id: string;
            device_model: "indoor" | "outdoor";
            device_name: string;
            noise_level_decibel: number;
            noise_level_nrs: number;
        };
        nuki_metadata?: {
            device_id: string;
            device_name: string;
            keypad_battery_critical?: boolean;
        };
        offline_access_codes_enabled?: boolean;
        online: boolean;
        online_access_codes_enabled?: boolean;
        relative_humidity?: number;
        salto_metadata?: {
            battery_level: string;
            customer_reference: string;
            lock_id: string;
            lock_type: string;
            locked_state: string;
            model?: string;
        };
        schlage_metadata?: {
            access_code_length: number;
            device_id: string;
            device_name: string;
            model?: string;
        };
        seam_bridge_metadata?: {
            device_num: number;
            name: string;
            unlock_method?: "bridge" | "doorking";
        };
        serial_number?: string;
        smartthings_metadata?: {
            device_id: string;
            device_name: string;
            location_id?: string;
            model?: string;
        };
        supported_code_lengths?: number[];
        supports_accessory_keypad?: boolean;
        supports_backup_access_code_pool?: boolean;
        supports_offline_access_codes?: boolean;
        temperature_celsius?: number;
        temperature_fahrenheit?: number;
        ttlock_metadata?: {
            lock_alias: string;
            lock_id: number;
        };
        two_n_metadata?: {
            device_id: number;
            device_name: string;
        };
        wyze_metadata?: {
            device_id: string;
            device_info_model: string;
            device_name: string;
            product_model: string;
            product_name: string;
            product_type: string;
        };
    }
    Properties of the device.
    - Optional active_climate_setting_schedule?: {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      }
    - Optional august_metadata?: {
          has_keypad: boolean;
          house_id?: string;
          house_name: string;
          keypad_battery_level?: string;
          lock_id: string;
          lock_name: string;
          model?: string;
      }
      - has_keypad: boolean
      - Optional house_id?: string
      - house_name: string
      - Optional keypad_battery_level?: string
      - lock_id: string
      - lock_name: string
      - Optional model?: string
    - Optional available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[]
    - Optional avigilon_alta_metadata?: {
          entry_name: string;
          org_name: string;
          site_id: number;
          site_name: string;
          zone_id: number;
          zone_name: string;
      }
      - entry_name: string
      - org_name: string
      - site_id: number
      - site_name: string
      - zone_id: number
      - zone_name: string
    - Optional battery?: {
      level: number;
      status: "low" | "full" | "critical" | "good";
      }
      Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.
      - level: number
      - status: "low" | "full" | "critical" | "good"
    - Optional battery_level?: number
      Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
    - Optional brivo_metadata?: {
      device_name: string;
      }
      - device_name: string
    - Optional can_enable_automatic_cooling?: boolean
    - Optional can_enable_automatic_heating?: boolean
    - Optional code_constraints?: ({
          constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
      } | {
          constraint_type: "name_length";
          max_length?: number;
          min_length?: number;
      })[]
    - Optional controlbyweb_metadata?: {
          device_id: string;
          device_name: string;
          relay_name: null | string;
      }
      - device_id: string
      - device_name: string
      - relay_name: null | string
    - Optional current_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional default_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional door_open?: boolean
    - Optional dormakaba_oracode_metadata?: {
          device_id?: number;
          door_id: number;
          door_name: string;
          iana_timezone?: string;
          predefined_time_slots?: {
              check_in_time: string;
              check_out_time: string;
              dormakaba_oracode_user_level_id: string;
              ext_dormakaba_oracode_user_level_prefix: number;
              is_24_hour: boolean;
              is_biweekly_mode: boolean;
              is_master: boolean;
              is_one_shot: boolean;
              name: string;
              prefix: number;
          }[];
          site_id: number;
          site_name: string;
      }
      - Optional device_id?: number
      - door_id: number
      - door_name: string
      - Optional iana_timezone?: string
      - Optional predefined_time_slots?: {
            check_in_time: string;
            check_out_time: string;
            dormakaba_oracode_user_level_id: string;
            ext_dormakaba_oracode_user_level_prefix: number;
            is_24_hour: boolean;
            is_biweekly_mode: boolean;
            is_master: boolean;
            is_one_shot: boolean;
            name: string;
            prefix: number;
        }[]
      - site_id: number
      - site_name: string
    - Optional ecobee_metadata?: {
      device_name: string;
      ecobee_device_id: string;
      }
      - device_name: string
      - ecobee_device_id: string
    - Optional fan_mode_setting?: "auto" | "on"
    - Optional four_suites_metadata?: {
          device_id: number;
          device_name: string;
          reclose_delay_in_seconds: number;
      }
      - device_id: number
      - device_name: string
      - reclose_delay_in_seconds: number
    - Optional genie_metadata?: {
      device_name: string;
      door_name: string;
      }
      - device_name: string
      - door_name: string
    - Optional has_direct_power?: boolean
      Indicates whether the device has direct power.
    - Optional has_native_entry_events?: boolean
    - Optional hubitat_metadata?: {
          device_id: string;
          device_label: string;
          device_name: string;
      }
      - device_id: string
      - device_label: string
      - device_name: string
    - Optional igloo_metadata?: {
          bridge_id: string;
          device_id: string;
          model?: string;
      }
      - bridge_id: string
      - device_id: string
      - Optional model?: string
    - Optional igloohome_metadata?: {
          bridge_id?: string;
          bridge_name?: string;
          device_id: string;
          device_name: string;
      }
      - Optional bridge_id?: string
      - Optional bridge_name?: string
      - device_id: string
      - device_name: string
    - Optional image_alt_text?: string
      Alt text for the device image.
    - Optional image_url?: string
      Image URL for the device.
    - Optional is_climate_setting_schedule_active?: boolean
    - Optional is_cooling?: boolean
    - Optional is_cooling_available?: boolean
    - Optional is_fan_running?: boolean
    - Optional is_heating?: boolean
    - Optional is_heating_available?: boolean
    - Optional is_temporary_manual_override_active?: boolean
    - Optional keypad_battery?: {
      level: number;
      }
      - level: number
    - Optional kwikset_metadata?: {
          device_id: string;
          device_name: string;
          model_number: string;
      }
      - device_id: string
      - device_name: string
      - model_number: string
    - Optional locked?: boolean
    - Optional lockly_metadata?: {
          device_id: string;
          device_name: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional manufacturer?: string
      Manufacturer of the device.
    - Optional max_active_codes_supported?: number
    - Optional minut_metadata?: {
          device_id: string;
          device_name: string;
          latest_sensor_values: {
              accelerometer_z: {
                  time: string;
                  value: number;
              };
              humidity: {
                  time: string;
                  value: number;
              };
              pressure: {
                  time: string;
                  value: number;
              };
              sound: {
                  time: string;
                  value: number;
              };
              temperature: {
                  time: string;
                  value: number;
              };
          };
      }
      - device_id: string
      - device_name: string
      - latest_sensor_values: {
            accelerometer_z: {
                time: string;
                value: number;
            };
            humidity: {
                time: string;
                value: number;
            };
            pressure: {
                time: string;
                value: number;
            };
            sound: {
                time: string;
                value: number;
            };
            temperature: {
                time: string;
                value: number;
            };
        }
        accelerometer_z: {
            time: string;
            value: number;
        }
        time: string
        value: number
        humidity: {
            time: string;
            value: number;
        }
        time: string
        value: number
        pressure: {
            time: string;
            value: number;
        }
        time: string
        value: number
        sound: {
            time: string;
            value: number;
        }
        time: string
        value: number
        temperature: {
            time: string;
            value: number;
        }
        time: string
        value: number
    - model: {
          accessory_keypad_supported?: boolean;
          display_name: string;
          manufacturer_display_name: string;
          offline_access_codes_supported?: boolean;
          online_access_codes_supported?: boolean;
      }
      - Optional accessory_keypad_supported?: boolean
        Indicates whether the device supports an accessory keypad.
      - display_name: string
        Display name of the device model.
      - manufacturer_display_name: string
        Display name that corresponds to the manufacturer-specific terminology for the device.
      - Optional offline_access_codes_supported?: boolean
        Indicates whether the device supports offline access codes.
      - Optional online_access_codes_supported?: boolean
        Indicates whether the device supports online access codes.
    - name: string
      Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.
    - Optional nest_metadata?: {
          custom_name: string;
          device_name: string;
          nest_device_id: string;
      }
      - custom_name: string
      - device_name: string
      - nest_device_id: string
    - Optional noiseaware_metadata?: {
          device_id: string;
          device_model: "indoor" | "outdoor";
          device_name: string;
          noise_level_decibel: number;
          noise_level_nrs: number;
      }
      - device_id: string
      - device_model: "indoor" | "outdoor"
      - device_name: string
      - noise_level_decibel: number
      - noise_level_nrs: number
    - Optional nuki_metadata?: {
          device_id: string;
          device_name: string;
          keypad_battery_critical?: boolean;
      }
      - device_id: string
      - device_name: string
      - Optional keypad_battery_critical?: boolean
    - Optional offline_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use offline access codes for the device.
    - online: boolean
      Indicates whether the device is online.
    - Optional online_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use online access codes for the device.
    - Optional relative_humidity?: number
    - Optional salto_metadata?: {
          battery_level: string;
          customer_reference: string;
          lock_id: string;
          lock_type: string;
          locked_state: string;
          model?: string;
      }
      - battery_level: string
      - customer_reference: string
      - lock_id: string
      - lock_type: string
      - locked_state: string
      - Optional model?: string
    - Optional schlage_metadata?: {
          access_code_length: number;
          device_id: string;
          device_name: string;
          model?: string;
      }
      - access_code_length: number
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional seam_bridge_metadata?: {
          device_num: number;
          name: string;
          unlock_method?: "bridge" | "doorking";
      }
      - device_num: number
      - name: string
      - Optional unlock_method?: "bridge" | "doorking"
    - Optional serial_number?: string
      Serial number of the device.
    - Optional smartthings_metadata?: {
          device_id: string;
          device_name: string;
          location_id?: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional location_id?: string
      - Optional model?: string
    - Optional supported_code_lengths?: number[]
    - Optional supports_accessory_keypad?: boolean
      Deprecated. Use model.accessory_keypad_supported.
    - Optional supports_backup_access_code_pool?: boolean
    - Optional supports_offline_access_codes?: boolean
      Deprecated. Use offline_access_codes_enabled.
    - Optional temperature_celsius?: number
    - Optional temperature_fahrenheit?: number
    - Optional ttlock_metadata?: {
      lock_alias: string;
      lock_id: number;
      }
      - lock_alias: string
      - lock_id: number
    - Optional two_n_metadata?: {
      device_id: number;
      device_name: string;
      }
      - device_id: number
      - device_name: string
    - Optional wyze_metadata?: {
          device_id: string;
          device_info_model: string;
          device_name: string;
          product_model: string;
          product_name: string;
          product_type: string;
      }
      - device_id: string
      - device_info_model: string
      - device_name: string
      - product_model: string
      - product_name: string
      - product_type: string
  - warnings: {
    message: string;
    warning_code: string;
    }[]
    Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
  - workspace_id: string
    Unique identifier for the Seam workspace associated with the device.
- lock: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }
  - capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[]
    Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.
  - connected_account_id: string
    Unique identifier for the account associated with the device.
  - created_at: string
    Date and time at which the device object was created.
  - device_id: string
    Unique identifier for the device.
  - 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
    Type of the device.
  - errors: {
    error_code: string;
    message: string;
    }[]
    Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
  - is_managed: true
    Indicates whether Seam manages the device.
  - location: null | {
    location_name?: string;
    timezone?: string;
    }
    Location information for the device.
  - properties: {
        active_climate_setting_schedule?: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        };
        august_metadata?: {
            has_keypad: boolean;
            house_id?: string;
            house_name: string;
            keypad_battery_level?: string;
            lock_id: string;
            lock_name: string;
            model?: string;
        };
        available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
        avigilon_alta_metadata?: {
            entry_name: string;
            org_name: string;
            site_id: number;
            site_name: string;
            zone_id: number;
            zone_name: string;
        };
        battery?: {
            level: number;
            status: "low" | "full" | "critical" | "good";
        };
        battery_level?: number;
        brivo_metadata?: {
            device_name: string;
        };
        can_enable_automatic_cooling?: boolean;
        can_enable_automatic_heating?: boolean;
        code_constraints?: ({
            constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
        } | {
            constraint_type: "name_length";
            max_length?: number;
            min_length?: number;
        })[];
        controlbyweb_metadata?: {
            device_id: string;
            device_name: string;
            relay_name: null | string;
        };
        current_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        default_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        door_open?: boolean;
        dormakaba_oracode_metadata?: {
            device_id?: number;
            door_id: number;
            door_name: string;
            iana_timezone?: string;
            predefined_time_slots?: {
                check_in_time: string;
                check_out_time: string;
                dormakaba_oracode_user_level_id: string;
                ext_dormakaba_oracode_user_level_prefix: number;
                is_24_hour: boolean;
                is_biweekly_mode: boolean;
                is_master: boolean;
                is_one_shot: boolean;
                name: string;
                prefix: number;
            }[];
            site_id: number;
            site_name: string;
        };
        ecobee_metadata?: {
            device_name: string;
            ecobee_device_id: string;
        };
        fan_mode_setting?: "auto" | "on";
        four_suites_metadata?: {
            device_id: number;
            device_name: string;
            reclose_delay_in_seconds: number;
        };
        genie_metadata?: {
            device_name: string;
            door_name: string;
        };
        has_direct_power?: boolean;
        has_native_entry_events?: boolean;
        hubitat_metadata?: {
            device_id: string;
            device_label: string;
            device_name: string;
        };
        igloo_metadata?: {
            bridge_id: string;
            device_id: string;
            model?: string;
        };
        igloohome_metadata?: {
            bridge_id?: string;
            bridge_name?: string;
            device_id: string;
            device_name: string;
        };
        image_alt_text?: string;
        image_url?: string;
        is_climate_setting_schedule_active?: boolean;
        is_cooling?: boolean;
        is_cooling_available?: boolean;
        is_fan_running?: boolean;
        is_heating?: boolean;
        is_heating_available?: boolean;
        is_temporary_manual_override_active?: boolean;
        keypad_battery?: {
            level: number;
        };
        kwikset_metadata?: {
            device_id: string;
            device_name: string;
            model_number: string;
        };
        locked?: boolean;
        lockly_metadata?: {
            device_id: string;
            device_name: string;
            model?: string;
        };
        manufacturer?: string;
        max_active_codes_supported?: number;
        minut_metadata?: {
            device_id: string;
            device_name: string;
            latest_sensor_values: {
                accelerometer_z: {
                    time: string;
                    value: number;
                };
                humidity: {
                    time: string;
                    value: number;
                };
                pressure: {
                    time: string;
                    value: number;
                };
                sound: {
                    time: string;
                    value: number;
                };
                temperature: {
                    time: string;
                    value: number;
                };
            };
        };
        model: {
            accessory_keypad_supported?: boolean;
            display_name: string;
            manufacturer_display_name: string;
            offline_access_codes_supported?: boolean;
            online_access_codes_supported?: boolean;
        };
        name: string;
        nest_metadata?: {
            custom_name: string;
            device_name: string;
            nest_device_id: string;
        };
        noiseaware_metadata?: {
            device_id: string;
            device_model: "indoor" | "outdoor";
            device_name: string;
            noise_level_decibel: number;
            noise_level_nrs: number;
        };
        nuki_metadata?: {
            device_id: string;
            device_name: string;
            keypad_battery_critical?: boolean;
        };
        offline_access_codes_enabled?: boolean;
        online: boolean;
        online_access_codes_enabled?: boolean;
        relative_humidity?: number;
        salto_metadata?: {
            battery_level: string;
            customer_reference: string;
            lock_id: string;
            lock_type: string;
            locked_state: string;
            model?: string;
        };
        schlage_metadata?: {
            access_code_length: number;
            device_id: string;
            device_name: string;
            model?: string;
        };
        seam_bridge_metadata?: {
            device_num: number;
            name: string;
            unlock_method?: "bridge" | "doorking";
        };
        serial_number?: string;
        smartthings_metadata?: {
            device_id: string;
            device_name: string;
            location_id?: string;
            model?: string;
        };
        supported_code_lengths?: number[];
        supports_accessory_keypad?: boolean;
        supports_backup_access_code_pool?: boolean;
        supports_offline_access_codes?: boolean;
        temperature_celsius?: number;
        temperature_fahrenheit?: number;
        ttlock_metadata?: {
            lock_alias: string;
            lock_id: number;
        };
        two_n_metadata?: {
            device_id: number;
            device_name: string;
        };
        wyze_metadata?: {
            device_id: string;
            device_info_model: string;
            device_name: string;
            product_model: string;
            product_name: string;
            product_type: string;
        };
    }
    Properties of the device.
    - Optional active_climate_setting_schedule?: {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      }
    - Optional august_metadata?: {
          has_keypad: boolean;
          house_id?: string;
          house_name: string;
          keypad_battery_level?: string;
          lock_id: string;
          lock_name: string;
          model?: string;
      }
      - has_keypad: boolean
      - Optional house_id?: string
      - house_name: string
      - Optional keypad_battery_level?: string
      - lock_id: string
      - lock_name: string
      - Optional model?: string
    - Optional available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[]
    - Optional avigilon_alta_metadata?: {
          entry_name: string;
          org_name: string;
          site_id: number;
          site_name: string;
          zone_id: number;
          zone_name: string;
      }
      - entry_name: string
      - org_name: string
      - site_id: number
      - site_name: string
      - zone_id: number
      - zone_name: string
    - Optional battery?: {
      level: number;
      status: "low" | "full" | "critical" | "good";
      }
      Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.
      - level: number
      - status: "low" | "full" | "critical" | "good"
    - Optional battery_level?: number
      Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
    - Optional brivo_metadata?: {
      device_name: string;
      }
      - device_name: string
    - Optional can_enable_automatic_cooling?: boolean
    - Optional can_enable_automatic_heating?: boolean
    - Optional code_constraints?: ({
          constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
      } | {
          constraint_type: "name_length";
          max_length?: number;
          min_length?: number;
      })[]
    - Optional controlbyweb_metadata?: {
          device_id: string;
          device_name: string;
          relay_name: null | string;
      }
      - device_id: string
      - device_name: string
      - relay_name: null | string
    - Optional current_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional default_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional door_open?: boolean
    - Optional dormakaba_oracode_metadata?: {
          device_id?: number;
          door_id: number;
          door_name: string;
          iana_timezone?: string;
          predefined_time_slots?: {
              check_in_time: string;
              check_out_time: string;
              dormakaba_oracode_user_level_id: string;
              ext_dormakaba_oracode_user_level_prefix: number;
              is_24_hour: boolean;
              is_biweekly_mode: boolean;
              is_master: boolean;
              is_one_shot: boolean;
              name: string;
              prefix: number;
          }[];
          site_id: number;
          site_name: string;
      }
      - Optional device_id?: number
      - door_id: number
      - door_name: string
      - Optional iana_timezone?: string
      - Optional predefined_time_slots?: {
            check_in_time: string;
            check_out_time: string;
            dormakaba_oracode_user_level_id: string;
            ext_dormakaba_oracode_user_level_prefix: number;
            is_24_hour: boolean;
            is_biweekly_mode: boolean;
            is_master: boolean;
            is_one_shot: boolean;
            name: string;
            prefix: number;
        }[]
      - site_id: number
      - site_name: string
    - Optional ecobee_metadata?: {
      device_name: string;
      ecobee_device_id: string;
      }
      - device_name: string
      - ecobee_device_id: string
    - Optional fan_mode_setting?: "auto" | "on"
    - Optional four_suites_metadata?: {
          device_id: number;
          device_name: string;
          reclose_delay_in_seconds: number;
      }
      - device_id: number
      - device_name: string
      - reclose_delay_in_seconds: number
    - Optional genie_metadata?: {
      device_name: string;
      door_name: string;
      }
      - device_name: string
      - door_name: string
    - Optional has_direct_power?: boolean
      Indicates whether the device has direct power.
    - Optional has_native_entry_events?: boolean
    - Optional hubitat_metadata?: {
          device_id: string;
          device_label: string;
          device_name: string;
      }
      - device_id: string
      - device_label: string
      - device_name: string
    - Optional igloo_metadata?: {
          bridge_id: string;
          device_id: string;
          model?: string;
      }
      - bridge_id: string
      - device_id: string
      - Optional model?: string
    - Optional igloohome_metadata?: {
          bridge_id?: string;
          bridge_name?: string;
          device_id: string;
          device_name: string;
      }
      - Optional bridge_id?: string
      - Optional bridge_name?: string
      - device_id: string
      - device_name: string
    - Optional image_alt_text?: string
      Alt text for the device image.
    - Optional image_url?: string
      Image URL for the device.
    - Optional is_climate_setting_schedule_active?: boolean
    - Optional is_cooling?: boolean
    - Optional is_cooling_available?: boolean
    - Optional is_fan_running?: boolean
    - Optional is_heating?: boolean
    - Optional is_heating_available?: boolean
    - Optional is_temporary_manual_override_active?: boolean
    - Optional keypad_battery?: {
      level: number;
      }
      - level: number
    - Optional kwikset_metadata?: {
          device_id: string;
          device_name: string;
          model_number: string;
      }
      - device_id: string
      - device_name: string
      - model_number: string
    - Optional locked?: boolean
    - Optional lockly_metadata?: {
          device_id: string;
          device_name: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional manufacturer?: string
      Manufacturer of the device.
    - Optional max_active_codes_supported?: number
    - Optional minut_metadata?: {
          device_id: string;
          device_name: string;
          latest_sensor_values: {
              accelerometer_z: {
                  time: string;
                  value: number;
              };
              humidity: {
                  time: string;
                  value: number;
              };
              pressure: {
                  time: string;
                  value: number;
              };
              sound: {
                  time: string;
                  value: number;
              };
              temperature: {
                  time: string;
                  value: number;
              };
          };
      }
      - device_id: string
      - device_name: string
      - latest_sensor_values: {
            accelerometer_z: {
                time: string;
                value: number;
            };
            humidity: {
                time: string;
                value: number;
            };
            pressure: {
                time: string;
                value: number;
            };
            sound: {
                time: string;
                value: number;
            };
            temperature: {
                time: string;
                value: number;
            };
        }
        accelerometer_z: {
            time: string;
            value: number;
        }
        time: string
        value: number
        humidity: {
            time: string;
            value: number;
        }
        time: string
        value: number
        pressure: {
            time: string;
            value: number;
        }
        time: string
        value: number
        sound: {
            time: string;
            value: number;
        }
        time: string
        value: number
        temperature: {
            time: string;
            value: number;
        }
        time: string
        value: number
    - model: {
          accessory_keypad_supported?: boolean;
          display_name: string;
          manufacturer_display_name: string;
          offline_access_codes_supported?: boolean;
          online_access_codes_supported?: boolean;
      }
      - Optional accessory_keypad_supported?: boolean
        Indicates whether the device supports an accessory keypad.
      - display_name: string
        Display name of the device model.
      - manufacturer_display_name: string
        Display name that corresponds to the manufacturer-specific terminology for the device.
      - Optional offline_access_codes_supported?: boolean
        Indicates whether the device supports offline access codes.
      - Optional online_access_codes_supported?: boolean
        Indicates whether the device supports online access codes.
    - name: string
      Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.
    - Optional nest_metadata?: {
          custom_name: string;
          device_name: string;
          nest_device_id: string;
      }
      - custom_name: string
      - device_name: string
      - nest_device_id: string
    - Optional noiseaware_metadata?: {
          device_id: string;
          device_model: "indoor" | "outdoor";
          device_name: string;
          noise_level_decibel: number;
          noise_level_nrs: number;
      }
      - device_id: string
      - device_model: "indoor" | "outdoor"
      - device_name: string
      - noise_level_decibel: number
      - noise_level_nrs: number
    - Optional nuki_metadata?: {
          device_id: string;
          device_name: string;
          keypad_battery_critical?: boolean;
      }
      - device_id: string
      - device_name: string
      - Optional keypad_battery_critical?: boolean
    - Optional offline_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use offline access codes for the device.
    - online: boolean
      Indicates whether the device is online.
    - Optional online_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use online access codes for the device.
    - Optional relative_humidity?: number
    - Optional salto_metadata?: {
          battery_level: string;
          customer_reference: string;
          lock_id: string;
          lock_type: string;
          locked_state: string;
          model?: string;
      }
      - battery_level: string
      - customer_reference: string
      - lock_id: string
      - lock_type: string
      - locked_state: string
      - Optional model?: string
    - Optional schlage_metadata?: {
          access_code_length: number;
          device_id: string;
          device_name: string;
          model?: string;
      }
      - access_code_length: number
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional seam_bridge_metadata?: {
          device_num: number;
          name: string;
          unlock_method?: "bridge" | "doorking";
      }
      - device_num: number
      - name: string
      - Optional unlock_method?: "bridge" | "doorking"
    - Optional serial_number?: string
      Serial number of the device.
    - Optional smartthings_metadata?: {
          device_id: string;
          device_name: string;
          location_id?: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional location_id?: string
      - Optional model?: string
    - Optional supported_code_lengths?: number[]
    - Optional supports_accessory_keypad?: boolean
      Deprecated. Use model.accessory_keypad_supported.
    - Optional supports_backup_access_code_pool?: boolean
    - Optional supports_offline_access_codes?: boolean
      Deprecated. Use offline_access_codes_enabled.
    - Optional temperature_celsius?: number
    - Optional temperature_fahrenheit?: number
    - Optional ttlock_metadata?: {
      lock_alias: string;
      lock_id: number;
      }
      - lock_alias: string
      - lock_id: number
    - Optional two_n_metadata?: {
      device_id: number;
      device_name: string;
      }
      - device_id: number
      - device_name: string
    - Optional wyze_metadata?: {
          device_id: string;
          device_info_model: string;
          device_name: string;
          product_model: string;
          product_name: string;
          product_type: string;
      }
      - device_id: string
      - device_info_model: string
      - device_name: string
      - product_model: string
      - product_name: string
      - product_type: string
  - warnings: {
    message: string;
    warning_code: string;
    }[]
    Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
  - workspace_id: string
    Unique identifier for the Seam workspace associated with the device.
method: "POST" | "GET"
queryParams: {}
route: "/locks/get"

/locks/list

/locks/list: {
    commonParams: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
        limit?: number;
        manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        devices: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        }[];
        locks: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/locks/list";
}

Type declaration

commonParams: {
    connect_webview_id?: string;
    connected_account_id?: string;
    connected_account_ids?: string[];
    created_before?: Date;
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
    limit?: number;
    manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
    user_identifier_key?: string;
}
- Optional connect_webview_id?: string
- Optional connected_account_id?: string
  List all devices owned by this connected account
- Optional connected_account_ids?: string[]
- Optional created_before?: Date
- Optional device_ids?: string[]
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[]
- Optional limit?: number
- Optional manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    devices: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    }[];
    locks: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    }[];
}
- devices: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]
- locks: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]
method: "POST" | "GET"
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: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST";
    queryParams: {};
    route: "/locks/lock_door";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
device_id: string;
sync?: boolean;
}
- device_id: string
- Optional sync?: boolean
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST"
queryParams: {}
route: "/locks/lock_door"

/locks/unlock_door

/locks/unlock_door: {
    commonParams: {};
    formData: {};
    jsonBody: {
        device_id: string;
        sync?: boolean;
    };
    jsonResponse: {
        action_attempt: {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST";
    queryParams: {};
    route: "/locks/unlock_door";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
device_id: string;
sync?: boolean;
}
- device_id: string
- Optional sync?: boolean
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST"
queryParams: {}
route: "/locks/unlock_door"

/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: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            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;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/noise_sensors/noise_thresholds/create";
}

Type declaration

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;
}
- device_id: string
- ends_daily_at: string
- Optional name?: string
- Optional noise_threshold_decibels?: number
- Optional noise_threshold_nrs?: number
- starts_daily_at: string
- Optional sync?: boolean
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        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;
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      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;
  }
  - device_id: string
  - ends_daily_at: string
  - name: string
  - noise_threshold_decibels: number
  - noise_threshold_id: string
  - Optional noise_threshold_nrs?: number
  - starts_daily_at: string
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: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/noise_sensors/noise_thresholds/delete";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    device_id: string;
    noise_threshold_id: string;
    sync?: boolean;
}
- device_id: string
- noise_threshold_id: string
- Optional sync?: boolean
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST" | "DELETE"
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;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/noise_sensors/noise_thresholds/get";
}

Type declaration

commonParams: {
noise_threshold_id: string;
}
- 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;
    };
}
- 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;
  }
  - device_id: string
  - ends_daily_at: string
  - name: string
  - noise_threshold_decibels: number
  - noise_threshold_id: string
  - Optional noise_threshold_nrs?: number
  - starts_daily_at: string
method: "POST" | "GET"
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;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/noise_sensors/noise_thresholds/list";
}

Type declaration

commonParams: {
device_id: string;
is_programmed?: boolean;
}
- device_id: string
- Optional 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;
    }[];
}
- 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;
  }[]
method: "POST" | "GET"
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: string;
            error: null;
            result?: any;
            status: "success";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: null;
            result: null;
            status: "pending";
        } | {
            action_attempt_id: string;
            action_type: string;
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        };
    };
    method: "POST" | "PUT" | "PATCH";
    queryParams: {};
    route: "/noise_sensors/noise_thresholds/update";
}

Type declaration

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;
}
- device_id: string
- Optional ends_daily_at?: string
- Optional name?: string
- Optional noise_threshold_decibels?: number
- noise_threshold_id: string
- Optional noise_threshold_nrs?: number
- Optional starts_daily_at?: string
- Optional sync?: boolean
jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}
- action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }
method: "POST" | "PUT" | "PATCH"
queryParams: {}
route: "/noise_sensors/noise_thresholds/update"

/noise_sensors/simulate/trigger_noise_threshold

/noise_sensors/simulate/trigger_noise_threshold: {
    commonParams: {};
    formData: {};
    jsonBody: {
        device_id: string;
    };
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/noise_sensors/simulate/trigger_noise_threshold";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
device_id: string;
}
- device_id: string
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/noise_sensors/simulate/trigger_noise_threshold"

/thermostats/climate_setting_schedules/create

/thermostats/climate_setting_schedules/create: {
    commonParams: {};
    formData: {};
    jsonBody: {
        automatic_cooling_enabled?: boolean;
        automatic_heating_enabled?: boolean;
        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?: "off" | "heat" | "cool" | "heat_cool";
        manual_override_allowed?: boolean;
        name?: string;
        schedule_ends_at: string;
        schedule_starts_at: string;
        schedule_type?: "time_bound";
    };
    jsonResponse: {
        climate_setting_schedule: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        };
    };
    method: "POST";
    queryParams: {};
    route: "/thermostats/climate_setting_schedules/create";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    automatic_cooling_enabled?: boolean;
    automatic_heating_enabled?: boolean;
    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?: "off" | "heat" | "cool" | "heat_cool";
    manual_override_allowed?: boolean;
    name?: string;
    schedule_ends_at: string;
    schedule_starts_at: string;
    schedule_type?: "time_bound";
}
- Optional automatic_cooling_enabled?: boolean
- Optional automatic_heating_enabled?: boolean
- Optional cooling_set_point_celsius?: number
- Optional cooling_set_point_fahrenheit?: number
- device_id: string
- Optional heating_set_point_celsius?: number
- Optional heating_set_point_fahrenheit?: number
- Optional hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool"
- Optional manual_override_allowed?: boolean
- Optional name?: string
- schedule_ends_at: string
- schedule_starts_at: string
- Optional schedule_type?: "time_bound"
jsonResponse: {
    climate_setting_schedule: {
        automatic_cooling_enabled?: boolean;
        automatic_heating_enabled?: boolean;
        climate_setting_schedule_id: string;
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        created_at: string;
        device_id: string;
        errors?: any;
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
        manual_override_allowed?: boolean;
        name?: string;
        schedule_ends_at: string;
        schedule_starts_at: string;
        schedule_type: "time_bound";
    };
}
- climate_setting_schedule: {
      automatic_cooling_enabled?: boolean;
      automatic_heating_enabled?: boolean;
      climate_setting_schedule_id: string;
      cooling_set_point_celsius?: number;
      cooling_set_point_fahrenheit?: number;
      created_at: string;
      device_id: string;
      errors?: any;
      heating_set_point_celsius?: number;
      heating_set_point_fahrenheit?: number;
      hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
      manual_override_allowed?: boolean;
      name?: string;
      schedule_ends_at: string;
      schedule_starts_at: string;
      schedule_type: "time_bound";
  }
  - Optional automatic_cooling_enabled?: boolean
  - Optional automatic_heating_enabled?: boolean
  - climate_setting_schedule_id: string
  - Optional cooling_set_point_celsius?: number
  - Optional cooling_set_point_fahrenheit?: number
  - created_at: string
  - device_id: string
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - Optional heating_set_point_celsius?: number
  - Optional heating_set_point_fahrenheit?: number
  - Optional hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool"
  - Optional manual_override_allowed?: boolean
  - Optional name?: string
  - schedule_ends_at: string
  - schedule_starts_at: string
  - schedule_type: "time_bound"
method: "POST"
queryParams: {}
route: "/thermostats/climate_setting_schedules/create"

/thermostats/climate_setting_schedules/delete

/thermostats/climate_setting_schedules/delete: {
    commonParams: {
        climate_setting_schedule_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "PUT" | "DELETE";
    queryParams: {};
    route: "/thermostats/climate_setting_schedules/delete";
}

Type declaration

commonParams: {
climate_setting_schedule_id: string;
}
- climate_setting_schedule_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "PUT" | "DELETE"
queryParams: {}
route: "/thermostats/climate_setting_schedules/delete"

/thermostats/climate_setting_schedules/get

/thermostats/climate_setting_schedules/get: {
    commonParams: {
        climate_setting_schedule_id?: string;
        device_id?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        climate_setting_schedule: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/thermostats/climate_setting_schedules/get";
}

Type declaration

commonParams: {
climate_setting_schedule_id?: string;
device_id?: string;
}
- Optional climate_setting_schedule_id?: string
- Optional device_id?: string
formData: {}
jsonBody: {}
jsonResponse: {
    climate_setting_schedule: {
        automatic_cooling_enabled?: boolean;
        automatic_heating_enabled?: boolean;
        climate_setting_schedule_id: string;
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        created_at: string;
        device_id: string;
        errors?: any;
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
        manual_override_allowed?: boolean;
        name?: string;
        schedule_ends_at: string;
        schedule_starts_at: string;
        schedule_type: "time_bound";
    };
}
- climate_setting_schedule: {
      automatic_cooling_enabled?: boolean;
      automatic_heating_enabled?: boolean;
      climate_setting_schedule_id: string;
      cooling_set_point_celsius?: number;
      cooling_set_point_fahrenheit?: number;
      created_at: string;
      device_id: string;
      errors?: any;
      heating_set_point_celsius?: number;
      heating_set_point_fahrenheit?: number;
      hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
      manual_override_allowed?: boolean;
      name?: string;
      schedule_ends_at: string;
      schedule_starts_at: string;
      schedule_type: "time_bound";
  }
  - Optional automatic_cooling_enabled?: boolean
  - Optional automatic_heating_enabled?: boolean
  - climate_setting_schedule_id: string
  - Optional cooling_set_point_celsius?: number
  - Optional cooling_set_point_fahrenheit?: number
  - created_at: string
  - device_id: string
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - Optional heating_set_point_celsius?: number
  - Optional heating_set_point_fahrenheit?: number
  - Optional hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool"
  - Optional manual_override_allowed?: boolean
  - Optional name?: string
  - schedule_ends_at: string
  - schedule_starts_at: string
  - schedule_type: "time_bound"
method: "POST" | "GET"
queryParams: {}
route: "/thermostats/climate_setting_schedules/get"

/thermostats/climate_setting_schedules/list

/thermostats/climate_setting_schedules/list: {
    commonParams: {
        device_id: string;
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        climate_setting_schedules: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/thermostats/climate_setting_schedules/list";
}

Type declaration

commonParams: {
device_id: string;
user_identifier_key?: string;
}
- device_id: string
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    climate_setting_schedules: {
        automatic_cooling_enabled?: boolean;
        automatic_heating_enabled?: boolean;
        climate_setting_schedule_id: string;
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        created_at: string;
        device_id: string;
        errors?: any;
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
        manual_override_allowed?: boolean;
        name?: string;
        schedule_ends_at: string;
        schedule_starts_at: string;
        schedule_type: "time_bound";
    }[];
}
- climate_setting_schedules: {
      automatic_cooling_enabled?: boolean;
      automatic_heating_enabled?: boolean;
      climate_setting_schedule_id: string;
      cooling_set_point_celsius?: number;
      cooling_set_point_fahrenheit?: number;
      created_at: string;
      device_id: string;
      errors?: any;
      heating_set_point_celsius?: number;
      heating_set_point_fahrenheit?: number;
      hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
      manual_override_allowed?: boolean;
      name?: string;
      schedule_ends_at: string;
      schedule_starts_at: string;
      schedule_type: "time_bound";
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/thermostats/climate_setting_schedules/list"

/thermostats/climate_setting_schedules/update

/thermostats/climate_setting_schedules/update: {
    commonParams: {};
    formData: {};
    jsonBody: {
        automatic_cooling_enabled?: boolean;
        automatic_heating_enabled?: boolean;
        climate_setting_schedule_id: string;
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
        manual_override_allowed?: boolean;
        name?: string;
        schedule_ends_at?: string;
        schedule_starts_at?: string;
        schedule_type?: "time_bound";
    };
    jsonResponse: {
        climate_setting_schedule: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        };
    };
    method: "POST" | "PUT" | "PATCH";
    queryParams: {};
    route: "/thermostats/climate_setting_schedules/update";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    automatic_cooling_enabled?: boolean;
    automatic_heating_enabled?: boolean;
    climate_setting_schedule_id: string;
    cooling_set_point_celsius?: number;
    cooling_set_point_fahrenheit?: number;
    heating_set_point_celsius?: number;
    heating_set_point_fahrenheit?: number;
    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
    manual_override_allowed?: boolean;
    name?: string;
    schedule_ends_at?: string;
    schedule_starts_at?: string;
    schedule_type?: "time_bound";
}
- Optional automatic_cooling_enabled?: boolean
- Optional automatic_heating_enabled?: boolean
- climate_setting_schedule_id: string
- Optional cooling_set_point_celsius?: number
- Optional cooling_set_point_fahrenheit?: number
- Optional heating_set_point_celsius?: number
- Optional heating_set_point_fahrenheit?: number
- Optional hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool"
- Optional manual_override_allowed?: boolean
- Optional name?: string
- Optional schedule_ends_at?: string
- Optional schedule_starts_at?: string
- Optional schedule_type?: "time_bound"
jsonResponse: {
    climate_setting_schedule: {
        automatic_cooling_enabled?: boolean;
        automatic_heating_enabled?: boolean;
        climate_setting_schedule_id: string;
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        created_at: string;
        device_id: string;
        errors?: any;
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
        manual_override_allowed?: boolean;
        name?: string;
        schedule_ends_at: string;
        schedule_starts_at: string;
        schedule_type: "time_bound";
    };
}
- climate_setting_schedule: {
      automatic_cooling_enabled?: boolean;
      automatic_heating_enabled?: boolean;
      climate_setting_schedule_id: string;
      cooling_set_point_celsius?: number;
      cooling_set_point_fahrenheit?: number;
      created_at: string;
      device_id: string;
      errors?: any;
      heating_set_point_celsius?: number;
      heating_set_point_fahrenheit?: number;
      hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
      manual_override_allowed?: boolean;
      name?: string;
      schedule_ends_at: string;
      schedule_starts_at: string;
      schedule_type: "time_bound";
  }
  - Optional automatic_cooling_enabled?: boolean
  - Optional automatic_heating_enabled?: boolean
  - climate_setting_schedule_id: string
  - Optional cooling_set_point_celsius?: number
  - Optional cooling_set_point_fahrenheit?: number
  - created_at: string
  - device_id: string
  - Optional errors?: any
    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.
  - Optional heating_set_point_celsius?: number
  - Optional heating_set_point_fahrenheit?: number
  - Optional hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool"
  - Optional manual_override_allowed?: boolean
  - Optional name?: string
  - schedule_ends_at: string
  - schedule_starts_at: string
  - schedule_type: "time_bound"
method: "POST" | "PUT" | "PATCH"
queryParams: {}
route: "/thermostats/climate_setting_schedules/update"

/thermostats/cool

/thermostats/cool: {
    commonParams: {};
    formData: {};
    jsonBody: {
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        device_id: string;
        sync?: boolean;
    };
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/thermostats/cool";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    cooling_set_point_celsius?: number;
    cooling_set_point_fahrenheit?: number;
    device_id: string;
    sync?: boolean;
}
- Optional cooling_set_point_celsius?: number
- Optional cooling_set_point_fahrenheit?: number
- device_id: string
- Optional sync?: boolean
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/thermostats/cool"

/thermostats/get

/thermostats/get: {
    commonParams: {
        device_id?: string;
        name?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        thermostat: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/thermostats/get";
}

Type declaration

commonParams: {
device_id?: string;
name?: string;
}
- Optional device_id?: string
- Optional name?: string
formData: {}
jsonBody: {}
jsonResponse: {
    thermostat: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    };
}
- thermostat: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }
  - capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[]
    Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.
  - connected_account_id: string
    Unique identifier for the account associated with the device.
  - created_at: string
    Date and time at which the device object was created.
  - device_id: string
    Unique identifier for the device.
  - 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
    Type of the device.
  - errors: {
    error_code: string;
    message: string;
    }[]
    Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
  - is_managed: true
    Indicates whether Seam manages the device.
  - location: null | {
    location_name?: string;
    timezone?: string;
    }
    Location information for the device.
  - properties: {
        active_climate_setting_schedule?: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        } | {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            climate_setting_schedule_id: string;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            created_at: string;
            device_id: string;
            errors?: any;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
            name?: string;
            schedule_ends_at: string;
            schedule_starts_at: string;
            schedule_type: "time_bound";
        };
        august_metadata?: {
            has_keypad: boolean;
            house_id?: string;
            house_name: string;
            keypad_battery_level?: string;
            lock_id: string;
            lock_name: string;
            model?: string;
        };
        available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
        avigilon_alta_metadata?: {
            entry_name: string;
            org_name: string;
            site_id: number;
            site_name: string;
            zone_id: number;
            zone_name: string;
        };
        battery?: {
            level: number;
            status: "low" | "full" | "critical" | "good";
        };
        battery_level?: number;
        brivo_metadata?: {
            device_name: string;
        };
        can_enable_automatic_cooling?: boolean;
        can_enable_automatic_heating?: boolean;
        code_constraints?: ({
            constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
        } | {
            constraint_type: "name_length";
            max_length?: number;
            min_length?: number;
        })[];
        controlbyweb_metadata?: {
            device_id: string;
            device_name: string;
            relay_name: null | string;
        };
        current_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        default_climate_setting?: {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        } | {
            automatic_cooling_enabled: boolean;
            automatic_heating_enabled: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed: boolean;
        };
        door_open?: boolean;
        dormakaba_oracode_metadata?: {
            device_id?: number;
            door_id: number;
            door_name: string;
            iana_timezone?: string;
            predefined_time_slots?: {
                check_in_time: string;
                check_out_time: string;
                dormakaba_oracode_user_level_id: string;
                ext_dormakaba_oracode_user_level_prefix: number;
                is_24_hour: boolean;
                is_biweekly_mode: boolean;
                is_master: boolean;
                is_one_shot: boolean;
                name: string;
                prefix: number;
            }[];
            site_id: number;
            site_name: string;
        };
        ecobee_metadata?: {
            device_name: string;
            ecobee_device_id: string;
        };
        fan_mode_setting?: "auto" | "on";
        four_suites_metadata?: {
            device_id: number;
            device_name: string;
            reclose_delay_in_seconds: number;
        };
        genie_metadata?: {
            device_name: string;
            door_name: string;
        };
        has_direct_power?: boolean;
        has_native_entry_events?: boolean;
        hubitat_metadata?: {
            device_id: string;
            device_label: string;
            device_name: string;
        };
        igloo_metadata?: {
            bridge_id: string;
            device_id: string;
            model?: string;
        };
        igloohome_metadata?: {
            bridge_id?: string;
            bridge_name?: string;
            device_id: string;
            device_name: string;
        };
        image_alt_text?: string;
        image_url?: string;
        is_climate_setting_schedule_active?: boolean;
        is_cooling?: boolean;
        is_cooling_available?: boolean;
        is_fan_running?: boolean;
        is_heating?: boolean;
        is_heating_available?: boolean;
        is_temporary_manual_override_active?: boolean;
        keypad_battery?: {
            level: number;
        };
        kwikset_metadata?: {
            device_id: string;
            device_name: string;
            model_number: string;
        };
        locked?: boolean;
        lockly_metadata?: {
            device_id: string;
            device_name: string;
            model?: string;
        };
        manufacturer?: string;
        max_active_codes_supported?: number;
        minut_metadata?: {
            device_id: string;
            device_name: string;
            latest_sensor_values: {
                accelerometer_z: {
                    time: string;
                    value: number;
                };
                humidity: {
                    time: string;
                    value: number;
                };
                pressure: {
                    time: string;
                    value: number;
                };
                sound: {
                    time: string;
                    value: number;
                };
                temperature: {
                    time: string;
                    value: number;
                };
            };
        };
        model: {
            accessory_keypad_supported?: boolean;
            display_name: string;
            manufacturer_display_name: string;
            offline_access_codes_supported?: boolean;
            online_access_codes_supported?: boolean;
        };
        name: string;
        nest_metadata?: {
            custom_name: string;
            device_name: string;
            nest_device_id: string;
        };
        noiseaware_metadata?: {
            device_id: string;
            device_model: "indoor" | "outdoor";
            device_name: string;
            noise_level_decibel: number;
            noise_level_nrs: number;
        };
        nuki_metadata?: {
            device_id: string;
            device_name: string;
            keypad_battery_critical?: boolean;
        };
        offline_access_codes_enabled?: boolean;
        online: boolean;
        online_access_codes_enabled?: boolean;
        relative_humidity?: number;
        salto_metadata?: {
            battery_level: string;
            customer_reference: string;
            lock_id: string;
            lock_type: string;
            locked_state: string;
            model?: string;
        };
        schlage_metadata?: {
            access_code_length: number;
            device_id: string;
            device_name: string;
            model?: string;
        };
        seam_bridge_metadata?: {
            device_num: number;
            name: string;
            unlock_method?: "bridge" | "doorking";
        };
        serial_number?: string;
        smartthings_metadata?: {
            device_id: string;
            device_name: string;
            location_id?: string;
            model?: string;
        };
        supported_code_lengths?: number[];
        supports_accessory_keypad?: boolean;
        supports_backup_access_code_pool?: boolean;
        supports_offline_access_codes?: boolean;
        temperature_celsius?: number;
        temperature_fahrenheit?: number;
        ttlock_metadata?: {
            lock_alias: string;
            lock_id: number;
        };
        two_n_metadata?: {
            device_id: number;
            device_name: string;
        };
        wyze_metadata?: {
            device_id: string;
            device_info_model: string;
            device_name: string;
            product_model: string;
            product_name: string;
            product_type: string;
        };
    }
    Properties of the device.
    - Optional active_climate_setting_schedule?: {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      } | {
          automatic_cooling_enabled?: boolean;
          automatic_heating_enabled?: boolean;
          climate_setting_schedule_id: string;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          created_at: string;
          device_id: string;
          errors?: any;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed?: boolean;
          name?: string;
          schedule_ends_at: string;
          schedule_starts_at: string;
          schedule_type: "time_bound";
      }
    - Optional august_metadata?: {
          has_keypad: boolean;
          house_id?: string;
          house_name: string;
          keypad_battery_level?: string;
          lock_id: string;
          lock_name: string;
          model?: string;
      }
      - has_keypad: boolean
      - Optional house_id?: string
      - house_name: string
      - Optional keypad_battery_level?: string
      - lock_id: string
      - lock_name: string
      - Optional model?: string
    - Optional available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[]
    - Optional avigilon_alta_metadata?: {
          entry_name: string;
          org_name: string;
          site_id: number;
          site_name: string;
          zone_id: number;
          zone_name: string;
      }
      - entry_name: string
      - org_name: string
      - site_id: number
      - site_name: string
      - zone_id: number
      - zone_name: string
    - Optional battery?: {
      level: number;
      status: "low" | "full" | "critical" | "good";
      }
      Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.
      - level: number
      - status: "low" | "full" | "critical" | "good"
    - Optional battery_level?: number
      Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
    - Optional brivo_metadata?: {
      device_name: string;
      }
      - device_name: string
    - Optional can_enable_automatic_cooling?: boolean
    - Optional can_enable_automatic_heating?: boolean
    - Optional code_constraints?: ({
          constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
      } | {
          constraint_type: "name_length";
          max_length?: number;
          min_length?: number;
      })[]
    - Optional controlbyweb_metadata?: {
          device_id: string;
          device_name: string;
          relay_name: null | string;
      }
      - device_id: string
      - device_name: string
      - relay_name: null | string
    - Optional current_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional default_climate_setting?: {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      } | {
          automatic_cooling_enabled: boolean;
          automatic_heating_enabled: boolean;
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
          manual_override_allowed: boolean;
      }
    - Optional door_open?: boolean
    - Optional dormakaba_oracode_metadata?: {
          device_id?: number;
          door_id: number;
          door_name: string;
          iana_timezone?: string;
          predefined_time_slots?: {
              check_in_time: string;
              check_out_time: string;
              dormakaba_oracode_user_level_id: string;
              ext_dormakaba_oracode_user_level_prefix: number;
              is_24_hour: boolean;
              is_biweekly_mode: boolean;
              is_master: boolean;
              is_one_shot: boolean;
              name: string;
              prefix: number;
          }[];
          site_id: number;
          site_name: string;
      }
      - Optional device_id?: number
      - door_id: number
      - door_name: string
      - Optional iana_timezone?: string
      - Optional predefined_time_slots?: {
            check_in_time: string;
            check_out_time: string;
            dormakaba_oracode_user_level_id: string;
            ext_dormakaba_oracode_user_level_prefix: number;
            is_24_hour: boolean;
            is_biweekly_mode: boolean;
            is_master: boolean;
            is_one_shot: boolean;
            name: string;
            prefix: number;
        }[]
      - site_id: number
      - site_name: string
    - Optional ecobee_metadata?: {
      device_name: string;
      ecobee_device_id: string;
      }
      - device_name: string
      - ecobee_device_id: string
    - Optional fan_mode_setting?: "auto" | "on"
    - Optional four_suites_metadata?: {
          device_id: number;
          device_name: string;
          reclose_delay_in_seconds: number;
      }
      - device_id: number
      - device_name: string
      - reclose_delay_in_seconds: number
    - Optional genie_metadata?: {
      device_name: string;
      door_name: string;
      }
      - device_name: string
      - door_name: string
    - Optional has_direct_power?: boolean
      Indicates whether the device has direct power.
    - Optional has_native_entry_events?: boolean
    - Optional hubitat_metadata?: {
          device_id: string;
          device_label: string;
          device_name: string;
      }
      - device_id: string
      - device_label: string
      - device_name: string
    - Optional igloo_metadata?: {
          bridge_id: string;
          device_id: string;
          model?: string;
      }
      - bridge_id: string
      - device_id: string
      - Optional model?: string
    - Optional igloohome_metadata?: {
          bridge_id?: string;
          bridge_name?: string;
          device_id: string;
          device_name: string;
      }
      - Optional bridge_id?: string
      - Optional bridge_name?: string
      - device_id: string
      - device_name: string
    - Optional image_alt_text?: string
      Alt text for the device image.
    - Optional image_url?: string
      Image URL for the device.
    - Optional is_climate_setting_schedule_active?: boolean
    - Optional is_cooling?: boolean
    - Optional is_cooling_available?: boolean
    - Optional is_fan_running?: boolean
    - Optional is_heating?: boolean
    - Optional is_heating_available?: boolean
    - Optional is_temporary_manual_override_active?: boolean
    - Optional keypad_battery?: {
      level: number;
      }
      - level: number
    - Optional kwikset_metadata?: {
          device_id: string;
          device_name: string;
          model_number: string;
      }
      - device_id: string
      - device_name: string
      - model_number: string
    - Optional locked?: boolean
    - Optional lockly_metadata?: {
          device_id: string;
          device_name: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional manufacturer?: string
      Manufacturer of the device.
    - Optional max_active_codes_supported?: number
    - Optional minut_metadata?: {
          device_id: string;
          device_name: string;
          latest_sensor_values: {
              accelerometer_z: {
                  time: string;
                  value: number;
              };
              humidity: {
                  time: string;
                  value: number;
              };
              pressure: {
                  time: string;
                  value: number;
              };
              sound: {
                  time: string;
                  value: number;
              };
              temperature: {
                  time: string;
                  value: number;
              };
          };
      }
      - device_id: string
      - device_name: string
      - latest_sensor_values: {
            accelerometer_z: {
                time: string;
                value: number;
            };
            humidity: {
                time: string;
                value: number;
            };
            pressure: {
                time: string;
                value: number;
            };
            sound: {
                time: string;
                value: number;
            };
            temperature: {
                time: string;
                value: number;
            };
        }
        accelerometer_z: {
            time: string;
            value: number;
        }
        time: string
        value: number
        humidity: {
            time: string;
            value: number;
        }
        time: string
        value: number
        pressure: {
            time: string;
            value: number;
        }
        time: string
        value: number
        sound: {
            time: string;
            value: number;
        }
        time: string
        value: number
        temperature: {
            time: string;
            value: number;
        }
        time: string
        value: number
    - model: {
          accessory_keypad_supported?: boolean;
          display_name: string;
          manufacturer_display_name: string;
          offline_access_codes_supported?: boolean;
          online_access_codes_supported?: boolean;
      }
      - Optional accessory_keypad_supported?: boolean
        Indicates whether the device supports an accessory keypad.
      - display_name: string
        Display name of the device model.
      - manufacturer_display_name: string
        Display name that corresponds to the manufacturer-specific terminology for the device.
      - Optional offline_access_codes_supported?: boolean
        Indicates whether the device supports offline access codes.
      - Optional online_access_codes_supported?: boolean
        Indicates whether the device supports online access codes.
    - name: string
      Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.
    - Optional nest_metadata?: {
          custom_name: string;
          device_name: string;
          nest_device_id: string;
      }
      - custom_name: string
      - device_name: string
      - nest_device_id: string
    - Optional noiseaware_metadata?: {
          device_id: string;
          device_model: "indoor" | "outdoor";
          device_name: string;
          noise_level_decibel: number;
          noise_level_nrs: number;
      }
      - device_id: string
      - device_model: "indoor" | "outdoor"
      - device_name: string
      - noise_level_decibel: number
      - noise_level_nrs: number
    - Optional nuki_metadata?: {
          device_id: string;
          device_name: string;
          keypad_battery_critical?: boolean;
      }
      - device_id: string
      - device_name: string
      - Optional keypad_battery_critical?: boolean
    - Optional offline_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use offline access codes for the device.
    - online: boolean
      Indicates whether the device is online.
    - Optional online_access_codes_enabled?: boolean
      Indicates whether it is currently possible to use online access codes for the device.
    - Optional relative_humidity?: number
    - Optional salto_metadata?: {
          battery_level: string;
          customer_reference: string;
          lock_id: string;
          lock_type: string;
          locked_state: string;
          model?: string;
      }
      - battery_level: string
      - customer_reference: string
      - lock_id: string
      - lock_type: string
      - locked_state: string
      - Optional model?: string
    - Optional schlage_metadata?: {
          access_code_length: number;
          device_id: string;
          device_name: string;
          model?: string;
      }
      - access_code_length: number
      - device_id: string
      - device_name: string
      - Optional model?: string
    - Optional seam_bridge_metadata?: {
          device_num: number;
          name: string;
          unlock_method?: "bridge" | "doorking";
      }
      - device_num: number
      - name: string
      - Optional unlock_method?: "bridge" | "doorking"
    - Optional serial_number?: string
      Serial number of the device.
    - Optional smartthings_metadata?: {
          device_id: string;
          device_name: string;
          location_id?: string;
          model?: string;
      }
      - device_id: string
      - device_name: string
      - Optional location_id?: string
      - Optional model?: string
    - Optional supported_code_lengths?: number[]
    - Optional supports_accessory_keypad?: boolean
      Deprecated. Use model.accessory_keypad_supported.
    - Optional supports_backup_access_code_pool?: boolean
    - Optional supports_offline_access_codes?: boolean
      Deprecated. Use offline_access_codes_enabled.
    - Optional temperature_celsius?: number
    - Optional temperature_fahrenheit?: number
    - Optional ttlock_metadata?: {
      lock_alias: string;
      lock_id: number;
      }
      - lock_alias: string
      - lock_id: number
    - Optional two_n_metadata?: {
      device_id: number;
      device_name: string;
      }
      - device_id: number
      - device_name: string
    - Optional wyze_metadata?: {
          device_id: string;
          device_info_model: string;
          device_name: string;
          product_model: string;
          product_name: string;
          product_type: string;
      }
      - device_id: string
      - device_info_model: string
      - device_name: string
      - product_model: string
      - product_name: string
      - product_type: string
  - warnings: {
    message: string;
    warning_code: string;
    }[]
    Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
  - workspace_id: string
    Unique identifier for the Seam workspace associated with the device.
method: "POST" | "GET"
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: {};
    method: "POST";
    queryParams: {};
    route: "/thermostats/heat";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    device_id: string;
    heating_set_point_celsius?: number;
    heating_set_point_fahrenheit?: number;
    sync?: boolean;
}
- device_id: string
- Optional heating_set_point_celsius?: number
- Optional heating_set_point_fahrenheit?: number
- Optional sync?: boolean
jsonResponse: {}
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: {};
    method: "POST";
    queryParams: {};
    route: "/thermostats/heat_cool";
}

Type declaration

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;
}
- Optional cooling_set_point_celsius?: number
- Optional cooling_set_point_fahrenheit?: number
- device_id: string
- Optional heating_set_point_celsius?: number
- Optional heating_set_point_fahrenheit?: number
- Optional sync?: boolean
jsonResponse: {}
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;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
        limit?: number;
        manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
        user_identifier_key?: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        thermostats: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/thermostats/list";
}

Type declaration

commonParams: {
    connect_webview_id?: string;
    connected_account_id?: string;
    connected_account_ids?: string[];
    created_before?: Date;
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
    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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[];
    limit?: number;
    manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
    user_identifier_key?: string;
}
- Optional connect_webview_id?: string
- Optional connected_account_id?: string
  List all devices owned by this connected account
- Optional connected_account_ids?: string[]
- Optional created_before?: Date
- Optional device_ids?: string[]
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
- Optional 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat")[]
- Optional limit?: number
- Optional manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
- Optional user_identifier_key?: string
formData: {}
jsonBody: {}
jsonResponse: {
    thermostats: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    }[];
}
- thermostats: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/thermostats/list"

/thermostats/off

/thermostats/off: {
    commonParams: {};
    formData: {};
    jsonBody: {
        device_id: string;
        sync?: boolean;
    };
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/thermostats/off";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
device_id: string;
sync?: boolean;
}
- device_id: string
- Optional sync?: boolean
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/thermostats/off"

/thermostats/set_fan_mode

/thermostats/set_fan_mode: {
    commonParams: {};
    formData: {};
    jsonBody: {
        device_id: string;
        fan_mode?: "auto" | "on";
        fan_mode_setting?: "auto" | "on";
        sync?: boolean;
    };
    jsonResponse: {};
    method: "POST";
    queryParams: {};
    route: "/thermostats/set_fan_mode";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    device_id: string;
    fan_mode?: "auto" | "on";
    fan_mode_setting?: "auto" | "on";
    sync?: boolean;
}
- device_id: string
- Optional fan_mode?: "auto" | "on"
- Optional fan_mode_setting?: "auto" | "on"
- Optional sync?: boolean
jsonResponse: {}
method: "POST"
queryParams: {}
route: "/thermostats/set_fan_mode"

/thermostats/update

/thermostats/update: {
    commonParams: {};
    formData: {};
    jsonBody: {
        default_climate_setting: {
            automatic_cooling_enabled?: boolean;
            automatic_heating_enabled?: boolean;
            cooling_set_point_celsius?: number;
            cooling_set_point_fahrenheit?: number;
            heating_set_point_celsius?: number;
            heating_set_point_fahrenheit?: number;
            hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
            manual_override_allowed?: boolean;
        };
        device_id: string;
    };
    jsonResponse: {};
    method: "POST" | "PATCH";
    queryParams: {};
    route: "/thermostats/update";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    default_climate_setting: {
        automatic_cooling_enabled?: boolean;
        automatic_heating_enabled?: boolean;
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
        manual_override_allowed?: boolean;
    };
    device_id: string;
}
- default_climate_setting: {
      automatic_cooling_enabled?: boolean;
      automatic_heating_enabled?: boolean;
      cooling_set_point_celsius?: number;
      cooling_set_point_fahrenheit?: number;
      heating_set_point_celsius?: number;
      heating_set_point_fahrenheit?: number;
      hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
      manual_override_allowed?: boolean;
  }
  - Optional automatic_cooling_enabled?: boolean
  - Optional automatic_heating_enabled?: boolean
  - Optional cooling_set_point_celsius?: number
  - Optional cooling_set_point_fahrenheit?: number
  - Optional heating_set_point_celsius?: number
  - Optional heating_set_point_fahrenheit?: number
  - Optional hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool"
  - Optional manual_override_allowed?: boolean
- device_id: string
jsonResponse: {}
method: "POST" | "PATCH"
queryParams: {}
route: "/thermostats/update"

/user_identities/add_acs_user

/user_identities/add_acs_user: {
    commonParams: {
        acs_user_id: string;
        user_identity_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "PUT";
    queryParams: {};
    route: "/user_identities/add_acs_user";
}

Type declaration

commonParams: {
acs_user_id: string;
user_identity_id: string;
}
- acs_user_id: string
- user_identity_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "PUT"
queryParams: {}
route: "/user_identities/add_acs_user"

/user_identities/create

/user_identities/create: {
    commonParams: {
        email_address?: null | string;
        first_name?: null | string;
        last_name?: null | string;
        user_identity_key?: null | string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        user_identity: {
            created_at: string;
            email_address?: null | string;
            first_name?: null | string;
            last_name?: null | string;
            user_identity_id: string;
            user_identity_key?: null | string;
            workspace_id: string;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/user_identities/create";
}

Type declaration

commonParams: {
    email_address?: null | string;
    first_name?: null | string;
    last_name?: null | string;
    user_identity_key?: null | string;
}
- Optional email_address?: null | string
- Optional first_name?: null | string
- Optional last_name?: null | string
- Optional user_identity_key?: null | string
formData: {}
jsonBody: {}
jsonResponse: {
    user_identity: {
        created_at: string;
        email_address?: null | string;
        first_name?: null | string;
        last_name?: null | string;
        user_identity_id: string;
        user_identity_key?: null | string;
        workspace_id: string;
    };
}
- user_identity: {
      created_at: string;
      email_address?: null | string;
      first_name?: null | string;
      last_name?: null | string;
      user_identity_id: string;
      user_identity_key?: null | string;
      workspace_id: string;
  }
  - created_at: string
  - Optional email_address?: null | string
  - Optional first_name?: null | string
  - Optional last_name?: null | string
  - user_identity_id: string
  - Optional user_identity_key?: null | string
  - workspace_id: string
method: "POST"
queryParams: {}
route: "/user_identities/create"

/user_identities/get

/user_identities/get: {
    commonParams: {
        user_identity_id: string;
    } | {
        user_identity_key: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        user_identity: {
            created_at: string;
            email_address?: null | string;
            first_name?: null | string;
            last_name?: null | string;
            user_identity_id: string;
            user_identity_key?: null | string;
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/user_identities/get";
}

Type declaration

commonParams: {
user_identity_id: string;
} | {
user_identity_key: string;
}
formData: {}
jsonBody: {}
jsonResponse: {
    user_identity: {
        created_at: string;
        email_address?: null | string;
        first_name?: null | string;
        last_name?: null | string;
        user_identity_id: string;
        user_identity_key?: null | string;
        workspace_id: string;
    };
}
- user_identity: {
      created_at: string;
      email_address?: null | string;
      first_name?: null | string;
      last_name?: null | string;
      user_identity_id: string;
      user_identity_key?: null | string;
      workspace_id: string;
  }
  - created_at: string
  - Optional email_address?: null | string
  - Optional first_name?: null | string
  - Optional last_name?: null | string
  - user_identity_id: string
  - Optional user_identity_key?: null | string
  - workspace_id: string
method: "POST" | "GET"
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: {};
    method: "POST" | "PUT";
    queryParams: {};
    route: "/user_identities/grant_access_to_device";
}

Type declaration

commonParams: {
device_id: string;
user_identity_id: string;
}
- device_id: string
- user_identity_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "PUT"
queryParams: {}
route: "/user_identities/grant_access_to_device"

/user_identities/list

/user_identities/list: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        user_identities: {
            created_at: string;
            email_address?: null | string;
            first_name?: null | string;
            last_name?: null | string;
            user_identity_id: string;
            user_identity_key?: null | string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/user_identities/list";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
    user_identities: {
        created_at: string;
        email_address?: null | string;
        first_name?: null | string;
        last_name?: null | string;
        user_identity_id: string;
        user_identity_key?: null | string;
        workspace_id: string;
    }[];
}
- user_identities: {
      created_at: string;
      email_address?: null | string;
      first_name?: null | string;
      last_name?: null | string;
      user_identity_id: string;
      user_identity_key?: null | string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
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: {
            capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
            connected_account_id: string;
            created_at: string;
            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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
            errors: {
                error_code: string;
                message: string;
            }[];
            is_managed: true;
            location: null | {
                location_name?: string;
                timezone?: string;
            };
            properties: {
                active_climate_setting_schedule?: {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                } | {
                    automatic_cooling_enabled?: boolean;
                    automatic_heating_enabled?: boolean;
                    climate_setting_schedule_id: string;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    created_at: string;
                    device_id: string;
                    errors?: any;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed?: boolean;
                    name?: string;
                    schedule_ends_at: string;
                    schedule_starts_at: string;
                    schedule_type: "time_bound";
                };
                august_metadata?: {
                    has_keypad: boolean;
                    house_id?: string;
                    house_name: string;
                    keypad_battery_level?: string;
                    lock_id: string;
                    lock_name: string;
                    model?: string;
                };
                available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
                avigilon_alta_metadata?: {
                    entry_name: string;
                    org_name: string;
                    site_id: number;
                    site_name: string;
                    zone_id: number;
                    zone_name: string;
                };
                battery?: {
                    level: number;
                    status: "low" | "full" | "critical" | "good";
                };
                battery_level?: number;
                brivo_metadata?: {
                    device_name: string;
                };
                can_enable_automatic_cooling?: boolean;
                can_enable_automatic_heating?: boolean;
                code_constraints?: ({
                    constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
                } | {
                    constraint_type: "name_length";
                    max_length?: number;
                    min_length?: number;
                })[];
                controlbyweb_metadata?: {
                    device_id: string;
                    device_name: string;
                    relay_name: null | string;
                };
                current_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                default_climate_setting?: {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                } | {
                    automatic_cooling_enabled: boolean;
                    automatic_heating_enabled: boolean;
                    cooling_set_point_celsius?: number;
                    cooling_set_point_fahrenheit?: number;
                    heating_set_point_celsius?: number;
                    heating_set_point_fahrenheit?: number;
                    hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                    manual_override_allowed: boolean;
                };
                door_open?: boolean;
                dormakaba_oracode_metadata?: {
                    device_id?: number;
                    door_id: number;
                    door_name: string;
                    iana_timezone?: string;
                    predefined_time_slots?: {
                        check_in_time: string;
                        check_out_time: string;
                        dormakaba_oracode_user_level_id: string;
                        ext_dormakaba_oracode_user_level_prefix: number;
                        is_24_hour: boolean;
                        is_biweekly_mode: boolean;
                        is_master: boolean;
                        is_one_shot: boolean;
                        name: string;
                        prefix: number;
                    }[];
                    site_id: number;
                    site_name: string;
                };
                ecobee_metadata?: {
                    device_name: string;
                    ecobee_device_id: string;
                };
                fan_mode_setting?: "auto" | "on";
                four_suites_metadata?: {
                    device_id: number;
                    device_name: string;
                    reclose_delay_in_seconds: number;
                };
                genie_metadata?: {
                    device_name: string;
                    door_name: string;
                };
                has_direct_power?: boolean;
                has_native_entry_events?: boolean;
                hubitat_metadata?: {
                    device_id: string;
                    device_label: string;
                    device_name: string;
                };
                igloo_metadata?: {
                    bridge_id: string;
                    device_id: string;
                    model?: string;
                };
                igloohome_metadata?: {
                    bridge_id?: string;
                    bridge_name?: string;
                    device_id: string;
                    device_name: string;
                };
                image_alt_text?: string;
                image_url?: string;
                is_climate_setting_schedule_active?: boolean;
                is_cooling?: boolean;
                is_cooling_available?: boolean;
                is_fan_running?: boolean;
                is_heating?: boolean;
                is_heating_available?: boolean;
                is_temporary_manual_override_active?: boolean;
                keypad_battery?: {
                    level: number;
                };
                kwikset_metadata?: {
                    device_id: string;
                    device_name: string;
                    model_number: string;
                };
                locked?: boolean;
                lockly_metadata?: {
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                manufacturer?: string;
                max_active_codes_supported?: number;
                minut_metadata?: {
                    device_id: string;
                    device_name: string;
                    latest_sensor_values: {
                        accelerometer_z: {
                            time: string;
                            value: number;
                        };
                        humidity: {
                            time: string;
                            value: number;
                        };
                        pressure: {
                            time: string;
                            value: number;
                        };
                        sound: {
                            time: string;
                            value: number;
                        };
                        temperature: {
                            time: string;
                            value: number;
                        };
                    };
                };
                model: {
                    accessory_keypad_supported?: boolean;
                    display_name: string;
                    manufacturer_display_name: string;
                    offline_access_codes_supported?: boolean;
                    online_access_codes_supported?: boolean;
                };
                name: string;
                nest_metadata?: {
                    custom_name: string;
                    device_name: string;
                    nest_device_id: string;
                };
                noiseaware_metadata?: {
                    device_id: string;
                    device_model: "indoor" | "outdoor";
                    device_name: string;
                    noise_level_decibel: number;
                    noise_level_nrs: number;
                };
                nuki_metadata?: {
                    device_id: string;
                    device_name: string;
                    keypad_battery_critical?: boolean;
                };
                offline_access_codes_enabled?: boolean;
                online: boolean;
                online_access_codes_enabled?: boolean;
                relative_humidity?: number;
                salto_metadata?: {
                    battery_level: string;
                    customer_reference: string;
                    lock_id: string;
                    lock_type: string;
                    locked_state: string;
                    model?: string;
                };
                schlage_metadata?: {
                    access_code_length: number;
                    device_id: string;
                    device_name: string;
                    model?: string;
                };
                seam_bridge_metadata?: {
                    device_num: number;
                    name: string;
                    unlock_method?: "bridge" | "doorking";
                };
                serial_number?: string;
                smartthings_metadata?: {
                    device_id: string;
                    device_name: string;
                    location_id?: string;
                    model?: string;
                };
                supported_code_lengths?: number[];
                supports_accessory_keypad?: boolean;
                supports_backup_access_code_pool?: boolean;
                supports_offline_access_codes?: boolean;
                temperature_celsius?: number;
                temperature_fahrenheit?: number;
                ttlock_metadata?: {
                    lock_alias: string;
                    lock_id: number;
                };
                two_n_metadata?: {
                    device_id: number;
                    device_name: string;
                };
                wyze_metadata?: {
                    device_id: string;
                    device_info_model: string;
                    device_name: string;
                    product_model: string;
                    product_name: string;
                    product_type: string;
                };
            };
            warnings: {
                message: string;
                warning_code: string;
            }[];
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/user_identities/list_accessible_devices";
}

Type declaration

commonParams: {
user_identity_id: string;
}
- user_identity_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    accessible_devices: {
        capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
        connected_account_id: string;
        created_at: string;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
        errors: {
            error_code: string;
            message: string;
        }[];
        is_managed: true;
        location: null | {
            location_name?: string;
            timezone?: string;
        };
        properties: {
            active_climate_setting_schedule?: {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            } | {
                automatic_cooling_enabled?: boolean;
                automatic_heating_enabled?: boolean;
                climate_setting_schedule_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                errors?: any;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed?: boolean;
                name?: string;
                schedule_ends_at: string;
                schedule_starts_at: string;
                schedule_type: "time_bound";
            };
            august_metadata?: {
                has_keypad: boolean;
                house_id?: string;
                house_name: string;
                keypad_battery_level?: string;
                lock_id: string;
                lock_name: string;
                model?: string;
            };
            available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
            avigilon_alta_metadata?: {
                entry_name: string;
                org_name: string;
                site_id: number;
                site_name: string;
                zone_id: number;
                zone_name: string;
            };
            battery?: {
                level: number;
                status: "low" | "full" | "critical" | "good";
            };
            battery_level?: number;
            brivo_metadata?: {
                device_name: string;
            };
            can_enable_automatic_cooling?: boolean;
            can_enable_automatic_heating?: boolean;
            code_constraints?: ({
                constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
            } | {
                constraint_type: "name_length";
                max_length?: number;
                min_length?: number;
            })[];
            controlbyweb_metadata?: {
                device_id: string;
                device_name: string;
                relay_name: null | string;
            };
            current_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            default_climate_setting?: {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            } | {
                automatic_cooling_enabled: boolean;
                automatic_heating_enabled: boolean;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
                manual_override_allowed: boolean;
            };
            door_open?: boolean;
            dormakaba_oracode_metadata?: {
                device_id?: number;
                door_id: number;
                door_name: string;
                iana_timezone?: string;
                predefined_time_slots?: {
                    check_in_time: string;
                    check_out_time: string;
                    dormakaba_oracode_user_level_id: string;
                    ext_dormakaba_oracode_user_level_prefix: number;
                    is_24_hour: boolean;
                    is_biweekly_mode: boolean;
                    is_master: boolean;
                    is_one_shot: boolean;
                    name: string;
                    prefix: number;
                }[];
                site_id: number;
                site_name: string;
            };
            ecobee_metadata?: {
                device_name: string;
                ecobee_device_id: string;
            };
            fan_mode_setting?: "auto" | "on";
            four_suites_metadata?: {
                device_id: number;
                device_name: string;
                reclose_delay_in_seconds: number;
            };
            genie_metadata?: {
                device_name: string;
                door_name: string;
            };
            has_direct_power?: boolean;
            has_native_entry_events?: boolean;
            hubitat_metadata?: {
                device_id: string;
                device_label: string;
                device_name: string;
            };
            igloo_metadata?: {
                bridge_id: string;
                device_id: string;
                model?: string;
            };
            igloohome_metadata?: {
                bridge_id?: string;
                bridge_name?: string;
                device_id: string;
                device_name: string;
            };
            image_alt_text?: string;
            image_url?: string;
            is_climate_setting_schedule_active?: boolean;
            is_cooling?: boolean;
            is_cooling_available?: boolean;
            is_fan_running?: boolean;
            is_heating?: boolean;
            is_heating_available?: boolean;
            is_temporary_manual_override_active?: boolean;
            keypad_battery?: {
                level: number;
            };
            kwikset_metadata?: {
                device_id: string;
                device_name: string;
                model_number: string;
            };
            locked?: boolean;
            lockly_metadata?: {
                device_id: string;
                device_name: string;
                model?: string;
            };
            manufacturer?: string;
            max_active_codes_supported?: number;
            minut_metadata?: {
                device_id: string;
                device_name: string;
                latest_sensor_values: {
                    accelerometer_z: {
                        time: string;
                        value: number;
                    };
                    humidity: {
                        time: string;
                        value: number;
                    };
                    pressure: {
                        time: string;
                        value: number;
                    };
                    sound: {
                        time: string;
                        value: number;
                    };
                    temperature: {
                        time: string;
                        value: number;
                    };
                };
            };
            model: {
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_access_codes_supported?: boolean;
                online_access_codes_supported?: boolean;
            };
            name: string;
            nest_metadata?: {
                custom_name: string;
                device_name: string;
                nest_device_id: string;
            };
            noiseaware_metadata?: {
                device_id: string;
                device_model: "indoor" | "outdoor";
                device_name: string;
                noise_level_decibel: number;
                noise_level_nrs: number;
            };
            nuki_metadata?: {
                device_id: string;
                device_name: string;
                keypad_battery_critical?: boolean;
            };
            offline_access_codes_enabled?: boolean;
            online: boolean;
            online_access_codes_enabled?: boolean;
            relative_humidity?: number;
            salto_metadata?: {
                battery_level: string;
                customer_reference: string;
                lock_id: string;
                lock_type: string;
                locked_state: string;
                model?: string;
            };
            schlage_metadata?: {
                access_code_length: number;
                device_id: string;
                device_name: string;
                model?: string;
            };
            seam_bridge_metadata?: {
                device_num: number;
                name: string;
                unlock_method?: "bridge" | "doorking";
            };
            serial_number?: string;
            smartthings_metadata?: {
                device_id: string;
                device_name: string;
                location_id?: string;
                model?: string;
            };
            supported_code_lengths?: number[];
            supports_accessory_keypad?: boolean;
            supports_backup_access_code_pool?: boolean;
            supports_offline_access_codes?: boolean;
            temperature_celsius?: number;
            temperature_fahrenheit?: number;
            ttlock_metadata?: {
                lock_alias: string;
                lock_id: number;
            };
            two_n_metadata?: {
                device_id: number;
                device_name: string;
            };
            wyze_metadata?: {
                device_id: string;
                device_info_model: string;
                device_name: string;
                product_model: string;
                product_name: string;
                product_type: string;
            };
        };
        warnings: {
            message: string;
            warning_code: string;
        }[];
        workspace_id: string;
    }[];
}
- accessible_devices: {
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery")[];
      connected_account_id: string;
      created_at: string;
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          active_climate_setting_schedule?: {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          } | {
              automatic_cooling_enabled?: boolean;
              automatic_heating_enabled?: boolean;
              climate_setting_schedule_id: string;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              created_at: string;
              device_id: string;
              errors?: any;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed?: boolean;
              name?: string;
              schedule_ends_at: string;
              schedule_starts_at: string;
              schedule_type: "time_bound";
          };
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          available_hvac_mode_settings?: ("off" | "heat" | "cool" | "heat_cool")[];
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          brivo_metadata?: {
              device_name: string;
          };
          can_enable_automatic_cooling?: boolean;
          can_enable_automatic_heating?: boolean;
          code_constraints?: ({
              constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | "cannot_specify_pin_code" | "pin_code_matches_existing_set" | "start_date_in_future";
          } | {
              constraint_type: "name_length";
              max_length?: number;
              min_length?: number;
          })[];
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          current_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          default_climate_setting?: {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          } | {
              automatic_cooling_enabled: boolean;
              automatic_heating_enabled: boolean;
              cooling_set_point_celsius?: number;
              cooling_set_point_fahrenheit?: number;
              heating_set_point_celsius?: number;
              heating_set_point_fahrenheit?: number;
              hvac_mode_setting: "off" | "heat" | "cool" | "heat_cool";
              manual_override_allowed: boolean;
          };
          door_open?: boolean;
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          fan_mode_setting?: "auto" | "on";
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          has_direct_power?: boolean;
          has_native_entry_events?: boolean;
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          image_alt_text?: string;
          image_url?: string;
          is_climate_setting_schedule_active?: boolean;
          is_cooling?: boolean;
          is_cooling_available?: boolean;
          is_fan_running?: boolean;
          is_heating?: boolean;
          is_heating_available?: boolean;
          is_temporary_manual_override_active?: boolean;
          keypad_battery?: {
              level: number;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          locked?: boolean;
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          manufacturer?: string;
          max_active_codes_supported?: number;
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          relative_humidity?: number;
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "bridge" | "doorking";
          };
          serial_number?: string;
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          supported_code_lengths?: number[];
          supports_accessory_keypad?: boolean;
          supports_backup_access_code_pool?: boolean;
          supports_offline_access_codes?: boolean;
          temperature_celsius?: number;
          temperature_fahrenheit?: number;
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/user_identities/list_accessible_devices"

/user_identities/list_acs_users

/user_identities/list_acs_users: {
    commonParams: {
        user_identity_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {
        acs_users: {
            acs_system_id: string;
            acs_user_id: string;
            created_at: string;
            display_name: string;
            email?: string;
            email_address?: string;
            ends_at?: string;
            external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
            external_type_display_name?: string;
            full_name?: string;
            hid_acs_system_id?: string;
            is_suspended: boolean;
            is_virtual: boolean;
            phone_number?: string;
            starts_at?: string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/user_identities/list_acs_users";
}

Type declaration

commonParams: {
user_identity_id: string;
}
- user_identity_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    acs_users: {
        acs_system_id: string;
        acs_user_id: string;
        created_at: string;
        display_name: string;
        email?: string;
        email_address?: string;
        ends_at?: string;
        external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
        external_type_display_name?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        is_suspended: boolean;
        is_virtual: boolean;
        phone_number?: string;
        starts_at?: string;
        workspace_id: string;
    }[];
}
- acs_users: {
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      ends_at?: string;
      external_type?: "pti_user" | "brivo_user" | "hid_cm_user" | "salto_site_user";
      external_type_display_name?: string;
      full_name?: string;
      hid_acs_system_id?: string;
      is_suspended: boolean;
      is_virtual: boolean;
      phone_number?: string;
      starts_at?: string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
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: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/user_identities/remove_acs_user";
}

Type declaration

commonParams: {
acs_user_id: string;
user_identity_id: string;
}
- acs_user_id: string
- user_identity_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
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: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/user_identities/revoke_access_to_device";
}

Type declaration

commonParams: {
device_id: string;
user_identity_id: string;
}
- device_id: string
- user_identity_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
queryParams: {}
route: "/user_identities/revoke_access_to_device"

/webhooks/create

/webhooks/create: {
    commonParams: {};
    formData: {};
    jsonBody: {
        event_types?: string[];
        url: string;
    };
    jsonResponse: {
        webhook: {
            event_types?: string[];
            secret?: string;
            url: string;
            webhook_id: string;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/webhooks/create";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
event_types?: string[];
url: string;
}
- Optional event_types?: string[]
- url: string
jsonResponse: {
    webhook: {
        event_types?: string[];
        secret?: string;
        url: string;
        webhook_id: string;
    };
}
- webhook: {
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }
  - Optional event_types?: string[]
  - Optional secret?: string
  - url: string
  - webhook_id: string
method: "POST"
queryParams: {}
route: "/webhooks/create"

/webhooks/delete

/webhooks/delete: {
    commonParams: {
        webhook_id: string;
    };
    formData: {};
    jsonBody: {};
    jsonResponse: {};
    method: "POST" | "DELETE";
    queryParams: {};
    route: "/webhooks/delete";
}

Type declaration

commonParams: {
webhook_id: string;
}
- webhook_id: string
formData: {}
jsonBody: {}
jsonResponse: {}
method: "POST" | "DELETE"
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;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/webhooks/get";
}

Type declaration

commonParams: {
webhook_id: string;
}
- webhook_id: string
formData: {}
jsonBody: {}
jsonResponse: {
    webhook: {
        event_types?: string[];
        secret?: string;
        url: string;
        webhook_id: string;
    };
}
- webhook: {
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }
  - Optional event_types?: string[]
  - Optional secret?: string
  - url: string
  - webhook_id: string
method: "POST" | "GET"
queryParams: {}
route: "/webhooks/get"

/webhooks/list

/webhooks/list: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        webhooks: {
            event_types?: string[];
            secret?: string;
            url: string;
            webhook_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/webhooks/list";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
    webhooks: {
        event_types?: string[];
        secret?: string;
        url: string;
        webhook_id: string;
    }[];
}
- webhooks: {
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/webhooks/list"

/workspaces/create

/workspaces/create: {
    commonParams: {};
    formData: {};
    jsonBody: {
        connect_partner_name: string;
        is_sandbox?: boolean;
        name: string;
        webview_logo_shape?: "square" | "circle";
        webview_primary_button_color?: string;
    };
    jsonResponse: {
        workspace: {
            connect_partner_name: null | string;
            is_sandbox: boolean;
            name: string;
            workspace_id: string;
        };
    };
    method: "POST";
    queryParams: {};
    route: "/workspaces/create";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {
    connect_partner_name: string;
    is_sandbox?: boolean;
    name: string;
    webview_logo_shape?: "square" | "circle";
    webview_primary_button_color?: string;
}
- connect_partner_name: string
  The name shown inside the connect webview
- Optional is_sandbox?: boolean
- name: string
- Optional webview_logo_shape?: "square" | "circle"
- Optional webview_primary_button_color?: string
jsonResponse: {
    workspace: {
        connect_partner_name: null | string;
        is_sandbox: boolean;
        name: string;
        workspace_id: string;
    };
}
- workspace: {
      connect_partner_name: null | string;
      is_sandbox: boolean;
      name: string;
      workspace_id: string;
  }
  - connect_partner_name: null | string
  - is_sandbox: boolean
  - name: string
  - workspace_id: string
method: "POST"
queryParams: {}
route: "/workspaces/create"

/workspaces/get

/workspaces/get: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        workspace?: {
            connect_partner_name: null | string;
            is_sandbox: boolean;
            name: string;
            workspace_id: string;
        };
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/workspaces/get";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
    workspace?: {
        connect_partner_name: null | string;
        is_sandbox: boolean;
        name: string;
        workspace_id: string;
    };
}
- Optional workspace?: {
      connect_partner_name: null | string;
      is_sandbox: boolean;
      name: string;
      workspace_id: string;
  }
  - connect_partner_name: null | string
  - is_sandbox: boolean
  - name: string
  - workspace_id: string
method: "POST" | "GET"
queryParams: {}
route: "/workspaces/get"

/workspaces/list

/workspaces/list: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        workspaces: {
            connect_partner_name: null | string;
            is_sandbox: boolean;
            name: string;
            workspace_id: string;
        }[];
    };
    method: "POST" | "GET";
    queryParams: {};
    route: "/workspaces/list";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
    workspaces: {
        connect_partner_name: null | string;
        is_sandbox: boolean;
        name: string;
        workspace_id: string;
    }[];
}
- workspaces: {
      connect_partner_name: null | string;
      is_sandbox: boolean;
      name: string;
      workspace_id: string;
  }[]
method: "POST" | "GET"
queryParams: {}
route: "/workspaces/list"

/workspaces/reset_sandbox

/workspaces/reset_sandbox: {
    commonParams: {};
    formData: {};
    jsonBody: {};
    jsonResponse: {
        message: string;
    };
    method: "POST";
    queryParams: {};
    route: "/workspaces/reset_sandbox";
}

Type declaration

commonParams: {}
formData: {}
jsonBody: {}
jsonResponse: {
message: string;
}
- message: string
method: "POST"
queryParams: {}
route: "/workspaces/reset_sandbox"

Interface Routes

Index

Properties

Properties

/access_codes/create

Type declaration

commonParams: {}

formData: {}

Optional allow_external_modification?: boolean

Optional attempt_for_offline_device?: boolean

Optional code?: string

Optional common_code_key?: string

device_id: string

Optional ends_at?: string

Optional is_external_modification_allowed?: boolean

Optional is_offline_access_code?: boolean

Optional is_one_time_use?: boolean

Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

Optional name?: string

Optional prefer_native_scheduling?: boolean

Optional starts_at?: string

Optional sync?: boolean

Optional use_backup_access_code_pool?: boolean

Optional use_offline_access_code?: boolean

access_code_id: string

code: null | string

common_code_key: null | string

created_at: string

device_id: string

Optional ends_at?: null | string

Optional errors?: any

Optional 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

Optional is_scheduled_on_device?: boolean

Optional is_waiting_for_code_assignment?: boolean

name: null | string

Optional pulled_backup_access_code_id?: null | string

Optional starts_at?: null | string

status: "set" | "unknown" | "setting" | "unset" | "removing"

type: "time_bound" | "ongoing"

Optional warnings?: any

method: "POST"

queryParams: {}

route: "/access_codes/create"

/access_codes/create_multiple

Type declaration

commonParams: {}

formData: {}

Optional allow_external_modification?: boolean

Optional attempt_for_offline_device?: boolean

Optional behavior_when_code_cannot_be_shared?: "throw" | "create_random_code"

Optional code?: string

device_ids: string[]

Optional ends_at?: string

Optional is_external_modification_allowed?: boolean

Optional is_offline_access_code?: boolean

Optional is_one_time_use?: boolean

Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

Optional name?: string

Optional prefer_native_scheduling?: boolean

Optional starts_at?: string

Optional use_backup_access_code_pool?: boolean

Optional use_offline_access_code?: boolean

method: "POST" | "PUT"

queryParams: {}

route: "/access_codes/create_multiple"

/access_codes/delete

Type declaration

commonParams: { access_code_id: string; device_id?: string; sync?: boolean; }

access_code_id: string

Optional device_id?: string

Optional sync?: boolean

formData: {}

jsonBody: {}

method: "POST" | "DELETE"

queryParams: {}

`Optional` allow_external_modification?: boolean

`Optional` attempt_for_offline_device?: boolean

`Optional` code?: string

`Optional` common_code_key?: string

`Optional` ends_at?: string

`Optional` is_external_modification_allowed?: boolean

`Optional` is_offline_access_code?: boolean

`Optional` is_one_time_use?: boolean

`Optional` max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

`Optional` name?: string

`Optional` prefer_native_scheduling?: boolean

`Optional` starts_at?: string

`Optional` sync?: boolean

`Optional` use_backup_access_code_pool?: boolean

`Optional` use_offline_access_code?: boolean

`Optional` ends_at?: null | string

`Optional` errors?: any

`Optional` is_backup?: boolean

`Optional` is_scheduled_on_device?: boolean

`Optional` is_waiting_for_code_assignment?: boolean

`Optional` pulled_backup_access_code_id?: null | string

`Optional` starts_at?: null | string

`Optional` warnings?: any

`Optional` allow_external_modification?: boolean

`Optional` attempt_for_offline_device?: boolean

`Optional` behavior_when_code_cannot_be_shared?: "throw" | "create_random_code"

`Optional` code?: string

`Optional` ends_at?: string

`Optional` is_external_modification_allowed?: boolean

`Optional` is_offline_access_code?: boolean

`Optional` is_one_time_use?: boolean

`Optional` max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

`Optional` name?: string

`Optional` prefer_native_scheduling?: boolean

`Optional` starts_at?: string

`Optional` use_backup_access_code_pool?: boolean

`Optional` use_offline_access_code?: boolean

commonParams: {
access_code_id: string;
device_id?: string;
sync?: boolean;
}

`Optional` device_id?: string

`Optional` sync?: boolean

commonParams: {
device_id: string;
}

jsonResponse: {
generated_code: {
code: string;
device_id: string;
};
}

generated_code: {
code: string;
device_id: string;
}

commonParams: {
access_code_id?: string;
code?: string;
device_id?: string;
}

`Optional` access_code_id?: string

`Optional` code?: string

`Optional` device_id?: string

`Optional` ends_at?: null | string

`Optional` errors?: any

`Optional` is_backup?: boolean

`Optional` is_scheduled_on_device?: boolean

`Optional` is_waiting_for_code_assignment?: boolean

`Optional` pulled_backup_access_code_id?: null | string

`Optional` starts_at?: null | string

`Optional` warnings?: any

commonParams: {
access_code_ids?: string[];
device_id?: string;
user_identifier_key?: string;
}

`Optional` access_code_ids?: string[]

`Optional` device_id?: string

`Optional` user_identifier_key?: string