@seamapi/types 1.194.0 → 1.196.0

package/dist/connect.cjs

@@ -220,10 +220,18 @@ var acs_entrance = zod.z.object({
   visionline_metadata: acs_entrance_visionline_metadata.optional()
 });
 var acs_system_capability_flags = zod.z.object({
-  can_automate_enrollment: zod.z.boolean().optional(),
-  can_create_acs_access_groups: zod.z.boolean().optional(),
-  can_remove_acs_users_from_acs_access_groups: zod.z.boolean().optional(),
-  can_add_acs_users_to_acs_access_groups: zod.z.boolean().optional()
+  can_automate_enrollment: zod.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: zod.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: zod.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: zod.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)."
+  )
 });
 var acs_system_external_type = zod.z.enum([
   "pti_site",
@@ -236,50 +244,74 @@ var acs_system_external_type = zod.z.enum([
   "latch_building"
 ]);
 var common_acs_system_error = zod.z.object({
-  created_at: zod.z.string().datetime(),
-  message: zod.z.string()
+  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
+  message: zod.z.string().describe(
+    "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
+  )
 });
+var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
 var seam_bridge_disconnected = common_acs_system_error.extend({
-  error_code: zod.z.literal("seam_bridge_disconnected")
-});
+  error_code: zod.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).`);
 var visionline_instance_unreachable = common_acs_system_error.extend({
-  error_code: zod.z.literal("visionline_instance_unreachable")
-});
-var acs_system_error = zod.z.union([
-  seam_bridge_disconnected,
-  visionline_instance_unreachable
-]);
+  error_code: zod.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).`);
+var acs_system_error = zod.z.union([seam_bridge_disconnected, visionline_instance_unreachable]).describe("Error associated with the `acs_system`.");
 zod.z.object({
   seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
   visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable()
 });
-var acs_system_warning = zod.z.object({});
+var acs_system_warning = zod.z.object({}).describe(
+  `
+      ---
+      undocumented: Currently, no warnings defined for \`acs_system\`s.
+      ---
+      `
+);
 zod.z.object({});
 var acs_system = zod.z.object({
-  acs_system_id: zod.z.string().uuid(),
-  external_type: acs_system_external_type.optional(),
-  external_type_display_name: zod.z.string().optional(),
+  acs_system_id: zod.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: zod.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: zod.z.string().optional().describe(`
       ---
-      deprecated: use external_type_display_name
+      deprecated: Use \`external_type_display_name\`.
       ---
       `),
-  name: zod.z.string(),
-  created_at: zod.z.string().datetime(),
-  workspace_id: zod.z.string().uuid(),
-  connected_account_ids: zod.z.array(zod.z.string().uuid()),
-  image_url: zod.z.string(),
-  image_alt_text: zod.z.string(),
-  errors: zod.z.array(acs_system_error),
-  warnings: zod.z.array(acs_system_warning)
-}).merge(acs_system_capability_flags);
+  name: zod.z.string().describe("Name of the `acs_system`."),
+  created_at: zod.z.string().datetime().describe("Date and time at which the `acs_system` was created."),
+  workspace_id: zod.z.string().uuid().describe(
+    "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`."
+  ),
+  connected_account_ids: zod.z.array(zod.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: zod.z.string().describe("URL for the image that represents the `acs_system`."),
+  image_alt_text: zod.z.string().describe("Alternative text for the `acs_system` image."),
+  errors: zod.z.array(acs_system_error).describe("Errors associated with the `acs_system`."),
+  warnings: zod.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)."
+);
 var phone_number = zod.z.coerce.string().trim().refine(
   (val) => {
     return /^\+[1-9]\d{1,14}$/.test(val);
@@ -1555,6 +1587,12 @@ var unmanaged_device = device.pick({
   })
 }).merge(device_capability_flags2);
 var common_event = zod.z.object({
+  event_id: zod.z.string().uuid().describe(`
+    ---
+    title: Event ID
+    ---
+    The ID of the event.
+  `),
   workspace_id: zod.z.string().uuid().describe(`
     ---
     title: Workspace ID
@@ -2447,40 +2485,82 @@ var openapi_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"
@@ -2490,6 +2570,7 @@ var openapi_default = {
             type: "array"
           },
           external_type: {
+            description: "Brand-specific terminology for the `acs_system` type.",
             enum: [
               "pti_site",
               "alta_org",
@@ -2502,10 +2583,19 @@ var openapi_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: [
@@ -2519,18 +2609,27 @@ var openapi_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" },
-            type: "array"
+            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: { format: "uuid", type: "string" }
+          workspace_id: {
+            description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.",
+            format: "uuid",
+            type: "string"
+          }
         },
         required: [
           "acs_system_id",