/*
 * Automatically generated by codegen/smith.ts.
 * Do not edit this file.
 */

/**
 * Represents a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
 */
export type ThermostatSchedule = {
  /**
   * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
   */
  climate_preset_key: string

  /**
   * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
   */
  created_at: string

  /**
   * ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device.
   */
  device_id: string

  /**
   * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
   */
  ends_at: string

  /**
   * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
   */
  errors: Array<{
    /**
     * Date and time at which Seam created the error.
     */
    created_at: string

    /**
     * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
     */
    error_code: string

    /**
     * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
     */
    message: string
  }>

  /**
   * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
   */
  is_override_allowed?: boolean | undefined
  /**
   * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
   */
  max_override_period_minutes?: number | null | undefined
  /**
   * User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
   */
  name: string | null
  /**
   * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
   */
  starts_at: string

  /**
   * ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
   */
  thermostat_schedule_id: string

  /**
   * ID of the workspace that contains the thermostat schedule.
   */
  workspace_id: string
}