Class SeamHttpThermostats

constructor

• new SeamHttpThermostats(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpThermostats

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpThermostats

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

dailyPrograms

• get dailyPrograms(): SeamHttpThermostatsDailyPrograms

  Returns SeamHttpThermostatsDailyPrograms

schedules

• get schedules(): SeamHttpThermostatsSchedules

  Returns SeamHttpThermostatsSchedules

simulate

• get simulate(): SeamHttpThermostatsSimulate

  Returns SeamHttpThermostatsSimulate

activateClimatePreset

• activateClimatePreset(
      parameters?: { climate_preset_key: string; device_id: string },
      options?: ThermostatsActivateClimatePresetOptions,
  ): ThermostatsActivateClimatePresetRequest

  Parameters

  • Optionalparameters: { climate_preset_key: string; device_id: string }

    • climate_preset_key: string

      Climate preset key of the climate preset that you want to activate.

    • device_id: string

      ID of the thermostat device for which you want to activate a climate preset.
  • options: ThermostatsActivateClimatePresetOptions = {}

  Returns ThermostatsActivateClimatePresetRequest

cool

• cool(
      parameters?: {
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          device_id: string;
          sync?: boolean;
      },
      options?: ThermostatsCoolOptions,
  ): ThermostatsCoolRequest

  Parameters

  • Optionalparameters: {
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        device_id: string;
        sync?: boolean;
    }

    • Optionalcooling_set_point_celsius?: number

      Cooling set point in °C that you want to set for the thermostat. You must set one of the cooling_set_point parameters.

    • Optionalcooling_set_point_fahrenheit?: number

      Cooling set point in °F that you want to set for the thermostat. You must set one of the cooling_set_point parameters.

    • device_id: string

      ID of the thermostat device that you want to set to cool mode.

    • Optionalsync?: boolean
  • options: ThermostatsCoolOptions = {}

  Returns ThermostatsCoolRequest

createClimatePreset

• createClimatePreset(
      parameters?: {
          climate_preset_key: string;
          climate_preset_mode?:
              | "home"
              | "away"
              | "wake"
              | "sleep"
              | "occupied"
              | "unoccupied";
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          device_id: string;
          ecobee_metadata?: {
              climate_ref: string;
              is_optimized: boolean;
              owner: "user"
              | "system";
          };
          fan_mode_setting?: "auto"
          | "on"
          | "circulate";
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "cool" | "heat" | "off" | "heat_cool" | "eco";
          manual_override_allowed?: boolean;
          name?: null | string;
      },
      options?: ThermostatsCreateClimatePresetOptions,
  ): ThermostatsCreateClimatePresetRequest

  Parameters

  • Optionalparameters: {
        climate_preset_key: string;
        climate_preset_mode?:
            | "home"
            | "away"
            | "wake"
            | "sleep"
            | "occupied"
            | "unoccupied";
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        device_id: string;
        ecobee_metadata?: {
            climate_ref: string;
            is_optimized: boolean;
            owner: "user"
            | "system";
        };
        fan_mode_setting?: "auto"
        | "on"
        | "circulate";
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "cool" | "heat" | "off" | "heat_cool" | "eco";
        manual_override_allowed?: boolean;
        name?: null | string;
    }

    • climate_preset_key: string

      Unique key to identify the climate preset.

    • Optionalclimate_preset_mode?: "home" | "away" | "wake" | "sleep" | "occupied" | "unoccupied"

      The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

    • Optionalcooling_set_point_celsius?: number

      Temperature to which the thermostat should cool (in °C). See also Set Points.

    • Optionalcooling_set_point_fahrenheit?: number

      Temperature to which the thermostat should cool (in °F). See also Set Points.

    • device_id: string

      ID of the thermostat device for which you want create a climate preset.

    • Optionalecobee_metadata?: { climate_ref: string; is_optimized: boolean; owner: "user" | "system" }

      Metadata specific to the Ecobee climate, if applicable.

      • climate_ref: string

        Reference to the Ecobee climate, if applicable.

      • is_optimized: boolean

        Indicates if the climate preset is optimized by Ecobee.

      • owner: "user" | "system"

        Indicates whether the climate preset is owned by the user or the system.

    • Optionalfan_mode_setting?: "auto" | "on" | "circulate"

      Desired fan mode setting, such as on, auto, or circulate.

    • Optionalheating_set_point_celsius?: number

      Temperature to which the thermostat should heat (in °C). See also Set Points.

    • Optionalheating_set_point_fahrenheit?: number

      Temperature to which the thermostat should heat (in °F). See also Set Points.

    • Optionalhvac_mode_setting?: "cool" | "heat" | "off" | "heat_cool" | "eco"

      Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

    • Optionalmanual_override_allowed?: boolean

      Indicates whether a person at the thermostat or using the API can change the thermostat's settings.

      Deprecated

      Use 'thermostat_schedule.is_override_allowed'

    • Optionalname?: null | string

      User-friendly name to identify the climate preset.
  • options: ThermostatsCreateClimatePresetOptions = {}

  Returns ThermostatsCreateClimatePresetRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

deleteClimatePreset

• deleteClimatePreset(
      parameters?: { climate_preset_key: string; device_id: string },
      options?: ThermostatsDeleteClimatePresetOptions,
  ): ThermostatsDeleteClimatePresetRequest

  Parameters

  • Optionalparameters: { climate_preset_key: string; device_id: string }

    • climate_preset_key: string

      Climate preset key of the climate preset that you want to delete.

    • device_id: string

      ID of the thermostat device for which you want to delete a climate preset.
  • options: ThermostatsDeleteClimatePresetOptions = {}

  Returns ThermostatsDeleteClimatePresetRequest

get

• get(
      parameters?: { device_id?: string; name?: string },
      options?: ThermostatsGetOptions,
  ): ThermostatsGetRequest

  Parameters

  • Optionalparameters: { device_id?: string; name?: string }

    • Optionaldevice_id?: string

      ID of the thermostat device that you want to get.

    • Optionalname?: string

      Name of the thermostat device that you want to retrieve.
  • options: ThermostatsGetOptions = {}

  Returns ThermostatsGetRequest

heat

• heat(
      parameters?: {
          device_id: string;
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          sync?: boolean;
      },
      options?: ThermostatsHeatOptions,
  ): ThermostatsHeatRequest

  Parameters

  • Optionalparameters: {
        device_id: string;
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        sync?: boolean;
    }

    • device_id: string

      ID of the thermostat device that you want to set to heat mode.

    • Optionalheating_set_point_celsius?: number

      Heating set point in °C that you want to set for the thermostat. You must set one of the heating_set_point parameters.

    • Optionalheating_set_point_fahrenheit?: number

      Heating set point in °F that you want to set for the thermostat. You must set one of the heating_set_point parameters.

    • Optionalsync?: boolean
  • options: ThermostatsHeatOptions = {}

  Returns ThermostatsHeatRequest

heatCool

• heatCool(
      parameters?: {
          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;
      },
      options?: ThermostatsHeatCoolOptions,
  ): ThermostatsHeatCoolRequest

  Parameters

  • Optionalparameters: {
        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;
    }

    • Optionalcooling_set_point_celsius?: number

      Cooling set point in °C that you want to set for the thermostat. You must set one of the cooling_set_point parameters.

    • Optionalcooling_set_point_fahrenheit?: number

      Cooling set point in °F that you want to set for the thermostat. You must set one of the cooling_set_point parameters.

    • device_id: string

      ID of the thermostat device that you want to set to heat-cool mode.

    • Optionalheating_set_point_celsius?: number

      Heating set point in °C that you want to set for the thermostat. You must set one of the heating_set_point parameters.

    • Optionalheating_set_point_fahrenheit?: number

      Heating set point in °F that you want to set for the thermostat. You must set one of the heating_set_point parameters.

    • Optionalsync?: boolean
  • options: ThermostatsHeatCoolOptions = {}

  Returns ThermostatsHeatCoolRequest

list

• list(
      parameters?: {
          connect_webview_id?: string;
          connected_account_id?: string;
          connected_account_ids?: string[];
          created_before?: Date;
          custom_metadata_has?: { [x: string]: string | boolean };
          customer_key?: string;
          device_ids?: string[];
          device_type?:
              | "ecobee_thermostat"
              | "nest_thermostat"
              | "honeywell_resideo_thermostat"
              | "tado_thermostat"
              | "sensi_thermostat"
              | "smartthings_thermostat";
          device_types?: (
              | "ecobee_thermostat"
              | "nest_thermostat"
              | "honeywell_resideo_thermostat"
              | "tado_thermostat"
              | "sensi_thermostat"
              | "smartthings_thermostat"
          )[];
          exclude_if?: (
              | "can_remotely_unlock"
              | "can_remotely_lock"
              | "can_program_offline_access_codes"
              | "can_program_online_access_codes"
              | "can_hvac_heat"
              | "can_hvac_cool"
              | "can_hvac_heat_cool"
              | "can_turn_off_hvac"
              | "can_simulate_removal"
              | "can_simulate_connection"
              | "can_simulate_disconnection"
              | "can_unlock_with_code"
              | "can_run_thermostat_programs"
              | "can_program_thermostat_programs_as_weekday_weekend"
              | "can_program_thermostat_programs_as_different_each_day"
              | "can_program_thermostat_programs_as_same_each_day"
              | "can_simulate_hub_connection"
              | "can_simulate_hub_disconnection"
              | "can_simulate_paid_subscription"
          )[];
          include_if?: (
              | "can_remotely_unlock"
              | "can_remotely_lock"
              | "can_program_offline_access_codes"
              | "can_program_online_access_codes"
              | "can_hvac_heat"
              | "can_hvac_cool"
              | "can_hvac_heat_cool"
              | "can_turn_off_hvac"
              | "can_simulate_removal"
              | "can_simulate_connection"
              | "can_simulate_disconnection"
              | "can_unlock_with_code"
              | "can_run_thermostat_programs"
              | "can_program_thermostat_programs_as_weekday_weekend"
              | "can_program_thermostat_programs_as_different_each_day"
              | "can_program_thermostat_programs_as_same_each_day"
              | "can_simulate_hub_connection"
              | "can_simulate_hub_disconnection"
              | "can_simulate_paid_subscription"
          )[];
          limit?: number;
          manufacturer?: | "smartthings"
          | "nest"
          | "ecobee"
          | "honeywell_resideo"
          | "tado"
          | "sensi";
          page_cursor?: null
          | string;
          search?: string;
          space_id?: string;
          unstable_location_id?: null | string;
          user_identifier_key?: string;
      },
      options?: ThermostatsListOptions,
  ): ThermostatsListRequest

  Parameters

  • Optionalparameters: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        custom_metadata_has?: { [x: string]: string | boolean };
        customer_key?: string;
        device_ids?: string[];
        device_type?:
            | "ecobee_thermostat"
            | "nest_thermostat"
            | "honeywell_resideo_thermostat"
            | "tado_thermostat"
            | "sensi_thermostat"
            | "smartthings_thermostat";
        device_types?: (
            | "ecobee_thermostat"
            | "nest_thermostat"
            | "honeywell_resideo_thermostat"
            | "tado_thermostat"
            | "sensi_thermostat"
            | "smartthings_thermostat"
        )[];
        exclude_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection"
            | "can_unlock_with_code"
            | "can_run_thermostat_programs"
            | "can_program_thermostat_programs_as_weekday_weekend"
            | "can_program_thermostat_programs_as_different_each_day"
            | "can_program_thermostat_programs_as_same_each_day"
            | "can_simulate_hub_connection"
            | "can_simulate_hub_disconnection"
            | "can_simulate_paid_subscription"
        )[];
        include_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection"
            | "can_unlock_with_code"
            | "can_run_thermostat_programs"
            | "can_program_thermostat_programs_as_weekday_weekend"
            | "can_program_thermostat_programs_as_different_each_day"
            | "can_program_thermostat_programs_as_same_each_day"
            | "can_simulate_hub_connection"
            | "can_simulate_hub_disconnection"
            | "can_simulate_paid_subscription"
        )[];
        limit?: number;
        manufacturer?: | "smartthings"
        | "nest"
        | "ecobee"
        | "honeywell_resideo"
        | "tado"
        | "sensi";
        page_cursor?: null
        | string;
        search?: string;
        space_id?: string;
        unstable_location_id?: null | string;
        user_identifier_key?: string;
    }

    • Optionalconnect_webview_id?: string

      ID of the Connect Webview for which you want to list devices.

    • Optionalconnected_account_id?: string

      ID of the connected account for which you want to list devices.

    • Optionalconnected_account_ids?: string[]

      Array of IDs of the connected accounts for which you want to list devices.

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned devices. Returns devices created before this timestamp.

    • Optionalcustom_metadata_has?: { [x: string]: string | boolean }

      Set of key:value custom metadata pairs for which you want to list devices.

    • Optionalcustomer_key?: string

      Customer key for which you want to list devices.

    • Optionaldevice_ids?: string[]

      Array of device IDs for which you want to list devices.

    • Optionaldevice_type?:
          | "ecobee_thermostat"
          | "nest_thermostat"
          | "honeywell_resideo_thermostat"
          | "tado_thermostat"
          | "sensi_thermostat"
          | "smartthings_thermostat"

      Device type by which you want to filter thermostat devices.

    • Optionaldevice_types?: (
          | "ecobee_thermostat"
          | "nest_thermostat"
          | "honeywell_resideo_thermostat"
          | "tado_thermostat"
          | "sensi_thermostat"
          | "smartthings_thermostat"
      )[]

      Array of device types by which you want to filter thermostat devices.

    • Optionalexclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription"
      )[]

    • Optionalinclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription"
      )[]

    • Optionallimit?: number

      Numerical limit on the number of devices to return.

    • Optionalmanufacturer?: "smartthings" | "nest" | "ecobee" | "honeywell_resideo" | "tado" | "sensi"

      Manufacturer by which you want to filter thermostat devices.

    • Optionalpage_cursor?: null | string

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalsearch?: string

      String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id, display_name, custom_metadata or location.location_name.

    • Optionalspace_id?: string

      ID of the space for which you want to list devices.

    • Optionalunstable_location_id?: null | string

      Deprecated

      Use space_id.

    • Optionaluser_identifier_key?: string

      Your own internal user ID for the user for which you want to list devices.
  • options: ThermostatsListOptions = {}

  Returns ThermostatsListRequest

