@seamapi/types 1.429.1 → 1.431.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.429.1",
+  "version": "1.431.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -92,7 +92,7 @@
     "zod": "^3.24.0"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^0.50.2",
+    "@seamapi/blueprint": "^0.50.6",
     "@types/node": "^20.8.10",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",

package/src/lib/seam/connect/models/acs/acs-credential.ts

@@ -142,6 +142,13 @@ const common_acs_credential = z.object({
     .describe(
       'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
     ),
+  user_identity_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+    ),
   connected_account_id: z
     .string()
     .uuid()

package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts

@@ -2,6 +2,7 @@ import { z } from 'zod'
 
 import {
   climate_preset,
+  climate_preset_mode,
   climate_setting,
   fan_mode_setting,
   hvac_mode_setting,
@@ -42,6 +43,13 @@ export const thermostat_capability_properties = z
           ---
           Fan mode settings that the thermostat supports.
           `),
+    available_climate_preset_modes: z.array(climate_preset_mode).describe(`
+          ---
+          property_group_key: thermostats
+          draft: Needs review.
+          ---
+          Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
+          `),
     is_heating: z.boolean().describe(`
           ---
           property_group_key: thermostats

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

@@ -1,6 +1,10 @@
 import { z } from 'zod'
 
-import { fan_mode_setting, hvac_mode_setting } from './modes.js'
+import {
+  climate_preset_mode,
+  fan_mode_setting,
+  hvac_mode_setting,
+} from './modes.js'
 
 export const climate_preset = z.object({
   climate_preset_key: z
@@ -36,6 +40,9 @@ export const climate_preset = z.object({
     .describe(
       'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
     ),
+  climate_preset_mode: climate_preset_mode.optional().describe(`
+    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
+  `),
   fan_mode_setting: fan_mode_setting
     .optional()
     .describe(

package/src/lib/seam/connect/models/thermostats/modes.ts

@@ -13,3 +13,14 @@ export const available_fan_mode_settings = z.array(fan_mode_setting)
 export type AvailableFanModeSettings = z.infer<
   typeof available_fan_mode_settings
 >
+
+export const climate_preset_mode = z.enum([
+  'home',
+  'away',
+  'wake',
+  'sleep',
+  'occupied',
+  'unoccupied',
+])
+
+export type ClimatePresetMode = z.infer<typeof climate_preset_mode>

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

@@ -2289,6 +2289,12 @@ export default {
               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
             type: 'string',
           },
+          user_identity_id: {
+            description:
+              'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+            format: 'uuid',
+            type: 'string',
+          },
           visionline_metadata: {
             description:
               'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
@@ -4663,6 +4669,12 @@ export default {
                               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
                             type: 'string',
                           },
+                          user_identity_id: {
+                            description:
+                              'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                            format: 'uuid',
+                            type: 'string',
+                          },
                           visionline_metadata: {
                             description:
                               'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
@@ -5111,6 +5123,12 @@ export default {
                               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
                             type: 'string',
                           },
+                          user_identity_id: {
+                            description:
+                              'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                            format: 'uuid',
+                            type: 'string',
+                          },
                           visionline_metadata: {
                             description:
                               'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
@@ -5758,6 +5776,12 @@ export default {
                           'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
                         type: 'string',
                       },
+                      user_identity_id: {
+                        description:
+                          'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                        format: 'uuid',
+                        type: 'string',
+                      },
                       visionline_metadata: {
                         description:
                           'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
@@ -6203,6 +6227,12 @@ export default {
                           'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
                         type: 'string',
                       },
+                      user_identity_id: {
+                        description:
+                          'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                        format: 'uuid',
+                        type: 'string',
+                      },
                       visionline_metadata: {
                         description:
                           'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
@@ -11466,6 +11496,24 @@ export default {
                         type: 'string',
                         'x-property-group-key': 'thermostats',
                       },
+                      available_climate_preset_modes: {
+                        description:
+                          'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
+                        items: {
+                          enum: [
+                            'home',
+                            'away',
+                            'wake',
+                            'sleep',
+                            'occupied',
+                            'unoccupied',
+                          ],
+                          type: 'string',
+                        },
+                        type: 'array',
+                        'x-draft': 'Needs review.',
+                        'x-property-group-key': 'thermostats',
+                      },
                       available_climate_presets: {
                         description:
                           'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.',
@@ -11491,6 +11539,19 @@ export default {
                                 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
                               type: 'string',
                             },
+                            climate_preset_mode: {
+                              description:
+                                '\n    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n  ',
+                              enum: [
+                                'home',
+                                'away',
+                                'wake',
+                                'sleep',
+                                'occupied',
+                                'unoccupied',
+                              ],
+                              type: 'string',
+                            },
                             cooling_set_point_celsius: {
                               description:
                                 '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).',
@@ -11604,6 +11665,19 @@ export default {
                               'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
                             type: 'string',
                           },
+                          climate_preset_mode: {
+                            description:
+                              '\n    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n  ',
+                            enum: [
+                              'home',
+                              'away',
+                              'wake',
+                              'sleep',
+                              'occupied',
+                              'unoccupied',
+                            ],
+                            type: 'string',
+                          },
                           cooling_set_point_celsius: {
                             description:
                               '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).',
@@ -11687,6 +11761,19 @@ export default {
                               'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
                             type: 'string',
                           },
+                          climate_preset_mode: {
+                            description:
+                              '\n    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n  ',
+                            enum: [
+                              'home',
+                              'away',
+                              'wake',
+                              'sleep',
+                              'occupied',
+                              'unoccupied',
+                            ],
+                            type: 'string',
+                          },
                           cooling_set_point_celsius: {
                             description:
                               '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).',
@@ -18668,6 +18755,12 @@ export default {
                           'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
                         type: 'string',
                       },
+                      user_identity_id: {
+                        description:
+                          'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+                        format: 'uuid',
+                        type: 'string',
+                      },
                       visionline_metadata: {
                         description:
                           'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
@@ -21236,6 +21329,12 @@ export default {
               'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
             type: 'string',
           },
+          user_identity_id: {
+            description:
+              'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+            format: 'uuid',
+            type: 'string',
+          },
           visionline_metadata: {
             description:
               'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
@@ -46433,6 +46532,19 @@ export default {
                       'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
                     type: 'string',
                   },
+                  climate_preset_mode: {
+                    description:
+                      '\n    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n  ',
+                    enum: [
+                      'home',
+                      'away',
+                      'wake',
+                      'sleep',
+                      'occupied',
+                      'unoccupied',
+                    ],
+                    type: 'string',
+                  },
                   cooling_set_point_celsius: {
                     description:
                       '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).',
@@ -49158,6 +49270,19 @@ export default {
                       'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
                     type: 'string',
                   },
+                  climate_preset_mode: {
+                    description:
+                      '\n    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n  ',
+                    enum: [
+                      'home',
+                      'away',
+                      'wake',
+                      'sleep',
+                      'occupied',
+                      'unoccupied',
+                    ],
+                    type: 'string',
+                  },
                   cooling_set_point_celsius: {
                     description:
                       '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).',
@@ -49265,6 +49390,19 @@ export default {
                       'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
                     type: 'string',
                   },
+                  climate_preset_mode: {
+                    description:
+                      '\n    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n  ',
+                    enum: [
+                      'home',
+                      'away',
+                      'wake',
+                      'sleep',
+                      'occupied',
+                      'unoccupied',
+                    ],
+                    type: 'string',
+                  },
                   cooling_set_point_celsius: {
                     description:
                       '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).',