@seamapi/types 1.985.0 → 1.987.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.985.0",
+  "version": "1.987.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -90,7 +90,7 @@
     }
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^1.1.0",
+    "@seamapi/blueprint": "^1.2.0",
     "@types/node": "^24.10.9",
     "concurrently": "^9.2.0",
     "del-cli": "^7.0.0",

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

@@ -60,15 +60,16 @@ const entrance_setup_required = common_acs_entrance_warning
     'Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it.',
   )
 
-const salto_ks_privacy_mode = common_acs_entrance_warning
-  .extend({
-    warning_code: z
-      .literal('salto_ks_privacy_mode')
-      .describe(warning_code_description),
-  })
-  .describe(
-    'deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
-  )
+const salto_ks_privacy_mode = common_acs_entrance_warning.extend({
+  warning_code: z
+    .literal('salto_ks_privacy_mode')
+    .describe(warning_code_description),
+}).describe(`
+    ---
+    deprecated: Use \`privacy_mode\` instead.
+    ---
+    Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.
+  `)
 
 const privacy_mode = common_acs_entrance_warning
   .extend({

package/src/lib/seam/connect/models/devices/device-metadata.ts

@@ -264,7 +264,7 @@ export const device_metadata = z
       })
       .partial().describe(`
     ---
-    deprecated: Use \`salto_ks_metadata \` instead.
+    deprecated: Use \`salto_ks_metadata\` instead.
     ---
     Metada for a Salto device.
     `),
@@ -678,6 +678,10 @@ export const device_metadata = z
           .string()
           .optional()
           .describe(`Device ID for a Google Nest device.`),
+        nest_structure_id: z
+          .string()
+          .optional()
+          .describe(`ID of the Google Nest structure containing the device.`),
         device_name: z
           .string()
           .optional()
@@ -690,6 +694,12 @@ export const device_metadata = z
           .describe(
             `Custom device name for a Google Nest device. The device owner sets this value.`,
           ), // set by device owner
+        structure_name: z
+          .string()
+          .optional()
+          .describe(
+            `Name of the Google Nest structure containing the device. The device owner sets this value.`,
+          ), // set by device owner
         display_name: z
           .string()
           .optional()

package/src/lib/seam/connect/models/devices/device.ts

@@ -1043,6 +1043,9 @@ export const device = z
         location_name: z.string().optional()
           .describe(`Name of the device location.
           `),
+        room_name: z.string().optional()
+          .describe(`Name of the room within the device location, when the provider reports one.
+          `),
         time_zone: z.string().optional()
           .describe(`Time zone of the device location.
           `),

package/src/lib/seam/connect/models/events/connected-accounts.ts

@@ -117,10 +117,11 @@ export type ConnectedAccountCompletedFirstSyncEvent = z.infer<
 
 export const connected_account_deleted_event = connected_account_event.extend({
   event_type: z.literal('connected_account.deleted'),
-  connected_account_type: z
-    .string()
-    .optional()
-    .describe(`undocumented: Unreleased.`),
+  connected_account_type: z.string().optional().describe(`
+      ---
+      undocumented: Unreleased.
+      ---
+    `),
   customer_key: z
     .string()
     .optional()

package/src/lib/seam/connect/models/events/devices.ts

@@ -436,21 +436,25 @@ export const lock_locked_event = device_event.extend({
     'Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined.',
   ),
   user_identity_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the user identity associated with the lock event.
     `),
   acs_system_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS system associated with the lock event.
     `),
   acs_user_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS user associated with the lock event.
     `),
   acs_entrance_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS entrance associated with the lock event.
@@ -499,21 +503,25 @@ export const lock_unlocked_event = device_event.extend({
     'Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined.',
   ),
   user_identity_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the user identity associated with the unlock event.
     `),
   acs_system_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS system associated with the unlock event.
     `),
   acs_user_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS user associated with the unlock event.
     `),
   acs_entrance_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS entrance associated with the unlock event.
@@ -546,21 +554,25 @@ export const lock_access_denied_event = device_event.extend({
     .optional()
     .describe('ID of the access code that was used in the unlock attempts.'),
   user_identity_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the user identity associated with the access-denied event.
     `),
   acs_system_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS system associated with the access-denied event.
     `),
   acs_user_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS user associated with the access-denied event.
     `),
   acs_entrance_id: z.string().uuid().optional().describe(`
+      ---
       undocumented: Unreleased.
       ---
       ID of the ACS entrance associated with the access-denied event.

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

@@ -4341,8 +4341,9 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description:
-                    'deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
+                    'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
                   properties: {
                     created_at: {
                       description:
@@ -4364,6 +4365,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['created_at', 'message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `privacy_mode` instead.',
                 },
                 {
                   description:
@@ -13707,6 +13709,11 @@ const openapi: OpenAPISpec = {
                 description: 'Name of the device location.\n          ',
                 type: 'string',
               },
+              room_name: {
+                description:
+                  'Name of the room within the device location, when the provider reports one.\n          ',
+                type: 'string',
+              },
               time_zone: {
                 description: 'Time zone of the device location.\n          ',
                 type: 'string',
@@ -14775,6 +14782,16 @@ const openapi: OpenAPISpec = {
                             description: 'Device ID for a Google Nest device.',
                             type: 'string',
                           },
+                          nest_structure_id: {
+                            description:
+                              'ID of the Google Nest structure containing the device.',
+                            type: 'string',
+                          },
+                          structure_name: {
+                            description:
+                              'Name of the Google Nest structure containing the device. The device owner sets this value.',
+                            type: 'string',
+                          },
                         },
                         type: 'object',
                       },
@@ -14982,7 +14999,7 @@ const openapi: OpenAPISpec = {
                           },
                         },
                         type: 'object',
-                        'x-deprecated': 'Use `salto_ks_metadata ` instead.',
+                        'x-deprecated': 'Use `salto_ks_metadata` instead.',
                       },
                       schlage_metadata: {
                         description: 'Metadata for a Schlage device.',
@@ -22557,8 +22574,8 @@ const openapi: OpenAPISpec = {
                 type: 'string',
               },
               connected_account_type: {
-                description: 'undocumented: Unreleased.',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               created_at: {
                 description: 'Date and time at which the event was created.',
@@ -25898,21 +25915,24 @@ const openapi: OpenAPISpec = {
               },
               acs_entrance_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS entrance associated with the lock event.\n    ',
+                  'ID of the ACS entrance associated with the lock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               acs_system_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS system associated with the lock event.\n    ',
+                  'ID of the ACS system associated with the lock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               acs_user_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS user associated with the lock event.\n    ',
+                  'ID of the ACS user associated with the lock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               action_attempt_id: {
                 description:
@@ -26003,9 +26023,10 @@ const openapi: OpenAPISpec = {
               },
               user_identity_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the user identity associated with the lock event.\n    ',
+                  'ID of the user identity associated with the lock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               workspace_id: {
                 description: 'ID of the workspace associated with the event.',
@@ -26043,21 +26064,24 @@ const openapi: OpenAPISpec = {
               },
               acs_entrance_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS entrance associated with the unlock event.\n    ',
+                  'ID of the ACS entrance associated with the unlock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               acs_system_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS system associated with the unlock event.\n    ',
+                  'ID of the ACS system associated with the unlock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               acs_user_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS user associated with the unlock event.\n    ',
+                  'ID of the ACS user associated with the unlock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               action_attempt_id: {
                 description:
@@ -26148,9 +26172,10 @@ const openapi: OpenAPISpec = {
               },
               user_identity_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the user identity associated with the unlock event.\n    ',
+                  'ID of the user identity associated with the unlock event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               workspace_id: {
                 description: 'ID of the workspace associated with the event.',
@@ -26182,21 +26207,24 @@ const openapi: OpenAPISpec = {
               },
               acs_entrance_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS entrance associated with the access-denied event.\n    ',
+                  'ID of the ACS entrance associated with the access-denied event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               acs_system_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS system associated with the access-denied event.\n    ',
+                  'ID of the ACS system associated with the access-denied event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               acs_user_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS user associated with the access-denied event.\n    ',
+                  'ID of the ACS user associated with the access-denied event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               connected_account_custom_metadata: {
                 additionalProperties: {
@@ -26279,9 +26307,10 @@ const openapi: OpenAPISpec = {
               },
               user_identity_id: {
                 description:
-                  '\n      undocumented: Unreleased.\n      ---\n      ID of the user identity associated with the access-denied event.\n    ',
+                  'ID of the user identity associated with the access-denied event.',
                 format: 'uuid',
                 type: 'string',
+                'x-undocumented': 'Unreleased.',
               },
               workspace_id: {
                 description: 'ID of the workspace associated with the event.',
@@ -28494,8 +28523,9 @@ const openapi: OpenAPISpec = {
                                     type: 'object',
                                   },
                                   {
+                                    deprecated: true,
                                     description:
-                                      'deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
+                                      'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
                                     properties: {
                                       created_at: {
                                         description:
@@ -28521,6 +28551,8 @@ const openapi: OpenAPISpec = {
                                       'warning_code',
                                     ],
                                     type: 'object',
+                                    'x-deprecated':
+                                      'Use `privacy_mode` instead.',
                                   },
                                   {
                                     description:
@@ -34647,6 +34679,11 @@ const openapi: OpenAPISpec = {
                 description: 'Name of the device location.\n          ',
                 type: 'string',
               },
+              room_name: {
+                description:
+                  'Name of the room within the device location, when the provider reports one.\n          ',
+                type: 'string',
+              },
               time_zone: {
                 description: 'Time zone of the device location.\n          ',
                 type: 'string',