off

• off(
      parameters?: { device_id: string; sync?: boolean },
      options?: ThermostatsOffOptions,
  ): ThermostatsOffRequest

  Parameters

  • Optionalparameters: { device_id: string; sync?: boolean }

    • device_id: string

      ID of the thermostat device that you want to set to off mode.

    • Optionalsync?: boolean
  • options: ThermostatsOffOptions = {}

  Returns ThermostatsOffRequest

setFallbackClimatePreset

• setFallbackClimatePreset(
      parameters?: { climate_preset_key: string; device_id: string },
      options?: ThermostatsSetFallbackClimatePresetOptions,
  ): ThermostatsSetFallbackClimatePresetRequest

  Parameters

  • Optionalparameters: { climate_preset_key: string; device_id: string }

    • climate_preset_key: string

      Climate preset key of the climate preset that you want to set as the fallback climate preset.

    • device_id: string

      ID of the thermostat device for which you want to set the fallback climate preset.
  • options: ThermostatsSetFallbackClimatePresetOptions = {}

  Returns ThermostatsSetFallbackClimatePresetRequest

setFanMode

• setFanMode(
      parameters?: {
          device_id: string;
          fan_mode?: "auto" | "on" | "circulate";
          fan_mode_setting?: "auto" | "on" | "circulate";
          sync?: boolean;
      },
      options?: ThermostatsSetFanModeOptions,
  ): ThermostatsSetFanModeRequest

  Parameters

  • Optionalparameters: {
        device_id: string;
        fan_mode?: "auto" | "on" | "circulate";
        fan_mode_setting?: "auto" | "on" | "circulate";
        sync?: boolean;
    }

    • device_id: string

      ID of the thermostat device for which you want to set the fan mode.

    • Optionalfan_mode?: "auto" | "on" | "circulate"

      Deprecated

      Use fan_mode_setting instead.

    • Optionalfan_mode_setting?: "auto" | "on" | "circulate"

      Fan mode setting that you want to set for the thermostat.

    • Optionalsync?: boolean
  • options: ThermostatsSetFanModeOptions = {}

  Returns ThermostatsSetFanModeRequest

setHvacMode

• setHvacMode(
      parameters?: ThermostatsSetHvacModeParameters,
      options?: ThermostatsSetHvacModeOptions,
  ): ThermostatsSetHvacModeRequest

  Parameters

  • Optionalparameters: ThermostatsSetHvacModeParameters
  • options: ThermostatsSetHvacModeOptions = {}

  Returns ThermostatsSetHvacModeRequest

setTemperatureThreshold

• setTemperatureThreshold(
      parameters?: {
          device_id: string;
          lower_limit_celsius?: null | number;
          lower_limit_fahrenheit?: null | number;
          upper_limit_celsius?: null | number;
          upper_limit_fahrenheit?: null | number;
      },
      options?: ThermostatsSetTemperatureThresholdOptions,
  ): ThermostatsSetTemperatureThresholdRequest

  Parameters

  • Optionalparameters: {
        device_id: string;
        lower_limit_celsius?: null | number;
        lower_limit_fahrenheit?: null | number;
        upper_limit_celsius?: null | number;
        upper_limit_fahrenheit?: null | number;
    }

    • device_id: string

      ID of the thermostat device for which you want to set a temperature threshold.

    • Optionallower_limit_celsius?: null | number

      Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either lower_limit but not both.

    • Optionallower_limit_fahrenheit?: null | number

      Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either lower_limit but not both.

    • Optionalupper_limit_celsius?: null | number

      Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either upper_limit but not both.

    • Optionalupper_limit_fahrenheit?: null | number

      Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either upper_limit but not both.
  • options: ThermostatsSetTemperatureThresholdOptions = {}

  Returns ThermostatsSetTemperatureThresholdRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

updateClimatePreset

• updateClimatePreset(
      parameters?: {
          climate_preset_key: string;
          climate_preset_mode?:
              | "home"
              | "away"
              | "wake"
              | "sleep"
              | "occupied"
              | "unoccupied";
          cooling_set_point_celsius?: number;
          cooling_set_point_fahrenheit?: number;
          device_id: string;
          ecobee_metadata?: {
              climate_ref: string;
              is_optimized: boolean;
              owner: "user"
              | "system";
          };
          fan_mode_setting?: "auto"
          | "on"
          | "circulate";
          heating_set_point_celsius?: number;
          heating_set_point_fahrenheit?: number;
          hvac_mode_setting?: "cool" | "heat" | "off" | "heat_cool" | "eco";
          manual_override_allowed?: boolean;
          name?: null | string;
      },
      options?: ThermostatsUpdateClimatePresetOptions,
  ): ThermostatsUpdateClimatePresetRequest

  Parameters

  • Optionalparameters: {
        climate_preset_key: string;
        climate_preset_mode?:
            | "home"
            | "away"
            | "wake"
            | "sleep"
            | "occupied"
            | "unoccupied";
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        device_id: string;
        ecobee_metadata?: {
            climate_ref: string;
            is_optimized: boolean;
            owner: "user"
            | "system";
        };
        fan_mode_setting?: "auto"
        | "on"
        | "circulate";
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "cool" | "heat" | "off" | "heat_cool" | "eco";
        manual_override_allowed?: boolean;
        name?: null | string;
    }

    • climate_preset_key: string

      Unique key to identify the climate preset.

    • Optionalclimate_preset_mode?: "home" | "away" | "wake" | "sleep" | "occupied" | "unoccupied"

      The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

    • Optionalcooling_set_point_celsius?: number

      Temperature to which the thermostat should cool (in °C). See also Set Points.

    • Optionalcooling_set_point_fahrenheit?: number

      Temperature to which the thermostat should cool (in °F). See also Set Points.

    • device_id: string

      ID of the thermostat device for which you want to update a climate preset.

    • Optionalecobee_metadata?: { climate_ref: string; is_optimized: boolean; owner: "user" | "system" }

      Metadata specific to the Ecobee climate, if applicable.

      • climate_ref: string

        Reference to the Ecobee climate, if applicable.

      • is_optimized: boolean

        Indicates if the climate preset is optimized by Ecobee.

      • owner: "user" | "system"

        Indicates whether the climate preset is owned by the user or the system.

    • Optionalfan_mode_setting?: "auto" | "on" | "circulate"

      Desired fan mode setting, such as on, auto, or circulate.

    • Optionalheating_set_point_celsius?: number

      Temperature to which the thermostat should heat (in °C). See also Set Points.

    • Optionalheating_set_point_fahrenheit?: number

      Temperature to which the thermostat should heat (in °F). See also Set Points.

    • Optionalhvac_mode_setting?: "cool" | "heat" | "off" | "heat_cool" | "eco"

      Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

    • Optionalmanual_override_allowed?: boolean

      Indicates whether a person at the thermostat can change the thermostat's settings. See Specifying Manual Override Permissions.

      Deprecated

      Use 'thermostat_schedule.is_override_allowed'

    • Optionalname?: null | string

      User-friendly name to identify the climate preset.
  • options: ThermostatsUpdateClimatePresetOptions = {}

  Returns ThermostatsUpdateClimatePresetRequest

