fix: Docs for thermostat.temperature_reached_set_point (#1446)

seamapi · Jan 9, 2025 · f3b2c56 · f3b2c56
1 parent 2061f35
commit f3b2c56
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 16 deletions.
diff --git a/src/lib/seam/connect/models/events/devices.ts b/src/lib/seam/connect/models/events/devices.ts
@@ -599,26 +599,31 @@ export const temperature_reached_set_point_event = device_event.extend({
   event_type: z.literal('thermostat.temperature_reached_set_point'),
   temperature_celsius: z
     .number()
-    .describe('Temperature, in °C, reported by the thermostat.'),
+    .describe(
+      'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
+    ),
   temperature_fahrenheit: z
     .number()
-    .describe('Temperature, in °F, reported by the thermostat.'),
+    .describe(
+      'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
+    ),
   desired_temperature_celsius: z
     .number()
     .optional()
     .describe(
-      "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
+      "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
     ),
   desired_temperature_fahrenheit: z
     .number()
     .optional()
     .describe(
-      "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
+      "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
     ),
 }).describe(`
   ---
   route_path: /thermostats
   ---
+  A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
 `)
 
 export type TemperatureReachedSetPointEvent = z.infer<

diff --git a/src/lib/seam/connect/openapi.ts b/src/lib/seam/connect/openapi.ts
@@ -10553,6 +10553,8 @@ export default {
             'x-route-path': '/thermostats',
           },
           {
+            description:
+              "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
             properties: {
               connected_account_id: {
                 description:
@@ -10567,13 +10569,13 @@ export default {
               },
               desired_temperature_celsius: {
                 description:
-                  "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
+                  "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
                 format: 'float',
                 type: 'number',
               },
               desired_temperature_fahrenheit: {
                 description:
-                  "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
+                  "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
                 format: 'float',
                 type: 'number',
               },
@@ -10597,12 +10599,14 @@ export default {
                 type: 'string',
               },
               temperature_celsius: {
-                description: 'Temperature, in °C, reported by the thermostat.',
+                description:
+                  'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
                 format: 'float',
                 type: 'number',
               },
               temperature_fahrenheit: {
-                description: 'Temperature, in °F, reported by the thermostat.',
+                description:
+                  'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
                 format: 'float',
                 type: 'number',
               },

diff --git a/src/lib/seam/connect/route-types.ts b/src/lib/seam/connect/route-types.ts
@@ -17371,13 +17371,13 @@ export interface Routes {
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
                 event_type: 'thermostat.temperature_reached_set_point'
-                /** Temperature, in °C, reported by the thermostat. */
+                /** Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
                 temperature_celsius: number
-                /** Temperature, in °F, reported by the thermostat. */
+                /** Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
                 temperature_fahrenheit: number
-                /** Desired temperature, in °C, set by the thermostat's cooling or heating set point. */
+                /** Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
                 desired_temperature_celsius?: number | undefined
-                /** Desired temperature, in °F, set by the thermostat's cooling or heating set point. */
+                /** Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
                 desired_temperature_fahrenheit?: number | undefined
               }
             | {
@@ -18804,13 +18804,13 @@ export interface Routes {
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
             event_type: 'thermostat.temperature_reached_set_point'
-            /** Temperature, in °C, reported by the thermostat. */
+            /** Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
             temperature_celsius: number
-            /** Temperature, in °F, reported by the thermostat. */
+            /** Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
             temperature_fahrenheit: number
-            /** Desired temperature, in °C, set by the thermostat's cooling or heating set point. */
+            /** Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
             desired_temperature_celsius?: number | undefined
-            /** Desired temperature, in °F, set by the thermostat's cooling or heating set point. */
+            /** Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
             desired_temperature_fahrenheit?: number | undefined
           }
         | {