Class SeamHttpThermostats

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpThermostats

client

Readonlydefaults

dailyPrograms

• get dailyPrograms(): SeamHttpThermostatsDailyPrograms

  Client for the Seam API /thermostats/daily_programs routes.

  Returns SeamHttpThermostatsDailyPrograms

schedules

• get schedules(): SeamHttpThermostatsSchedules

  Client for the Seam API /thermostats/schedules routes.

  Returns SeamHttpThermostatsSchedules

simulate

• get simulate(): SeamHttpThermostatsSimulate

  Client for the Seam API /thermostats/simulate routes.

  Returns SeamHttpThermostatsSimulate

activateClimatePreset

• activateClimatePreset(
      parameters: ThermostatsActivateClimatePresetParameters,
      options?: ThermostatsActivateClimatePresetOptions,
  ): ThermostatsActivateClimatePresetRequest

  Activates a specified climate preset for a specified thermostat.

  Parameters

  • parameters: ThermostatsActivateClimatePresetParameters
  • options: ThermostatsActivateClimatePresetOptions = {}

  Returns ThermostatsActivateClimatePresetRequest

cool

• cool(
      parameters: ThermostatsCoolParameters,
      options?: ThermostatsCoolOptions,
  ): ThermostatsCoolRequest

  Sets a specified thermostat to cool mode.

  Parameters

  • parameters: ThermostatsCoolParameters
  • options: ThermostatsCoolOptions = {}

  Returns ThermostatsCoolRequest

createClimatePreset

• createClimatePreset(
      parameters: ThermostatsCreateClimatePresetParameters,
      options?: ThermostatsCreateClimatePresetOptions,
  ): ThermostatsCreateClimatePresetRequest

  Creates a climate preset for a specified thermostat.

  Parameters

  • parameters: ThermostatsCreateClimatePresetParameters
  • options: ThermostatsCreateClimatePresetOptions = {}

  Returns ThermostatsCreateClimatePresetRequest

createPaginator

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

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

deleteClimatePreset

• deleteClimatePreset(
      parameters: ThermostatsDeleteClimatePresetParameters,
      options?: ThermostatsDeleteClimatePresetOptions,
  ): ThermostatsDeleteClimatePresetRequest

  Deletes a specified climate preset for a specified thermostat.

  Parameters

  • parameters: ThermostatsDeleteClimatePresetParameters
  • options: ThermostatsDeleteClimatePresetOptions = {}

  Returns ThermostatsDeleteClimatePresetRequest

heat

• heat(
      parameters: ThermostatsHeatParameters,
      options?: ThermostatsHeatOptions,
  ): ThermostatsHeatRequest

  Sets a specified thermostat to heat mode.

  Parameters

  • parameters: ThermostatsHeatParameters
  • options: ThermostatsHeatOptions = {}

  Returns ThermostatsHeatRequest

heatCool

• heatCool(
      parameters: ThermostatsHeatCoolParameters,
      options?: ThermostatsHeatCoolOptions,
  ): ThermostatsHeatCoolRequest

  Sets a specified thermostat to heat-cool ("auto") mode.

  Parameters

  • parameters: ThermostatsHeatCoolParameters
  • options: ThermostatsHeatCoolOptions = {}

  Returns ThermostatsHeatCoolRequest

list

• list(
      parameters?: ThermostatsListParameters,
      options?: ThermostatsListOptions,
  ): ThermostatsListRequest

  Returns a list of all thermostats.

  Parameters

  • Optionalparameters: ThermostatsListParameters
  • options: ThermostatsListOptions = {}

  Returns ThermostatsListRequest

off

• off(
      parameters: ThermostatsOffParameters,
      options?: ThermostatsOffOptions,
  ): ThermostatsOffRequest

  Sets a specified thermostat to "off" mode.

  Parameters

  • parameters: ThermostatsOffParameters
  • options: ThermostatsOffOptions = {}

  Returns ThermostatsOffRequest

setFallbackClimatePreset

• setFallbackClimatePreset(
      parameters: ThermostatsSetFallbackClimatePresetParameters,
      options?: ThermostatsSetFallbackClimatePresetOptions,
  ): ThermostatsSetFallbackClimatePresetRequest

  Sets a specified climate preset as the "fallback" preset for a specified thermostat.

  Parameters

  • parameters: ThermostatsSetFallbackClimatePresetParameters
  • options: ThermostatsSetFallbackClimatePresetOptions = {}

  Returns ThermostatsSetFallbackClimatePresetRequest

setFanMode

• setFanMode(
      parameters: ThermostatsSetFanModeParameters,
      options?: ThermostatsSetFanModeOptions,
  ): ThermostatsSetFanModeRequest

  Sets the fan mode setting for a specified thermostat.

  Parameters

  • parameters: ThermostatsSetFanModeParameters
  • options: ThermostatsSetFanModeOptions = {}

  Returns ThermostatsSetFanModeRequest

setHvacMode

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

  Sets the HVAC mode for a specified thermostat.

  Parameters

  • parameters: ThermostatsSetHvacModeParameters
  • options: ThermostatsSetHvacModeOptions = {}

  Returns ThermostatsSetHvacModeRequest

setTemperatureThreshold

• setTemperatureThreshold(
      parameters: ThermostatsSetTemperatureThresholdParameters,
      options?: ThermostatsSetTemperatureThresholdOptions,
  ): ThermostatsSetTemperatureThresholdRequest

  Sets a temperature threshold for a specified thermostat. Seam emits a thermostat.temperature_threshold_exceeded event and adds a warning on a thermostat if it reports a temperature outside the threshold range.

  Parameters

  • parameters: ThermostatsSetTemperatureThresholdParameters
  • options: ThermostatsSetTemperatureThresholdOptions = {}

  Returns ThermostatsSetTemperatureThresholdRequest

updateClientSessionToken

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

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

updateClimatePreset

• updateClimatePreset(
      parameters: ThermostatsUpdateClimatePresetParameters,
      options?: ThermostatsUpdateClimatePresetOptions,
  ): ThermostatsUpdateClimatePresetRequest

  Updates a specified climate preset for a specified thermostat.

  Parameters

  • parameters: ThermostatsUpdateClimatePresetParameters
  • options: ThermostatsUpdateClimatePresetOptions = {}

  Returns ThermostatsUpdateClimatePresetRequest

updateWeeklyProgram

• updateWeeklyProgram(
      parameters: ThermostatsUpdateWeeklyProgramParameters,
      options?: ThermostatsUpdateWeeklyProgramOptions,
  ): ThermostatsUpdateWeeklyProgramRequest

  Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.

  Parameters

  • parameters: ThermostatsUpdateWeeklyProgramParameters
  • options: ThermostatsUpdateWeeklyProgramOptions = {}

  Returns ThermostatsUpdateWeeklyProgramRequest

StaticfromApiKey

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

  Creates a new SeamHttpThermostats authenticated with an API key.

  Parameters

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

  Returns SeamHttpThermostats

StaticfromClient

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

  Creates a new SeamHttpThermostats from an existing HTTP client.

  Parameters

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

  Returns SeamHttpThermostats

StaticfromClientSessionToken

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

  Creates a new SeamHttpThermostats authenticated with a client session token.

  Parameters

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

  Returns SeamHttpThermostats

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpThermostats authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpThermostats

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpThermostats authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpThermostats

StaticfromPublishableKey

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

  Creates a new SeamHttpThermostats authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpThermostats>