Class SeamHttpThermostats

constructor

• new SeamHttpThermostats(apiKeyOrOptions?): SeamHttpThermostats

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpThermostats

client

climateSettingSchedules

• get climateSettingSchedules(): SeamHttpThermostatsClimateSettingSchedules

• Returns SeamHttpThermostatsClimateSettingSchedules

cool

• cool(body): Promise<void>

• Parameters

  • 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

• get(body): 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: Object;
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }>

• Parameters

  • 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: Object;
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }>

heat

• heat(body): Promise<void>

• Parameters

  • 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

• heatCool(body): Promise<void>

• Parameters

  • 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

• list(body): 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: Object;
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

• Parameters

  • body: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: string;
        device_ids?: string[];
        device_type?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "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

    • Optional connected_account_ids?: string[]

    • Optional created_before?: string

    • 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: Object;
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

off

• off(body): Promise<void>

• Parameters

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

    • device_id: string

    • Optional sync?: boolean

  Returns Promise<void>

setFanMode

• setFanMode(body): Promise<void>

• Parameters

  • 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

• update(body): Promise<void>

• Parameters

  • 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

• fromApiKey(apiKey, options?): SeamHttpThermostats

• Parameters

  • apiKey: string

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

  Returns SeamHttpThermostats

Static fromClient

• fromClient(client, options?): SeamHttpThermostats

• Parameters

  • client: AxiosInstance

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

  Returns SeamHttpThermostats

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpThermostats

• Parameters

  • clientSessionToken: string

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

  Returns SeamHttpThermostats

Static fromPublishableKey

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

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpThermostats>