@seamapi/types 1.359.0 → 1.360.1

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

@@ -5,24 +5,36 @@ import { fan_mode_setting, hvac_mode_setting } from './modes.js'
 export const climate_preset = z.object({
   climate_preset_key: z
     .string()
-    .describe('Unique key to identify the climate preset.'),
+    .describe(
+      'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
   can_edit: z
     .boolean()
-    .describe('Indicates whether this climate preset key can be edited.'),
+    .describe(
+      'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
+    ),
   can_delete: z
     .boolean()
-    .describe('Indicates whether this climate preset key can be deleted.'),
+    .describe(
+      'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) 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.'),
+    .describe(
+      'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
+  display_name: z
+    .string()
+    .describe(
+      'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
   fan_mode_setting: fan_mode_setting
     .optional()
     .describe(
-      'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
+      'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
     ),
   hvac_mode_setting: hvac_mode_setting
     .optional()
@@ -38,21 +50,27 @@ export const climate_preset = z.object({
   heating_set_point_celsius: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should heat (in °C).'),
+    .describe(
+      'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   cooling_set_point_fahrenheit: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should cool (in °F).'),
+    .describe(
+      'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   heating_set_point_fahrenheit: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should heat (in °F).'),
+    .describe(
+      'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   manual_override_allowed: z.boolean().describe(
     `
       ---
       deprecated: Use 'thermostat_schedule.is_override_allowed'
       ---
-      Indicates whether a person at the thermostat can change the thermostat's settings.`,
+      Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).`,
   ),
 })
 

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

@@ -4,29 +4,38 @@ export const thermostat_schedule = z.object({
   thermostat_schedule_id: z
     .string()
     .uuid()
-    .describe('ID of the thermostat schedule.'),
-  device_id: z.string().uuid().describe('ID of the desired thermostat device.'),
+    .describe(
+      'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
+    ),
+  device_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.',
+    ),
   name: z
     .string()
     .optional()
-    .describe('User-friendly name to identify the thermostat schedule.'),
+    .describe(
+      'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
+    ),
   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 thermostat schedule.',
+      'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
     ),
   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-thermostat-schedules#specifying-manual-override-permissions).",
+      "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/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
     ),
   starts_at: z
     .string()
     .datetime()
     .describe(
-      'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+      'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
     ),
   unstable_is_override_allowed: z
     .boolean()
@@ -36,27 +45,37 @@ export const thermostat_schedule = z.object({
         ---
         undocumented: Unstable
         ---
-        Indicates whether a person at the thermostat can change the thermostat's settings.`,
+        Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.`,
     ),
   ends_at: z
     .string()
     .datetime()
     .describe(
-      'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+      'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) 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 thermostat schedule was created.'),
+    .describe(
+      'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.',
+    ),
   errors: z
     .array(
       z.object({
-        error_code: z.string(),
-        message: z.string(),
+        error_code: z
+          .string()
+          .describe(
+            'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+          ),
+        message: z
+          .string()
+          .describe(
+            'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+          ),
       }),
     )
     .describe(
-      'Array of errors associated with the thermostat 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.',
+      'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
     ),
 }).describe(`
   ---