@seamapi/types 1.287.0 → 1.287.2

package/dist/connect.cjs

@@ -1132,12 +1132,12 @@ var common_acs_access_group = zod.z.object({
   name: zod.z.string().describe("Name of the access group."),
   access_group_type: acs_access_group_external_type.describe(`
     ---
-    deprecated: use external_type
+    deprecated: Use \`external_type\`.
     ---
   `),
   access_group_type_display_name: zod.z.string().describe(`
     ---
-    deprecated: use external_type_display_name
+    deprecated: Use \`external_type_display_name\`.
     ---
     `),
   display_name: zod.z.string(),
@@ -1151,11 +1151,8 @@ var common_acs_access_group = zod.z.object({
 });
 var acs_access_group = common_acs_access_group.extend({
   is_managed: zod.z.literal(true)
-}).describe(`
-    Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
-    
-    The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-  `);
+}).describe(`Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).`);
 var unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: zod.z.literal(false)
 });
@@ -1291,10 +1288,8 @@ var unmanaged_acs_credential = common_acs_credential.merge(
 function getAcsCredentialDescription(is_managed = true) {
   const resource_name = is_managed ? "acs_credential" : "unmanaged_acs_credential";
   const management_clause = is_managed ? "" : ", which is not managed by Seam,";
-  return `
-      Means by which a user gains access at an entrance.
-
-      The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim();
+  return `Means by which a user gains access at an entrance.
+The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim();
 }
 var acs_credential_on_encoder = zod.z.object({
   created_at: zod.z.string().datetime().nullable().describe("Date and time the credential was created."),
@@ -1334,7 +1329,9 @@ var acs_entrance = zod.z.object({
   salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
   dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata.optional(),
   assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata.optional()
-});
+}).describe(
+  "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
+);
 var acs_system_capability_flags = zod.z.object({
   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`."
@@ -1489,8 +1486,12 @@ var phone_number = zod.z.coerce.string().trim().refine(
   }
 );
 var start_end_schedule = zod.z.object({
-  starts_at: zod.z.string().datetime(),
-  ends_at: zod.z.string().datetime()
+  starts_at: zod.z.string().datetime().describe(
+    "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
+  ),
+  ends_at: zod.z.string().datetime().describe(
+    "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
+  )
 });
 var schedule = start_end_schedule;
 
@@ -1626,12 +1627,16 @@ var common_acs_user = zod.z.object({
 var acs_user = common_acs_user.merge(
   zod.z.object({
     is_managed: zod.z.literal(true)
-  })
+  }).describe(
+    "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
+  )
 );
 var unmanaged_acs_user = common_acs_user.merge(
   zod.z.object({
     is_managed: zod.z.literal(false)
-  })
+  }).describe(
+    "Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
+  )
 );
 var common_action_attempt = zod.z.object({
   action_attempt_id: zod.z.string().uuid().describe(`
@@ -2890,7 +2895,7 @@ var openapi_default = {
         type: "object"
       },
       acs_access_group: {
-        description: "\n    Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n    \n    The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n  ",
+        description: "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\nThe `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
         properties: {
           access_group_type: {
             deprecated: true,
@@ -2901,12 +2906,12 @@ var openapi_default = {
               "brivo_group"
             ],
             type: "string",
-            "x-deprecated": "use external_type"
+            "x-deprecated": "Use `external_type`."
           },
           access_group_type_display_name: {
             deprecated: true,
             type: "string",
-            "x-deprecated": "use external_type_display_name"
+            "x-deprecated": "Use `external_type_display_name`."
           },
           acs_access_group_id: {
             description: "ID of the access group.",
@@ -2962,7 +2967,7 @@ var openapi_default = {
         type: "object"
       },
       acs_credential: {
-        description: "Means by which a user gains access at an entrance.\n\n      The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+        description: "Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
         properties: {
           access_method: {
             description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -3152,6 +3157,7 @@ var openapi_default = {
         type: "object"
       },
       acs_entrance: {
+        description: "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
         properties: {
           acs_entrance_id: {
             description: "ID of the entrance.",
@@ -3563,8 +3569,16 @@ var openapi_default = {
           access_schedule: {
             description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
             properties: {
-              ends_at: { format: "date-time", type: "string" },
-              starts_at: { format: "date-time", type: "string" }
+              ends_at: {
+                description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                format: "date-time",
+                type: "string"
+              },
+              starts_at: {
+                description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                format: "date-time",
+                type: "string"
+              }
             },
             required: ["starts_at", "ends_at"],
             type: "object"
@@ -4089,7 +4103,7 @@ var openapi_default = {
                     nullable: true,
                     oneOf: [
                       {
-                        description: "Means by which a user gains access at an entrance.\n\n      The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+                        description: "Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
                         properties: {
                           access_method: {
                             description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -4248,7 +4262,7 @@ var openapi_default = {
                         type: "object"
                       },
                       {
-                        description: "Means by which a user gains access at an entrance.\n\n      The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+                        description: "Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
                         properties: {
                           access_method: {
                             description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -4529,10 +4543,10 @@ var openapi_default = {
               action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
               error: { nullable: true },
               result: {
-                description: "Means by which a user gains access at an entrance.\n\n      The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+                description: "Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
                 oneOf: [
                   {
-                    description: "Means by which a user gains access at an entrance.\n\n      The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+                    description: "Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
                     properties: {
                       access_method: {
                         description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -4691,7 +4705,7 @@ var openapi_default = {
                     type: "object"
                   },
                   {
-                    description: "Means by which a user gains access at an entrance.\n\n      The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+                    description: "Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
                     properties: {
                       access_method: {
                         description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -9474,18 +9488,9 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
-                  allow_external_modification: { type: "boolean" },
-                  code: {
-                    maxLength: 9,
-                    minLength: 4,
-                    pattern: "^\\d+$",
-                    type: "string"
-                  },
                   common_code_key: { type: "string" },
                   ends_at: { type: "string" },
-                  is_external_modification_allowed: { type: "boolean" },
                   name: { type: "string" },
-                  prefer_native_scheduling: { type: "boolean" },
                   starts_at: { type: "string" }
                 },
                 required: ["common_code_key"],
@@ -9527,18 +9532,9 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
-                  allow_external_modification: { type: "boolean" },
-                  code: {
-                    maxLength: 9,
-                    minLength: 4,
-                    pattern: "^\\d+$",
-                    type: "string"
-                  },
                   common_code_key: { type: "string" },
                   ends_at: { type: "string" },
-                  is_external_modification_allowed: { type: "boolean" },
                   name: { type: "string" },
-                  prefer_native_scheduling: { type: "boolean" },
                   starts_at: { type: "string" }
                 },
                 required: ["common_code_key"],
@@ -10006,12 +10002,12 @@ var openapi_default = {
                             "brivo_group"
                           ],
                           type: "string",
-                          "x-deprecated": "use external_type"
+                          "x-deprecated": "Use `external_type`."
                         },
                         access_group_type_display_name: {
                           deprecated: true,
                           type: "string",
-                          "x-deprecated": "use external_type_display_name"
+                          "x-deprecated": "Use `external_type_display_name`."
                         },
                         acs_access_group_id: {
                           description: "ID of the access group.",
@@ -10138,12 +10134,12 @@ var openapi_default = {
                               "brivo_group"
                             ],
                             type: "string",
-                            "x-deprecated": "use external_type"
+                            "x-deprecated": "Use `external_type`."
                           },
                           access_group_type_display_name: {
                             deprecated: true,
                             type: "string",
-                            "x-deprecated": "use external_type_display_name"
+                            "x-deprecated": "Use `external_type_display_name`."
                           },
                           acs_access_group_id: {
                             description: "ID of the access group.",
@@ -11021,7 +11017,7 @@ var openapi_default = {
                 schema: {
                   properties: {
                     acs_credential: {
-                      description: "Means by which a user gains access at an entrance.\n\n      The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+                      description: "Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
                       properties: {
                         access_method: {
                           description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -11277,7 +11273,7 @@ var openapi_default = {
                   properties: {
                     acs_credentials: {
                       items: {
-                        description: "Means by which a user gains access at an entrance.\n\n      The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
+                        description: "Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
                         properties: {
                           access_method: {
                             description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -12789,8 +12785,16 @@ var openapi_default = {
                         access_schedule: {
                           description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
                           properties: {
-                            ends_at: { format: "date-time", type: "string" },
-                            starts_at: { format: "date-time", type: "string" }
+                            ends_at: {
+                              description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                              format: "date-time",
+                              type: "string"
+                            },
+                            starts_at: {
+                              description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                              format: "date-time",
+                              type: "string"
+                            }
                           },
                           required: ["starts_at", "ends_at"],
                           type: "object"
@@ -13139,8 +13143,13 @@ var openapi_default = {
                           access_schedule: {
                             description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
                             properties: {
-                              ends_at: { format: "date-time", type: "string" },
+                              ends_at: {
+                                description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                                format: "date-time",
+                                type: "string"
+                              },
                               starts_at: {
+                                description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                                 format: "date-time",
                                 type: "string"
                               }