Class SeamHttpThermostatsClimateSettingSchedules

constructor

• new SeamHttpThermostatsClimateSettingSchedules(apiKeyOrOptions?): SeamHttpThermostatsClimateSettingSchedules

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpThermostatsClimateSettingSchedules

client

Readonly defaults

create

• create(body?): Promise<{
      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";
  }>

• Parameters

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

  Returns Promise<{
      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";
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        climate_setting_schedule_id: string;
    }

    • climate_setting_schedule_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      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";
  }>

• Parameters

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

    • Optional climate_setting_schedule_id?: string

    • Optional device_id?: string

  Returns Promise<{
      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";
  }>

list

• list(body?): Promise<{
      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";
  }[]>

• Parameters

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

    • device_id: string

    • Optional user_identifier_key?: string

  Returns Promise<{
      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";
  }[]>

update

• update(body?): Promise<void>

• Parameters

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

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpThermostatsClimateSettingSchedules

• Parameters

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

  Returns SeamHttpThermostatsClimateSettingSchedules

Static fromClient

• fromClient(client, options?): SeamHttpThermostatsClimateSettingSchedules

• Parameters

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

  Returns SeamHttpThermostatsClimateSettingSchedules

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpThermostatsClimateSettingSchedules

• Parameters

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

  Returns SeamHttpThermostatsClimateSettingSchedules

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpThermostatsClimateSettingSchedules

• Parameters

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

  Returns SeamHttpThermostatsClimateSettingSchedules

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpThermostatsClimateSettingSchedules

• Parameters

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

  Returns SeamHttpThermostatsClimateSettingSchedules

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpThermostatsClimateSettingSchedules>