@seamapi/types 1.194.0 → 1.196.0

package/lib/seam/connect/models/acs/acs-system.js

@@ -1,9 +1,21 @@
 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
 export const acs_system_external_type = z.enum([
@@ -17,52 +29,95 @@ export const acs_system_external_type = z.enum([
     'latch_building',
 ]);
 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'),
-});
-const acs_system_error = z.union([
-    seam_bridge_disconnected,
-    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])
+    .describe('Error associated with the `acs_system`.');
 const acs_system_error_map = z.object({
     seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
     visionline_instance_unreachable: visionline_instance_unreachable
         .optional()
         .nullable(),
 });
-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({});
 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().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.
       ---
       `),
-    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),
 })
-    .merge(acs_system_capability_flags);
+    .merge(acs_system_capability_flags)
+    .describe('Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).');
 //# sourceMappingURL=acs-system.js.map

package/lib/seam/connect/models/acs/acs-system.js.map

@@ -1 +1 @@
-{"version":3,"file":"acs-system.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/acs/acs-system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/C,4BAA4B,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpD,2CAA2C,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnE,sCAAsC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/D,CAAC,CAAA;AAEF,oEAAoE;AACpE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC7C,UAAU;IACV,UAAU;IACV,YAAY;IACZ,eAAe;IACf,qCAAqC;IACrC,mBAAmB;IACnB,+BAA+B;IAC/B,gBAAgB;CACjB,CAAC,CAAA;AAIF,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,wBAAwB,GAAG,uBAAuB,CAAC,MAAM,CAAC;IAC9D,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;CAClD,CAAC,CAAA;AACF,MAAM,+BAA+B,GAAG,uBAAuB,CAAC,MAAM,CAAC;IACrE,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,iCAAiC,CAAC;CACzD,CAAC,CAAA;AAEF,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC;IAC/B,wBAAwB;IACxB,+BAA+B;CAChC,CAAC,CAAA;AAEF,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,wBAAwB,EAAE,wBAAwB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACxE,+BAA+B,EAAE,+BAA+B;SAC7D,QAAQ,EAAE;SACV,QAAQ,EAAE;CACd,CAAC,CAAA;AAIF,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;AAEvC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;AAI3C,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,CAAC;IACN,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAChC,aAAa,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IAClD,0BAA0B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjD,WAAW,EAAE,wBAAwB;SAClC,QAAQ,CACP;;;;OAID,CACA;SACA,QAAQ,EAAE;IACb,wBAAwB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC;;;;OAItD,CAAC;IACJ,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC/B,qBAAqB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IACjC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;CACtC,CAAC;KACD,KAAK,CAAC,2BAA2B,CAAC,CAAA"}
+{"version":3,"file":"acs-system.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/acs/acs-system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,uBAAuB,EAAE,CAAC;SACvB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,qUAAqU,CACtU;IACH,4BAA4B,EAAE,CAAC;SAC5B,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,oXAAoX,CACrX;IACH,2CAA2C,EAAE,CAAC;SAC3C,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,uaAAua,CACxa;IACH,sCAAsC,EAAE,CAAC;SACtC,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,8ZAA8Z,CAC/Z;CACJ,CAAC,CAAA;AAEF,oEAAoE;AACpE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC7C,UAAU;IACV,UAAU;IACV,YAAY;IACZ,eAAe;IACf,qCAAqC;IACrC,mBAAmB;IACnB,+BAA+B;IAC/B,gBAAgB;CACjB,CAAC,CAAA;AAIF,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,CACP,wGAAwG,CACzG;CACJ,CAAC,CAAA;AAEF,MAAM,sBAAsB,GAC1B,oGAAoG,CAAA;AAEtG,MAAM,wBAAwB,GAAG,uBAAuB,CAAC,MAAM,CAAC;IAC9D,UAAU,EAAE,CAAC;SACV,OAAO,CAAC,0BAA0B,CAAC;SACnC,QAAQ,CAAC,sBAAsB,CAAC;CACpC,CAAC;KACC,QAAQ,CAAC;;+NAEmN,CAAC,CAAA;AAChO,MAAM,+BAA+B,GAAG,uBAAuB,CAAC,MAAM,CAAC;IACrE,UAAU,EAAE,CAAC;SACV,OAAO,CAAC,iCAAiC,CAAC;SAC1C,QAAQ,CAAC,sBAAsB,CAAC;CACpC,CAAC;KACC,QAAQ,CAAC;;sOAE0N,CAAC,CAAA;AAEvO,MAAM,gBAAgB,GAAG,CAAC;KACvB,KAAK,CAAC,CAAC,wBAAwB,EAAE,+BAA+B,CAAC,CAAC;KAClE,QAAQ,CAAC,yCAAyC,CAAC,CAAA;AAEtD,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,wBAAwB,EAAE,wBAAwB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACxE,+BAA+B,EAAE,+BAA+B;SAC7D,QAAQ,EAAE;SACV,QAAQ,EAAE;CACd,CAAC,CAAA;AAIF,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAC9C;;;;OAIK,CACN,CAAA;AAED,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;AAI3C,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,CAAC;IACN,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IACpE,aAAa,EAAE,wBAAwB;SACpC,QAAQ,CAAC,uDAAuD,CAAC;SACjE,QAAQ,EAAE;IACb,0BAA0B,EAAE,CAAC;SAC1B,MAAM,EAAE;SACR,QAAQ,CACP,4FAA4F,CAC7F;SACA,QAAQ,EAAE;IACb,WAAW,EAAE,wBAAwB;SAClC,QAAQ,CACP;;;;OAID,CACA;SACA,QAAQ,EAAE;IACb,wBAAwB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC;;;;OAItD,CAAC;IACJ,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IACtD,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,6GAA6G,CAC9G;IACH,qBAAqB,EAAE,CAAC;SACrB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;SACxB,QAAQ,CACP,iIAAiI,CAClI;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,CAAC,qDAAqD,CAAC;IAClE,cAAc,EAAE,CAAC;SACd,MAAM,EAAE;SACR,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,gBAAgB,CAAC;SACvB,QAAQ,CAAC,0CAA0C,CAAC;IACvD,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAC5C;;;;OAIC,CACF;CACF,CAAC;KACD,KAAK,CAAC,2BAA2B,CAAC;KAClC,QAAQ,CACP,sGAAsG,CACvG,CAAA"}