Class SeamHttpThermostatsDailyPrograms

constructor

• new SeamHttpThermostatsDailyPrograms(apiKeyOrOptions?): SeamHttpThermostatsDailyPrograms

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpThermostatsDailyPrograms

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(parameters?, options?): ThermostatsDailyProgramsCreateRequest

• Parameters

  • Optionalparameters: {
        device_id: string;
        name: string;
        periods: {
            climate_preset_key: string;
            starts_at_time: string;
        }[];
    }

    • device_id: string

      ID of the thermostat device for which you want to create a daily program.

    • name: string

      Name of the thermostat daily program.

    • periods: {
          climate_preset_key: string;
          starts_at_time: string;
      }[]

      Array of thermostat daily program periods.
  • options: ThermostatsDailyProgramsCreateOptions = {}

  Returns ThermostatsDailyProgramsCreateRequest

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(parameters?, options?): ThermostatsDailyProgramsDeleteRequest

• Parameters

  • Optionalparameters: {
        thermostat_daily_program_id: string;
    }

    • thermostat_daily_program_id: string

      ID of the thermostat daily program that you want to delete.
  • options: ThermostatsDailyProgramsDeleteOptions = {}

  Returns ThermostatsDailyProgramsDeleteRequest

update

• update(parameters?, options?): ThermostatsDailyProgramsUpdateRequest

• Parameters

  • Optionalparameters: {
        name: string;
        periods: {
            climate_preset_key: string;
            starts_at_time: string;
        }[];
        thermostat_daily_program_id: string;
    }

    • name: string

      Name of the thermostat daily program that you want to update.

    • periods: {
          climate_preset_key: string;
          starts_at_time: string;
      }[]

      Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.

    • thermostat_daily_program_id: string

      ID of the thermostat daily program that you want to update.
  • options: ThermostatsDailyProgramsUpdateOptions = {}

  Returns ThermostatsDailyProgramsUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpThermostatsDailyPrograms

• Parameters

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

  Returns SeamHttpThermostatsDailyPrograms

StaticfromClient

• fromClient(client, options?): SeamHttpThermostatsDailyPrograms

• Parameters

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

  Returns SeamHttpThermostatsDailyPrograms

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpThermostatsDailyPrograms

• Parameters

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

  Returns SeamHttpThermostatsDailyPrograms

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpThermostatsDailyPrograms

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpThermostatsDailyPrograms

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpThermostatsDailyPrograms>