@seamapi/types 1.130.0 → 1.132.0

package/package.json

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

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

@@ -185,6 +185,7 @@ export default {
       acs_system: {
         properties: {
           acs_system_id: { format: 'uuid', type: 'string' },
+          can_automate_enrollment: { type: 'boolean' },
           connected_account_ids: { items: { type: 'string' }, type: 'array' },
           created_at: { format: 'date-time', type: 'string' },
           external_type: {
@@ -616,6 +617,11 @@ export default {
               { enum: ['ios_phone', 'android_phone'], type: 'string' },
             ],
           },
+          display_name: {
+            description:
+              'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+            type: 'string',
+          },
           errors: {
             description:
               'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
@@ -649,6 +655,11 @@ export default {
             },
             type: 'object',
           },
+          nickname: {
+            description:
+              'Optional nickname to describe the device, settable through Seam',
+            type: 'string',
+          },
           properties: {
             allOf: [
               {
@@ -742,12 +753,7 @@ export default {
                           },
                           name: {
                             description:
-                              'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
-                            type: 'string',
-                          },
-                          nickname: {
-                            description:
-                              'Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                              'Name of the device. Deprecated - use device.display_name instead',
                             type: 'string',
                           },
                           offline_access_codes_enabled: {
@@ -1726,6 +1732,7 @@ export default {
         required: [
           'device_id',
           'device_type',
+          'display_name',
           'capabilities_supported',
           'properties',
           'location',
@@ -1903,6 +1910,11 @@ export default {
             type: 'string',
           },
           device_type: { enum: ['android_phone', 'ios_phone'], type: 'string' },
+          display_name: {
+            description:
+              'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+            type: 'string',
+          },
           errors: {
             description:
               'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
@@ -1936,6 +1948,11 @@ export default {
             },
             type: 'object',
           },
+          nickname: {
+            description:
+              'Optional nickname to describe the device, settable through Seam',
+            type: 'string',
+          },
           properties: {
             properties: {
               assa_abloy_credential_service_metadata: {
@@ -1982,6 +1999,7 @@ export default {
         required: [
           'device_id',
           'device_type',
+          'display_name',
           'capabilities_supported',
           'properties',
           'location',
@@ -2244,7 +2262,7 @@ export default {
               },
               name: {
                 description:
-                  'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                  'Name of the device. Deprecated - use device.display_name instead',
                 type: 'string',
               },
               offline_access_codes_enabled: {

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

@@ -1336,6 +1336,7 @@ export interface Routes {
         connected_account_ids: string[]
         image_url: string
         image_alt_text: string
+        can_automate_enrollment?: boolean | undefined
       }
     }
   }
@@ -1377,6 +1378,7 @@ export interface Routes {
         connected_account_ids: string[]
         image_url: string
         image_alt_text: string
+        can_automate_enrollment?: boolean | undefined
       }>
     }
   }
@@ -2224,6 +2226,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -2237,10 +2243,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -3036,6 +3040,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -3049,10 +3057,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -3828,7 +3834,7 @@ export interface Routes {
         created_at: string
         is_managed: false
         properties: {
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
           /** Indicates whether the device is online. */
           online: boolean
@@ -4058,7 +4064,7 @@ export interface Routes {
         created_at: string
         is_managed: false
         properties: {
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
           /** Indicates whether the device is online. */
           online: boolean
@@ -4411,6 +4417,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -4424,10 +4434,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -5095,6 +5103,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -5108,10 +5120,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -5907,6 +5917,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -5920,10 +5934,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -6591,6 +6603,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -6604,10 +6620,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -7565,6 +7579,10 @@ export interface Routes {
         /** Unique identifier for the device. */
         device_id: string
         device_type: 'android_phone' | 'ios_phone'
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -7643,6 +7661,10 @@ export interface Routes {
         /** Unique identifier for the device. */
         device_id: string
         device_type: 'android_phone' | 'ios_phone'
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -7940,6 +7962,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -7953,10 +7979,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -8834,6 +8858,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -8847,10 +8875,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -9810,6 +9836,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -9823,10 +9853,8 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
-          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-          nickname?: string | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
@@ -10498,6 +10526,7 @@ export interface Routes {
         connected_account_ids: string[]
         image_url: string
         image_alt_text: string
+        can_automate_enrollment?: boolean | undefined
       }>
     }
   }

package/src/lib/seam/connect/unstable/models/acs/acs_system_capability_flags.ts

@@ -0,0 +1,5 @@
+import { z } from 'zod'
+
+export const acs_system_capability_flags = z.object({
+  can_automate_enrollment: z.boolean().optional(),
+})

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

@@ -1,4 +1,5 @@
 export * from './access_group.js'
+export * from './acs_system_capability_flags.js'
 export * from './credential.js'
 export * from './credential_pool.js'
 export * from './credential_provisioning_automation.js'

package/src/lib/seam/connect/unstable/models/acs/system.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { acs_system_capability_flags } from './acs_system_capability_flags.js'
+
 // If changed, update seam.acs_system.external_type generated column
 export const acs_system_external_type = z.enum([
   'pti_site',
@@ -13,22 +15,24 @@ export const acs_system_external_type = z.enum([
 
 export type AcsSystemExternalType = z.infer<typeof acs_system_external_type>
 
-export const acs_system = z.object({
-  acs_system_id: z.string().uuid(),
-  external_type: acs_system_external_type,
-  external_type_display_name: z.string(),
-  system_type: acs_system_external_type.describe(
-    'deprecated: use external_type',
-  ),
-  system_type_display_name: z
-    .string()
-    .describe('deprecated: use external_type_display_name'),
-  name: z.string(),
-  created_at: z.string().datetime(),
-  workspace_id: z.string().uuid(),
-  connected_account_ids: z.array(z.string()),
-  image_url: z.string(),
-  image_alt_text: z.string(),
-})
+export const acs_system = z
+  .object({
+    acs_system_id: z.string().uuid(),
+    external_type: acs_system_external_type,
+    external_type_display_name: z.string(),
+    system_type: acs_system_external_type.describe(
+      'deprecated: use external_type',
+    ),
+    system_type_display_name: z
+      .string()
+      .describe('deprecated: use external_type_display_name'),
+    name: z.string(),
+    created_at: z.string().datetime(),
+    workspace_id: z.string().uuid(),
+    connected_account_ids: z.array(z.string()),
+    image_url: z.string(),
+    image_alt_text: z.string(),
+  })
+  .merge(acs_system_capability_flags)
 
 export type AcsSystem = z.output<typeof acs_system>

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

@@ -19,13 +19,7 @@ export const common_device_properties = z.object({
   name: z
     .string()
     .describe(
-      'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
-    ),
-  nickname: z
-    .string()
-    .optional()
-    .describe(
-      'Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+      'Name of the device. Deprecated - use device.display_name instead',
     ),
   appearance: z.object({
     name: z
@@ -113,6 +107,17 @@ export const managed_device = z
   .object({
     device_id: z.string().uuid().describe('Unique identifier for the device.'),
     device_type: any_device_type.describe('Type of the device.'),
+    nickname: z
+      .string()
+      .optional()
+      .describe(
+        'Optional nickname to describe the device, settable through Seam',
+      ),
+    display_name: z
+      .string()
+      .describe(
+        'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+      ),
     capabilities_supported: z
       .array(capabilities)
       .describe(