updateWeeklyProgram

• updateWeeklyProgram(
      parameters?: {
          device_id: string;
          friday_program_id?: null | string;
          monday_program_id?: null | string;
          saturday_program_id?: null | string;
          sunday_program_id?: null | string;
          thursday_program_id?: null | string;
          tuesday_program_id?: null | string;
          wednesday_program_id?: null | string;
      },
      options?: ThermostatsUpdateWeeklyProgramOptions,
  ): ThermostatsUpdateWeeklyProgramRequest

  Parameters

  • Optionalparameters: {
        device_id: string;
        friday_program_id?: null | string;
        monday_program_id?: null | string;
        saturday_program_id?: null | string;
        sunday_program_id?: null | string;
        thursday_program_id?: null | string;
        tuesday_program_id?: null | string;
        wednesday_program_id?: null | string;
    }

    • device_id: string

      ID of the thermostat device for which you want to update the weekly program.

    • Optionalfriday_program_id?: null | string

      ID of the thermostat daily program to run on Fridays.

    • Optionalmonday_program_id?: null | string

      ID of the thermostat daily program to run on Mondays.

    • Optionalsaturday_program_id?: null | string

      ID of the thermostat daily program to run on Saturdays.

    • Optionalsunday_program_id?: null | string

      ID of the thermostat daily program to run on Sundays.

    • Optionalthursday_program_id?: null | string

      ID of the thermostat daily program to run on Thursdays.

    • Optionaltuesday_program_id?: null | string

      ID of the thermostat daily program to run on Tuesdays.

    • Optionalwednesday_program_id?: null | string

      ID of the thermostat daily program to run on Wednesdays.
  • options: ThermostatsUpdateWeeklyProgramOptions = {}

  Returns ThermostatsUpdateWeeklyProgramRequest

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpThermostats

  Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpThermostats

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpThermostats

  Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpThermostats

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpThermostats

  Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpThermostats

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpThermostats

  Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpThermostats

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpThermostats

  Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpThermostats

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpThermostats>

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpThermostats>