@seamapi/types 1.194.0 → 1.196.0

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

@@ -2632,35 +2632,57 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /** Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
             acs_system: {
+                /** ID of the `acs_system`. */
                 acs_system_id: string;
+                /** Brand-specific terminology for the `acs_system` type. */
                 external_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
                 external_type_display_name?: string | undefined;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 system_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 system_type_display_name?: string | undefined;
+                /** Name of the `acs_system`. */
                 name: string;
+                /** Date and time at which the `acs_system` was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
                 workspace_id: string;
+                /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
                 connected_account_ids: string[];
+                /** URL for the image that represents the `acs_system`. */
                 image_url: string;
+                /** Alternative text for the `acs_system` image. */
                 image_alt_text: string;
+                /** Errors associated with the `acs_system`. */
                 errors: Array<{
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'seam_bridge_disconnected';
                 } | {
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
                 }>;
+                /**  */
                 warnings: Array<{}>;
+                /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_create_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_add_acs_users_to_acs_access_groups?: boolean | undefined;
             };
         };
@@ -2676,34 +2698,55 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_systems: Array<{
+                /** ID of the `acs_system`. */
                 acs_system_id: string;
+                /** Brand-specific terminology for the `acs_system` type. */
                 external_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
                 external_type_display_name?: string | undefined;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 system_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 system_type_display_name?: string | undefined;
+                /** Name of the `acs_system`. */
                 name: string;
+                /** Date and time at which the `acs_system` was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
                 workspace_id: string;
+                /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
                 connected_account_ids: string[];
+                /** URL for the image that represents the `acs_system`. */
                 image_url: string;
+                /** Alternative text for the `acs_system` image. */
                 image_alt_text: string;
+                /** Errors associated with the `acs_system`. */
                 errors: Array<{
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'seam_bridge_disconnected';
                 } | {
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
                 }>;
+                /**  */
                 warnings: Array<{}>;
+                /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_create_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_add_acs_users_to_acs_access_groups?: boolean | undefined;
             }>;
         };
@@ -2719,34 +2762,55 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_systems: Array<{
+                /** ID of the `acs_system`. */
                 acs_system_id: string;
+                /** Brand-specific terminology for the `acs_system` type. */
                 external_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
                 external_type_display_name?: string | undefined;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 system_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 system_type_display_name?: string | undefined;
+                /** Name of the `acs_system`. */
                 name: string;
+                /** Date and time at which the `acs_system` was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
                 workspace_id: string;
+                /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
                 connected_account_ids: string[];
+                /** URL for the image that represents the `acs_system`. */
                 image_url: string;
+                /** Alternative text for the `acs_system` image. */
                 image_alt_text: string;
+                /** Errors associated with the `acs_system`. */
                 errors: Array<{
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'seam_bridge_disconnected';
                 } | {
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
                 }>;
+                /**  */
                 warnings: Array<{}>;
+                /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_create_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_add_acs_users_to_acs_access_groups?: boolean | undefined;
             }>;
         };
@@ -14107,34 +14171,55 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_systems: Array<{
+                /** ID of the `acs_system`. */
                 acs_system_id: string;
+                /** Brand-specific terminology for the `acs_system` type. */
                 external_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
                 external_type_display_name?: string | undefined;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 system_type?: ('pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building') | undefined;
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 system_type_display_name?: string | undefined;
+                /** Name of the `acs_system`. */
                 name: string;
+                /** Date and time at which the `acs_system` was created. */
                 created_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
                 workspace_id: string;
+                /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
                 connected_account_ids: string[];
+                /** URL for the image that represents the `acs_system`. */
                 image_url: string;
+                /** Alternative text for the `acs_system` image. */
                 image_alt_text: string;
+                /** Errors associated with the `acs_system`. */
                 errors: Array<{
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'seam_bridge_disconnected';
                 } | {
+                    /** Date and time at which Seam created the error. */
                     created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
                 }>;
+                /**  */
                 warnings: Array<{}>;
+                /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_create_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
+                /** Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
                 can_add_acs_users_to_acs_access_groups?: boolean | undefined;
             }>;
         };

package/package.json

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

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

@@ -1,10 +1,30 @@
 import { z } from 'zod'
 
 export const acs_system_capability_flags = z.object({
-  can_automate_enrollment: z.boolean().optional(),
-  can_create_acs_access_groups: z.boolean().optional(),
-  can_remove_acs_users_from_acs_access_groups: z.boolean().optional(),
-  can_add_acs_users_to_acs_access_groups: z.boolean().optional(),
+  can_automate_enrollment: z
+    .boolean()
+    .optional()
+    .describe(
+      'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.',
+    ),
+  can_create_acs_access_groups: z
+    .boolean()
+    .optional()
+    .describe(
+      'Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
+    ),
+  can_remove_acs_users_from_acs_access_groups: z
+    .boolean()
+    .optional()
+    .describe(
+      'Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
+    ),
+  can_add_acs_users_to_acs_access_groups: z
+    .boolean()
+    .optional()
+    .describe(
+      'Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
+    ),
 })
 
 // If changed, update seam.acs_system.external_type generated column
@@ -22,21 +42,40 @@ export const acs_system_external_type = z.enum([
 export type AcsSystemExternalType = z.infer<typeof acs_system_external_type>
 
 const common_acs_system_error = z.object({
-  created_at: z.string().datetime(),
-  message: z.string(),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
 })
 
+const error_code_description =
+  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+
 const seam_bridge_disconnected = common_acs_system_error.extend({
-  error_code: z.literal('seam_bridge_disconnected'),
+  error_code: z
+    .literal('seam_bridge_disconnected')
+    .describe(error_code_description),
 })
+  .describe(`Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
+  This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
+  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`)
 const visionline_instance_unreachable = common_acs_system_error.extend({
-  error_code: z.literal('visionline_instance_unreachable'),
+  error_code: z
+    .literal('visionline_instance_unreachable')
+    .describe(error_code_description),
 })
+  .describe(`Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
+  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
+  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`)
 
-const acs_system_error = z.union([
-  seam_bridge_disconnected,
-  visionline_instance_unreachable,
-])
+const acs_system_error = z
+  .union([seam_bridge_disconnected, visionline_instance_unreachable])
+  .describe('Error associated with the `acs_system`.')
 
 const acs_system_error_map = z.object({
   seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
@@ -47,7 +86,13 @@ const acs_system_error_map = z.object({
 
 export type AcsSystemErrorMap = z.infer<typeof acs_system_error_map>
 
-const acs_system_warning = z.object({})
+const acs_system_warning = z.object({}).describe(
+  `
+      ---
+      undocumented: Currently, no warnings defined for \`acs_system\`s.
+      ---
+      `,
+)
 
 const acs_system_warning_map = z.object({})
 
@@ -55,32 +100,66 @@ export type AcsSystemWarningMap = z.infer<typeof acs_system_warning_map>
 
 export const acs_system = z
   .object({
-    acs_system_id: z.string().uuid(),
-    external_type: acs_system_external_type.optional(),
-    external_type_display_name: z.string().optional(),
+    acs_system_id: z.string().uuid().describe('ID of the `acs_system`.'),
+    external_type: acs_system_external_type
+      .describe('Brand-specific terminology for the `acs_system` type.')
+      .optional(),
+    external_type_display_name: z
+      .string()
+      .describe(
+        'Display name that corresponds to the brand-specific terminology for the `acs_system` type.',
+      )
+      .optional(),
     system_type: acs_system_external_type
       .describe(
         `
       ---
-      deprecated: use external_type
+      deprecated: Use \`external_type\`.
       ---
       `,
       )
       .optional(),
     system_type_display_name: z.string().optional().describe(`
       ---
-      deprecated: use external_type_display_name
+      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().uuid()),
-    image_url: z.string(),
-    image_alt_text: z.string(),
-    errors: z.array(acs_system_error),
-    warnings: z.array(acs_system_warning),
+    name: z.string().describe('Name of the `acs_system`.'),
+    created_at: z
+      .string()
+      .datetime()
+      .describe('Date and time at which the `acs_system` was created.'),
+    workspace_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
+      ),
+    connected_account_ids: z
+      .array(z.string().uuid())
+      .describe(
+        'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.',
+      ),
+    image_url: z
+      .string()
+      .describe('URL for the image that represents the `acs_system`.'),
+    image_alt_text: z
+      .string()
+      .describe('Alternative text for the `acs_system` image.'),
+    errors: z
+      .array(acs_system_error)
+      .describe('Errors associated with the `acs_system`.'),
+    warnings: z.array(acs_system_warning).describe(
+      `
+      ---
+      undocumented: Currently, no warnings defined for \`acs_system\`s.
+      ---
+      `,
+    ),
   })
   .merge(acs_system_capability_flags)
+  .describe(
+    'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+  )
 
 export type AcsSystem = z.output<typeof acs_system>

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

@@ -1,6 +1,12 @@
 import { z } from 'zod'
 
 export const common_event = z.object({
+  event_id: z.string().uuid().describe(`
+    ---
+    title: Event ID
+    ---
+    The ID of the event.
+  `),
   workspace_id: z.string().uuid().describe(`
     ---
     title: Workspace ID

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

@@ -389,40 +389,96 @@ export default {
         type: 'object',
       },
       acs_system: {
+        description:
+          'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
         properties: {
-          acs_system_id: { format: 'uuid', type: 'string' },
-          can_add_acs_users_to_acs_access_groups: { type: 'boolean' },
-          can_automate_enrollment: { type: 'boolean' },
-          can_create_acs_access_groups: { type: 'boolean' },
-          can_remove_acs_users_from_acs_access_groups: { type: 'boolean' },
+          acs_system_id: {
+            description: 'ID of the `acs_system`.',
+            format: 'uuid',
+            type: 'string',
+          },
+          can_add_acs_users_to_acs_access_groups: {
+            description:
+              'Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
+            type: 'boolean',
+          },
+          can_automate_enrollment: {
+            description:
+              'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.',
+            type: 'boolean',
+          },
+          can_create_acs_access_groups: {
+            description:
+              'Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
+            type: 'boolean',
+          },
+          can_remove_acs_users_from_acs_access_groups: {
+            description:
+              'Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
+            type: 'boolean',
+          },
           connected_account_ids: {
+            description:
+              'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.',
             items: { format: 'uuid', type: 'string' },
             type: 'array',
           },
-          created_at: { format: 'date-time', type: 'string' },
+          created_at: {
+            description: 'Date and time at which the `acs_system` was created.',
+            format: 'date-time',
+            type: 'string',
+          },
           errors: {
+            description: 'Errors associated with the `acs_system`.',
             items: {
+              description: 'Error associated with the `acs_system`.',
               oneOf: [
                 {
+                  description:
+                    'Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
                   properties: {
-                    created_at: { format: 'date-time', type: 'string' },
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
                       enum: ['seam_bridge_disconnected'],
                       type: 'string',
                     },
-                    message: { type: 'string' },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
                   },
                   required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
                 {
+                  description:
+                    'Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
                   properties: {
-                    created_at: { format: 'date-time', type: 'string' },
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
                       enum: ['visionline_instance_unreachable'],
                       type: 'string',
                     },
-                    message: { type: 'string' },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
                   },
                   required: ['created_at', 'message', 'error_code'],
                   type: 'object',
@@ -432,6 +488,8 @@ export default {
             type: 'array',
           },
           external_type: {
+            description:
+              'Brand-specific terminology for the `acs_system` type.',
             enum: [
               'pti_site',
               'alta_org',
@@ -444,10 +502,20 @@ export default {
             ],
             type: 'string',
           },
-          external_type_display_name: { type: 'string' },
-          image_alt_text: { type: 'string' },
-          image_url: { type: 'string' },
-          name: { type: 'string' },
+          external_type_display_name: {
+            description:
+              'Display name that corresponds to the brand-specific terminology for the `acs_system` type.',
+            type: 'string',
+          },
+          image_alt_text: {
+            description: 'Alternative text for the `acs_system` image.',
+            type: 'string',
+          },
+          image_url: {
+            description: 'URL for the image that represents the `acs_system`.',
+            type: 'string',
+          },
+          name: { description: 'Name of the `acs_system`.', type: 'string' },
           system_type: {
             deprecated: true,
             enum: [
@@ -461,18 +529,30 @@ export default {
               'latch_building',
             ],
             type: 'string',
-            'x-deprecated': 'use external_type',
+            'x-deprecated': 'Use `external_type`.',
           },
           system_type_display_name: {
             deprecated: true,
             type: 'string',
-            'x-deprecated': 'use external_type_display_name',
+            'x-deprecated': 'Use `external_type_display_name`.',
           },
           warnings: {
-            items: { properties: {}, type: 'object' },
+            items: {
+              description:
+                '\n      ---\n      undocumented: Currently, no warnings defined for `acs_system`s.\n      ---\n      ',
+              properties: {},
+              type: 'object',
+            },
             type: 'array',
+            'x-undocumented':
+              'Currently, no warnings defined for `acs_system`s.',
+          },
+          workspace_id: {
+            description:
+              'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
+            format: 'uuid',
+            type: 'string',
           },
-          workspace_id: { format: 'uuid', type: 'string' },
         },
         required: [
           'acs_system_id',