@seamapi/http - v2.0.0
    Preparing search index...

    Type Alias ThermostatSchedule

    Represents a thermostat schedule that activates a configured climate preset on a thermostat at a specified starting time and deactivates the climate preset at a specified ending time.

    type ThermostatSchedule = {
        climate_preset_key: string;
        created_at: string;
        device_id: string;
        ends_at: string;
        errors: { created_at: string; error_code: string; message: string }[];
        is_override_allowed?: boolean;
        max_override_period_minutes?: number | null;
        name: string | null;
        starts_at: string;
        thermostat_schedule_id: string;
        workspace_id: string;
    }
    Index
    climate_preset_key created_at device_id ends_at errors is_override_allowed? max_override_period_minutes? name starts_at thermostat_schedule_id workspace_id
    climate_preset_key: string

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

    created_at: string

    Date and time at which the thermostat schedule was created.

    device_id: string

    ID of the desired thermostat device.

    ends_at: string

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

    errors: { created_at: string; error_code: string; message: string }[]

    Errors associated with the thermostat schedule.

    Type Declaration

    • created_at: string

      Date and time at which Seam created the error.

    • error_code: string

      Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

    • message: string

      Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

    is_override_allowed?: boolean

    Indicates whether a person at the thermostat can change the thermostat's settings after the thermostat schedule starts.

    max_override_period_minutes?: number | null

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

    name: string | null

    User-friendly name to identify the thermostat schedule.

    starts_at: string

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

    thermostat_schedule_id: string

    ID of the thermostat schedule.

    workspace_id: string

    ID of the workspace that contains the thermostat schedule.

    Settings
    Member Visibility

    On This Page
    Properties