Class SeamHttpThermostatsSchedules

constructor

• new SeamHttpThermostatsSchedules(apiKeyOrOptions?): SeamHttpThermostatsSchedules

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpThermostatsSchedules

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(parameters?, options?): ThermostatsSchedulesCreateRequest

• Parameters

  • Optionalparameters: {
        climate_preset_key: string;
        device_id: string;
        ends_at: string;
        is_override_allowed?: boolean;
        max_override_period_minutes?: null | number;
        name?: string;
        starts_at: string;
    }

    • climate_preset_key: string

      Key of the climate preset to use for the new thermostat schedule.

    • device_id: string

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

    • ends_at: string

      Date and time at which the new thermostat schedule ends, in ISO 8601 format.

    • Optionalis_override_allowed?: boolean

      Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also Specifying Manual Override Permissions.

    • Optionalmax_override_period_minutes?: null | number

      Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also Specifying Manual Override Permissions.

    • Optionalname?: string

      Name of the thermostat schedule.

    • starts_at: string

      Date and time at which the new thermostat schedule starts, in ISO 8601 format.
  • options: ThermostatsSchedulesCreateOptions = {}

  Returns ThermostatsSchedulesCreateRequest

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?): ThermostatsSchedulesDeleteRequest

• Parameters

  • Optionalparameters: {
        thermostat_schedule_id: string;
    }

    • thermostat_schedule_id: string

      ID of the thermostat schedule that you want to delete.
  • options: ThermostatsSchedulesDeleteOptions = {}

  Returns ThermostatsSchedulesDeleteRequest

get

• get(parameters?, options?): ThermostatsSchedulesGetRequest

• Parameters

  • Optionalparameters: {
        thermostat_schedule_id: string;
    }

    • thermostat_schedule_id: string

      ID of the thermostat schedule that you want to get.
  • options: ThermostatsSchedulesGetOptions = {}

  Returns ThermostatsSchedulesGetRequest

list

• list(parameters?, options?): ThermostatsSchedulesListRequest

• Parameters

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

    • device_id: string

      ID of the thermostat device for which you want to list schedules.

    • Optionaluser_identifier_key?: string

      User identifier key by which to filter the list of returned thermostat schedules.
  • options: ThermostatsSchedulesListOptions = {}

  Returns ThermostatsSchedulesListRequest

update

• update(parameters?, options?): ThermostatsSchedulesUpdateRequest

• Parameters

  • Optionalparameters: {
        climate_preset_key?: string;
        ends_at?: string;
        is_override_allowed?: boolean;
        max_override_period_minutes?: null | number;
        name?: string;
        starts_at?: string;
        thermostat_schedule_id: string;
    }

    • Optionalclimate_preset_key?: string

      Key of the climate preset to use for the thermostat schedule.

    • Optionalends_at?: string

      Date and time at which the thermostat schedule ends, in ISO 8601 format.

    • Optionalis_override_allowed?: boolean

      Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also Specifying Manual Override Permissions.

    • Optionalmax_override_period_minutes?: null | number

      Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also Specifying Manual Override Permissions.

    • Optionalname?: string

      Name of the thermostat schedule.

    • Optionalstarts_at?: string

      Date and time at which the thermostat schedule starts, in ISO 8601 format.

    • thermostat_schedule_id: string

      ID of the thermostat schedule that you want to update.
  • options: ThermostatsSchedulesUpdateOptions = {}

  Returns ThermostatsSchedulesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpThermostatsSchedules

• Parameters

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

  Returns SeamHttpThermostatsSchedules

StaticfromClient

• fromClient(client, options?): SeamHttpThermostatsSchedules

• Parameters

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

  Returns SeamHttpThermostatsSchedules

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpThermostatsSchedules

• Parameters

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

  Returns SeamHttpThermostatsSchedules

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpThermostatsSchedules

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpThermostatsSchedules

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpThermostatsSchedules>