@seamapi/types 1.288.1 → 1.289.0

package/lib/seam/connect/route-types.d.ts

@@ -3688,11 +3688,11 @@ export interface Routes {
                     door_name: string;
                     locked_state: string;
                     lock_type: string;
-                    online: boolean;
+                    online?: boolean | undefined;
                     battery_level: string;
-                    left_open_alarm: boolean;
-                    intrusion_alarm: boolean;
-                    privacy_mode: boolean;
+                    left_open_alarm?: boolean | undefined;
+                    intrusion_alarm?: boolean | undefined;
+                    privacy_mode?: boolean | undefined;
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
@@ -4341,11 +4341,11 @@ export interface Routes {
                     door_name: string;
                     locked_state: string;
                     lock_type: string;
-                    online: boolean;
+                    online?: boolean | undefined;
                     battery_level: string;
-                    left_open_alarm: boolean;
-                    intrusion_alarm: boolean;
-                    privacy_mode: boolean;
+                    left_open_alarm?: boolean | undefined;
+                    intrusion_alarm?: boolean | undefined;
+                    privacy_mode?: boolean | undefined;
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
@@ -6658,11 +6658,11 @@ export interface Routes {
                     door_name: string;
                     locked_state: string;
                     lock_type: string;
-                    online: boolean;
+                    online?: boolean | undefined;
                     battery_level: string;
-                    left_open_alarm: boolean;
-                    intrusion_alarm: boolean;
-                    privacy_mode: boolean;
+                    left_open_alarm?: boolean | undefined;
+                    intrusion_alarm?: boolean | undefined;
+                    privacy_mode?: boolean | undefined;
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
@@ -6731,11 +6731,11 @@ export interface Routes {
                     door_name: string;
                     locked_state: string;
                     lock_type: string;
-                    online: boolean;
+                    online?: boolean | undefined;
                     battery_level: string;
-                    left_open_alarm: boolean;
-                    intrusion_alarm: boolean;
-                    privacy_mode: boolean;
+                    left_open_alarm?: boolean | undefined;
+                    intrusion_alarm?: boolean | undefined;
+                    privacy_mode?: boolean | undefined;
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
@@ -7540,11 +7540,11 @@ export interface Routes {
                     door_name: string;
                     locked_state: string;
                     lock_type: string;
-                    online: boolean;
+                    online?: boolean | undefined;
                     battery_level: string;
-                    left_open_alarm: boolean;
-                    intrusion_alarm: boolean;
-                    privacy_mode: boolean;
+                    left_open_alarm?: boolean | undefined;
+                    intrusion_alarm?: boolean | undefined;
+                    privacy_mode?: boolean | undefined;
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
@@ -18636,8 +18636,11 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the thermostat device. */
             device_id: string;
+            /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_celsius?: number | undefined;
+            /** Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_fahrenheit?: number | undefined;
             sync?: boolean;
         };
@@ -19404,7 +19407,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the thermostat device. */
             device_id?: string | undefined;
+            /** Name of the thermostat. */
             name?: string | undefined;
         };
         formData: {};
@@ -19879,8 +19884,11 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the thermostat device. */
             device_id: string;
+            /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
             heating_set_point_celsius?: number | undefined;
+            /** Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters. */
             heating_set_point_fahrenheit?: number | undefined;
             sync?: boolean;
         };
@@ -20614,10 +20622,15 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the thermostat device. */
             device_id: string;
+            /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
             heating_set_point_celsius?: number | undefined;
+            /** Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters. */
             heating_set_point_fahrenheit?: number | undefined;
+            /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_celsius?: number | undefined;
+            /** Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters. */
             cooling_set_point_fahrenheit?: number | undefined;
             sync?: boolean;
         };
@@ -22302,6 +22315,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the thermostat device. */
             device_id: string;
             sync?: boolean;
         };
@@ -23152,10 +23166,12 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the thermostat device. */
             device_id: string;
             /**
-             * @deprecated use fan_mode_setting instead. */
+             * @deprecated Use `fan_mode_setting` instead. */
             fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
+            /** Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings). */
             fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
             sync?: boolean;
         };

package/package.json

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

package/src/lib/seam/connect/models/acs/metadata/salto.ts

@@ -4,11 +4,11 @@ export const acs_entrance_salto_ks_metadata = z.object({
   door_name: z.string(),
   locked_state: z.string(),
   lock_type: z.string(),
-  online: z.boolean(),
+  online: z.boolean().optional(),
   battery_level: z.string(),
-  left_open_alarm: z.boolean(),
-  intrusion_alarm: z.boolean(),
-  privacy_mode: z.boolean(),
+  left_open_alarm: z.boolean().optional(),
+  intrusion_alarm: z.boolean().optional(),
+  privacy_mode: z.boolean().optional(),
 })
 
 export type AcsEntranceSaltoKSMetadata = z.infer<

package/src/lib/seam/connect/openapi.ts

@@ -548,11 +548,7 @@ export default {
               'door_name',
               'locked_state',
               'lock_type',
-              'online',
               'battery_level',
-              'left_open_alarm',
-              'intrusion_alarm',
-              'privacy_mode',
             ],
             type: 'object',
           },
@@ -15335,6 +15331,8 @@ export default {
     },
     '/thermostats/cool': {
       post: {
+        description:
+          'Sets a thermostat to cooling mode. You must include a cooling set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
         operationId: 'thermostatsCoolPost',
         requestBody: {
           content: {
@@ -15342,14 +15340,22 @@ export default {
               schema: {
                 properties: {
                   cooling_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   cooling_set_point_fahrenheit: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   sync: { default: false, type: 'boolean' },
                 },
                 required: ['device_id'],
@@ -15391,6 +15397,7 @@ export default {
         'x-fern-sdk-method-name': 'cool',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Cool Mode',
       },
     },
     '/thermostats/create_climate_preset': {
@@ -15515,14 +15522,22 @@ export default {
     },
     '/thermostats/get': {
       post: {
+        description: 'Returns a specific thermostat.',
         operationId: 'thermostatsGetPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
-                  name: { type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  name: {
+                    description: 'Name of the thermostat.',
+                    type: 'string',
+                  },
                 },
                 type: 'object',
               },
@@ -15561,22 +15576,33 @@ export default {
         'x-fern-sdk-method-name': 'get',
         'x-fern-sdk-return-value': 'thermostat',
         'x-response-key': 'thermostat',
+        'x-title': 'Get a Thermostat',
       },
     },
     '/thermostats/heat': {
       post: {
+        description:
+          'Sets a thermostat to heating mode. You must include a heating set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
         operationId: 'thermostatsHeatPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   heating_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   heating_set_point_fahrenheit: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
@@ -15621,10 +15647,13 @@ export default {
         'x-fern-sdk-method-name': 'heat',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Heat Mode',
       },
     },
     '/thermostats/heat_cool': {
       post: {
+        description:
+          'Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).',
         operationId: 'thermostatsHeatCoolPost',
         requestBody: {
           content: {
@@ -15632,19 +15661,31 @@ export default {
               schema: {
                 properties: {
                   cooling_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   cooling_set_point_fahrenheit: {
+                    description:
+                      'Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.',
                     format: 'float',
                     type: 'number',
                   },
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   heating_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   heating_set_point_fahrenheit: {
+                    description:
+                      'Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters.',
                     format: 'float',
                     type: 'number',
                   },
@@ -15689,10 +15730,13 @@ export default {
         'x-fern-sdk-method-name': 'heat_cool',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Heat-Cool (Auto) Mode',
       },
     },
     '/thermostats/list': {
       post: {
+        description:
+          'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
         operationId: 'thermostatsListPost',
         requestBody: {
           content: {
@@ -15963,17 +16007,24 @@ export default {
         'x-fern-sdk-method-name': 'list',
         'x-fern-sdk-return-value': 'devices',
         'x-response-key': 'devices',
+        'x-title': 'List Thermostats',
       },
     },
     '/thermostats/off': {
       post: {
+        description:
+          'Sets a thermostat to "off" mode. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
         operationId: 'thermostatsOffPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   sync: { default: false, type: 'boolean' },
                 },
                 required: ['device_id'],
@@ -16015,6 +16066,7 @@ export default {
         'x-fern-sdk-method-name': 'off',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Off Mode',
       },
     },
     '/thermostats/schedules/create': {
@@ -16377,20 +16429,28 @@ export default {
     },
     '/thermostats/set_fan_mode': {
       post: {
+        description:
+          'Sets the fan mode setting for a thermostat. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) and [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
         operationId: 'thermostatsSetFanModePost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   fan_mode: {
                     deprecated: true,
                     enum: ['auto', 'on', 'circulate'],
                     type: 'string',
-                    'x-deprecated': 'use fan_mode_setting instead.',
+                    'x-deprecated': 'Use `fan_mode_setting` instead.',
                   },
                   fan_mode_setting: {
+                    description:
+                      'Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
                     enum: ['auto', 'on', 'circulate'],
                     type: 'string',
                   },
@@ -16435,6 +16495,7 @@ export default {
         'x-fern-sdk-method-name': 'set_fan_mode',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set Fan Mode Setting',
       },
     },
     '/thermostats/set_temperature_threshold': {

package/src/lib/seam/connect/route-types.ts

@@ -4252,11 +4252,11 @@ export interface Routes {
               door_name: string
               locked_state: string
               lock_type: string
-              online: boolean
+              online?: boolean | undefined
               battery_level: string
-              left_open_alarm: boolean
-              intrusion_alarm: boolean
-              privacy_mode: boolean
+              left_open_alarm?: boolean | undefined
+              intrusion_alarm?: boolean | undefined
+              privacy_mode?: boolean | undefined
             }
           | undefined
         dormakaba_community_metadata?:
@@ -5013,11 +5013,11 @@ export interface Routes {
               door_name: string
               locked_state: string
               lock_type: string
-              online: boolean
+              online?: boolean | undefined
               battery_level: string
-              left_open_alarm: boolean
-              intrusion_alarm: boolean
-              privacy_mode: boolean
+              left_open_alarm?: boolean | undefined
+              intrusion_alarm?: boolean | undefined
+              privacy_mode?: boolean | undefined
             }
           | undefined
         dormakaba_community_metadata?:
@@ -7833,11 +7833,11 @@ export interface Routes {
               door_name: string
               locked_state: string
               lock_type: string
-              online: boolean
+              online?: boolean | undefined
               battery_level: string
-              left_open_alarm: boolean
-              intrusion_alarm: boolean
-              privacy_mode: boolean
+              left_open_alarm?: boolean | undefined
+              intrusion_alarm?: boolean | undefined
+              privacy_mode?: boolean | undefined
             }
           | undefined
         dormakaba_community_metadata?:
@@ -7927,11 +7927,11 @@ export interface Routes {
               door_name: string
               locked_state: string
               lock_type: string
-              online: boolean
+              online?: boolean | undefined
               battery_level: string
-              left_open_alarm: boolean
-              intrusion_alarm: boolean
-              privacy_mode: boolean
+              left_open_alarm?: boolean | undefined
+              intrusion_alarm?: boolean | undefined
+              privacy_mode?: boolean | undefined
             }
           | undefined
         dormakaba_community_metadata?:
@@ -8943,11 +8943,11 @@ export interface Routes {
               door_name: string
               locked_state: string
               lock_type: string
-              online: boolean
+              online?: boolean | undefined
               battery_level: string
-              left_open_alarm: boolean
-              intrusion_alarm: boolean
-              privacy_mode: boolean
+              left_open_alarm?: boolean | undefined
+              intrusion_alarm?: boolean | undefined
+              privacy_mode?: boolean | undefined
             }
           | undefined
         dormakaba_community_metadata?:
@@ -23544,8 +23544,11 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the thermostat device. */
       device_id: string
+      /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
       cooling_set_point_celsius?: number | undefined
+      /** Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters. */
       cooling_set_point_fahrenheit?: number | undefined
       sync?: boolean
     }
@@ -24438,7 +24441,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the thermostat device. */
       device_id?: string | undefined
+      /** Name of the thermostat. */
       name?: string | undefined
     }
     formData: {}
@@ -25096,8 +25101,11 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the thermostat device. */
       device_id: string
+      /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
       heating_set_point_celsius?: number | undefined
+      /** Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters. */
       heating_set_point_fahrenheit?: number | undefined
       sync?: boolean
     }
@@ -25957,10 +25965,15 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the thermostat device. */
       device_id: string
+      /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
       heating_set_point_celsius?: number | undefined
+      /** Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters. */
       heating_set_point_fahrenheit?: number | undefined
+      /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
       cooling_set_point_celsius?: number | undefined
+      /** Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters. */
       cooling_set_point_fahrenheit?: number | undefined
       sync?: boolean
     }
@@ -28283,6 +28296,7 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the thermostat device. */
       device_id: string
       sync?: boolean
     }
@@ -29259,10 +29273,12 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the thermostat device. */
       device_id: string
       /**
-       * @deprecated use fan_mode_setting instead. */
+       * @deprecated Use `fan_mode_setting` instead. */
       fan_mode?: ('auto' | 'on' | 'circulate') | undefined
+      /** Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings). */
       fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
       sync?: boolean
     }