@seamapi/types 1.291.0 → 1.292.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.291.0",
+  "version": "1.292.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/thermostats/climate-preset.ts

@@ -3,18 +3,55 @@ import { z } from 'zod'
 import { fan_mode_setting, hvac_mode_setting } from './modes.js'
 
 export const climate_preset = z.object({
-  climate_preset_key: z.string(),
-  can_edit: z.boolean(),
-  can_delete: z.boolean(),
-  name: z.string().nullable().default(null).optional(),
-  display_name: z.string(),
-  fan_mode_setting: fan_mode_setting.optional(),
-  hvac_mode_setting: hvac_mode_setting.optional(),
-  cooling_set_point_celsius: z.number().optional(),
-  heating_set_point_celsius: z.number().optional(),
-  cooling_set_point_fahrenheit: z.number().optional(),
-  heating_set_point_fahrenheit: z.number().optional(),
-  manual_override_allowed: z.boolean(),
+  climate_preset_key: z
+    .string()
+    .describe('Unique key to identify the climate preset.'),
+  can_edit: z
+    .boolean()
+    .describe('Indicates whether this climate preset key can be edited.'),
+  can_delete: z
+    .boolean()
+    .describe('Indicates whether this climate preset key can be deleted.'),
+  name: z
+    .string()
+    .nullable()
+    .default(null)
+    .optional()
+    .describe('User-friendly name to identify the climate preset.'),
+  display_name: z.string().describe('Display name for the climate preset.'),
+  fan_mode_setting: fan_mode_setting
+    .optional()
+    .describe(
+      'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
+    ),
+  hvac_mode_setting: hvac_mode_setting
+    .optional()
+    .describe(
+      'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.',
+    ),
+  cooling_set_point_celsius: z
+    .number()
+    .optional()
+    .describe(
+      'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
+  heating_set_point_celsius: z
+    .number()
+    .optional()
+    .describe('Temperature to which the thermostat should heat (in °C).'),
+  cooling_set_point_fahrenheit: z
+    .number()
+    .optional()
+    .describe('Temperature to which the thermostat should cool (in °F).'),
+  heating_set_point_fahrenheit: z
+    .number()
+    .optional()
+    .describe('Temperature to which the thermostat should heat (in °F).'),
+  manual_override_allowed: z
+    .boolean()
+    .describe(
+      "Indicates whether a person at the thermostat can change the thermostat's settings.",
+    ),
 })
 
 export type ClimatePreset = z.infer<typeof climate_preset>

package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts

@@ -1,18 +1,47 @@
 import { z } from 'zod'
 
 export const thermostat_schedule = z.object({
-  thermostat_schedule_id: z.string().uuid(),
-  device_id: z.string().uuid(),
-  name: z.string().optional(),
-  climate_preset_key: z.string(),
-  max_override_period_minutes: z.number().int().nonnegative(),
-  starts_at: z.string().datetime(),
-  ends_at: z.string().datetime(),
-  created_at: z.string().datetime(),
+  thermostat_schedule_id: z
+    .string()
+    .uuid()
+    .describe('ID of the climate schedule.'),
+  device_id: z.string().uuid().describe('ID of the desired thermostat device.'),
+  name: z
+    .string()
+    .optional()
+    .describe('User-friendly name to identify the climate schedule.'),
+  climate_preset_key: z
+    .string()
+    .describe(
+      'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
+    ),
+  max_override_period_minutes: z
+    .number()
+    .int()
+    .nonnegative()
+    .describe(
+      "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](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions).",
+    ),
+  starts_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+    ),
+  ends_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the climate schedule was created.'),
   errors: z
     .any()
     .describe(
-      'Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
+      'Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
     ),
 })