Class SeamHttpThermostats

Hierarchy

  • SeamHttpThermostats

Constructors

constructor

Properties

client defaults

Accessors

climateSettingSchedules

Methods

cool get heat heatCool list off setFanMode update fromApiKey fromClient fromClientSessionToken fromConsoleSessionToken fromPersonalAccessToken fromPublishableKey

Constructors

constructor

Properties

client

client: AxiosInstance

Readonly defaults

defaults: Required<SeamHttpRequestOptions>

Accessors

climateSettingSchedules

Methods

cool

  • Parameters

    • Optional body: {
          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

    Returns Promise<void>

get

  • Parameters

    • Optional body: {
          device_id?: string;
          name?: string;
      }
      • Optional device_id?: string
      • Optional name?: string

    Returns Promise<{
        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;
                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;
                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;
                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;
                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: {
                access_codes_supported?: boolean;
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_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?: "doorking" | "bridge";
            };
            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;
    }>

heat

  • Parameters

    • Optional body: {
          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

    Returns Promise<void>

heatCool

  • Parameters

    • Optional body: {
          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

    Returns Promise<void>

list

  • Parameters

    • Optional body: {
          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" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "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" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "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

    Returns Promise<{
        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;
                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;
                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;
                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;
                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: {
                access_codes_supported?: boolean;
                accessory_keypad_supported?: boolean;
                display_name: string;
                manufacturer_display_name: string;
                offline_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?: "doorking" | "bridge";
            };
            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;
    }[]>

off

  • Parameters

    • Optional body: {
          device_id: string;
          sync?: boolean;
      }
      • device_id: string
      • Optional sync?: boolean

    Returns Promise<void>

setFanMode

  • Parameters

    • Optional body: {
          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

    Returns Promise<void>

update

  • Parameters

    • Optional body: {
          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

    Returns Promise<void>

Static fromApiKey

Static fromClient

Static fromClientSessionToken

Static fromConsoleSessionToken

Static fromPersonalAccessToken

Static fromPublishableKey

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc