@seamapi/types 1.984.0 → 1.986.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.984.0",
+  "version": "1.986.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-credential.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod'
 
 import {
+  acs_credential_akiles_metadata,
   acs_credential_visionline_metadata,
   acs_credential_vostio_metadata,
 } from './metadata/index.js'
@@ -20,6 +21,7 @@ export const acs_credential_external_type = z.enum([
   'salto_ks_tag',
   'avigilon_alta_credential',
   'kisi_credential',
+  'akiles_credential',
 ])
 
 export const acs_credential_access_method_type = z.enum([
@@ -309,6 +311,11 @@ const common_acs_credential = z.object({
     .describe(
       'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
     ),
+  akiles_metadata: acs_credential_akiles_metadata
+    .optional()
+    .describe(
+      'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+    ),
 })
 
 export const acs_credential = common_acs_credential.merge(

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/acs/metadata/akiles.ts

@@ -29,3 +29,17 @@ export const acs_entrance_akiles_metadata = z
 export type AcsEntranceAkilesMetadata = z.infer<
   typeof acs_entrance_akiles_metadata
 >
+
+export const acs_credential_akiles_metadata = z
+  .object({
+    member_pin_id: z
+      .string()
+      .optional()
+      .describe('ID of the Akiles member PIN.'),
+  })
+  .partial()
+  .describe('Akiles-specific metadata for the credential.')
+
+export type AcsCredentialAkilesMetadata = z.infer<
+  typeof acs_credential_akiles_metadata
+>

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

@@ -1,3 +1,4 @@
+export * from './akiles.js'
 export * from './assa-abloy-vostio.js'
 export * from './brivo.js'
 export * from './dormakaba-ambiance.js'

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.
     `),

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

@@ -3298,6 +3298,17 @@ const openapi: OpenAPISpec = {
             format: 'uuid',
             type: 'string',
           },
+          akiles_metadata: {
+            description:
+              'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+            properties: {
+              member_pin_id: {
+                description: 'ID of the Akiles member PIN.',
+                type: 'string',
+              },
+            },
+            type: 'object',
+          },
           assa_abloy_vostio_metadata: {
             description:
               'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -3405,6 +3416,7 @@ const openapi: OpenAPISpec = {
               'salto_ks_tag',
               'avigilon_alta_credential',
               'kisi_credential',
+              'akiles_credential',
             ],
             type: 'string',
           },
@@ -4329,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:
@@ -4352,6 +4365,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['created_at', 'message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `privacy_mode` instead.',
                 },
                 {
                   description:
@@ -6266,6 +6280,17 @@ const openapi: OpenAPISpec = {
                             format: 'uuid',
                             type: 'string',
                           },
+                          akiles_metadata: {
+                            description:
+                              'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+                            properties: {
+                              member_pin_id: {
+                                description: 'ID of the Akiles member PIN.',
+                                type: 'string',
+                              },
+                            },
+                            type: 'object',
+                          },
                           assa_abloy_vostio_metadata: {
                             description:
                               'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -6376,6 +6401,7 @@ const openapi: OpenAPISpec = {
                               'salto_ks_tag',
                               'avigilon_alta_credential',
                               'kisi_credential',
+                              'akiles_credential',
                             ],
                             type: 'string',
                           },
@@ -6737,6 +6763,17 @@ const openapi: OpenAPISpec = {
                             format: 'uuid',
                             type: 'string',
                           },
+                          akiles_metadata: {
+                            description:
+                              'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+                            properties: {
+                              member_pin_id: {
+                                description: 'ID of the Akiles member PIN.',
+                                type: 'string',
+                              },
+                            },
+                            type: 'object',
+                          },
                           assa_abloy_vostio_metadata: {
                             description:
                               'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -6847,6 +6884,7 @@ const openapi: OpenAPISpec = {
                               'salto_ks_tag',
                               'avigilon_alta_credential',
                               'kisi_credential',
+                              'akiles_credential',
                             ],
                             type: 'string',
                           },
@@ -7460,6 +7498,17 @@ const openapi: OpenAPISpec = {
                         format: 'uuid',
                         type: 'string',
                       },
+                      akiles_metadata: {
+                        description:
+                          'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+                        properties: {
+                          member_pin_id: {
+                            description: 'ID of the Akiles member PIN.',
+                            type: 'string',
+                          },
+                        },
+                        type: 'object',
+                      },
                       assa_abloy_vostio_metadata: {
                         description:
                           'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -7569,6 +7618,7 @@ const openapi: OpenAPISpec = {
                           'salto_ks_tag',
                           'avigilon_alta_credential',
                           'kisi_credential',
+                          'akiles_credential',
                         ],
                         type: 'string',
                       },
@@ -7928,6 +7978,17 @@ const openapi: OpenAPISpec = {
                         format: 'uuid',
                         type: 'string',
                       },
+                      akiles_metadata: {
+                        description:
+                          'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+                        properties: {
+                          member_pin_id: {
+                            description: 'ID of the Akiles member PIN.',
+                            type: 'string',
+                          },
+                        },
+                        type: 'object',
+                      },
                       assa_abloy_vostio_metadata: {
                         description:
                           'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -8037,6 +8098,7 @@ const openapi: OpenAPISpec = {
                           'salto_ks_tag',
                           'avigilon_alta_credential',
                           'kisi_credential',
+                          'akiles_credential',
                         ],
                         type: 'string',
                       },
@@ -8685,6 +8747,17 @@ const openapi: OpenAPISpec = {
                     format: 'uuid',
                     type: 'string',
                   },
+                  akiles_metadata: {
+                    description:
+                      'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+                    properties: {
+                      member_pin_id: {
+                        description: 'ID of the Akiles member PIN.',
+                        type: 'string',
+                      },
+                    },
+                    type: 'object',
+                  },
                   assa_abloy_vostio_metadata: {
                     description:
                       'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -8793,6 +8866,7 @@ const openapi: OpenAPISpec = {
                       'salto_ks_tag',
                       'avigilon_alta_credential',
                       'kisi_credential',
+                      'akiles_credential',
                     ],
                     type: 'string',
                   },
@@ -14910,7 +14984,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.',
@@ -22485,8 +22559,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.',
@@ -25826,21 +25900,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:
@@ -25931,9 +26008,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.',
@@ -25971,21 +26049,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:
@@ -26076,9 +26157,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.',
@@ -26110,21 +26192,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: {
@@ -26207,9 +26292,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.',
@@ -28422,8 +28508,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:
@@ -28449,6 +28536,8 @@ const openapi: OpenAPISpec = {
                                       'warning_code',
                                     ],
                                     type: 'object',
+                                    'x-deprecated':
+                                      'Use `privacy_mode` instead.',
                                   },
                                   {
                                     description:
@@ -28511,6 +28600,17 @@ const openapi: OpenAPISpec = {
                         format: 'uuid',
                         type: 'string',
                       },
+                      akiles_metadata: {
+                        description:
+                          'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+                        properties: {
+                          member_pin_id: {
+                            description: 'ID of the Akiles member PIN.',
+                            type: 'string',
+                          },
+                        },
+                        type: 'object',
+                      },
                       assa_abloy_vostio_metadata: {
                         description:
                           'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -28620,6 +28720,7 @@ const openapi: OpenAPISpec = {
                           'salto_ks_tag',
                           'avigilon_alta_credential',
                           'kisi_credential',
+                          'akiles_credential',
                         ],
                         type: 'string',
                       },
@@ -32499,6 +32600,17 @@ const openapi: OpenAPISpec = {
             format: 'uuid',
             type: 'string',
           },
+          akiles_metadata: {
+            description:
+              'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+            properties: {
+              member_pin_id: {
+                description: 'ID of the Akiles member PIN.',
+                type: 'string',
+              },
+            },
+            type: 'object',
+          },
           assa_abloy_vostio_metadata: {
             description:
               'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
@@ -32606,6 +32718,7 @@ const openapi: OpenAPISpec = {
               'salto_ks_tag',
               'avigilon_alta_credential',
               'kisi_credential',
+              'akiles_credential',
             ],
             type: 'string',
           },