@seamapi/types 1.368.0 → 1.369.1

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -104,7 +104,10 @@ export const acs_access_group = common_acs_access_group.extend({
     route_path: /acs/access_groups
     ---
     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).
+    
+    Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
+
+    To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
   `)
 export const unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(false),

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

@@ -289,7 +289,11 @@ export const acs_credential = common_acs_credential.merge(
   ---
   route_path: /acs/credentials
   ---
-  Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
+  Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+  An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
+
+  For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
 `)
 
 export const unmanaged_acs_credential = common_acs_credential.merge(

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

@@ -72,7 +72,20 @@ export const acs_encoder = z.object({
   ---
   route_path: /acs/encoders
   ---
-  Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
+  Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+  Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
+
+  1. Credential creation
+     Configure the access parameters for the credential.
+  2. Card encoding
+     Write the credential data onto the card using a compatible card encoder.
+
+  Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
+
+   See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
+
+  To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
 `)
 
 export type AcsEncoder = z.infer<typeof acs_encoder>

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

@@ -86,6 +86,8 @@ export const acs_entrance = z.object({
   route_path: /acs/entrances
   ---
   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).
+
+  In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the \`acs_entrance\` resources in your workspace or get these details for a specific \`acs_entrance\`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
 `)
 
 export type AcsEntrance = z.infer<typeof acs_entrance>

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

@@ -339,6 +339,10 @@ export const acs_system = z
     route_path: /acs/systems
     ---
     Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+    Within an \`acs_system\`, create [\`acs_user\`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [\`acs_credential\`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the \`acs_user\`s.
+
+    For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).
   `)
 
 export type AcsSystem = z.output<typeof acs_system>

package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts

@@ -342,6 +342,10 @@ export const acs_user = common_acs_user.merge(
   route_path: /acs/users
   ---
   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).
+
+  An \`acs_user\` typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
+
+  For details about how to configure \`acs_user\`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
 `)
 
 export const unmanaged_acs_user = common_acs_user.merge(

package/src/lib/seam/connect/models/action-attempts/common.ts

@@ -1,38 +1,61 @@
 import { z } from 'zod'
 
 export const common_action_attempt = z.object({
-  action_attempt_id: z.string().uuid().describe(`
-    ---
-    title: Action Attempt ID
-    ---
-    The ID of the action attempt.
-  `),
-  status: z.enum(['pending', 'success', 'error']),
+  action_attempt_id: z.string().uuid().describe('ID of the action attempt.'),
+  status: z
+    .enum(['pending', 'success', 'error'])
+    .describe('Status of the action attempt.'),
 })
 
 export const common_pending_action_attempt = common_action_attempt.extend({
   status: z.literal('pending'),
-  result: z.null(),
-  error: z.null(),
+  result: z
+    .null()
+    .describe(
+      'Result of the action attempt. Null for pending action attempts.',
+    ),
+  error: z
+    .null()
+    .describe(
+      'Errors associated with the action attempt. Null for pending action attempts.',
+    ),
 })
 
 export const common_succeeded_action_attempt = common_action_attempt.extend({
   status: z.literal('success'),
-  error: z.null(),
+  error: z
+    .null()
+    .describe(
+      'Errors associated with the action attempt. Null for successful action attempts.',
+    ),
 })
 
 export const common_failed_action_attempt = common_action_attempt.extend({
   status: z.literal('error'),
-  result: z.null(),
+  result: z
+    .null()
+    .describe('Result of the action attempt. Null for failed action attempts.'),
 })
 
 export const common_action_attempt_errors = [
-  z.object({
-    type: z.literal('uncategorized_error'),
-    message: z.string(),
-  }),
-  z.object({
-    type: z.literal('action_attempt_expired'),
-    message: z.string(),
-  }),
+  z
+    .object({
+      type: z
+        .literal('uncategorized_error')
+        .describe('Type of the error associated with the action attempt.'),
+      message: z
+        .string()
+        .describe('Message for the error associated with the action attempt.'),
+    })
+    .describe("Error that doesn't fit into other specific error categories."),
+  z
+    .object({
+      type: z
+        .literal('action_attempt_expired')
+        .describe('Type of the error associated with the action attempt.'),
+      message: z
+        .string()
+        .describe('Message for the error associated with the action attempt.'),
+    })
+    .describe('Error to indicate an expired action attempt.'),
 ] as const

package/src/lib/seam/connect/models/action-attempts/encode-credential.ts

@@ -11,7 +11,9 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('ENCODE_CREDENTIAL')
+const action_type = z
+  .literal('ENCODE_CREDENTIAL')
+  .describe('Type of action that the action attempt tracks.')
 
 const no_credential_on_encoder_error = z.object({
   type: z.literal('no_credential_on_encoder'),
@@ -35,23 +37,33 @@ const error = z.union([
   credential_cannot_be_reissued,
 ])
 
-const result = acs_credential.or(unmanaged_acs_credential)
+const result = acs_credential
+  .or(unmanaged_acs_credential)
+  .describe(
+    'If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card.',
+  )
 
 export const encode_credential_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Encoding credential data from physical encoder.'),
+    .describe(
+      'Action attempt to track encoding credential data from the physical encoder onto a card.',
+    ),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Encoding credential data from physical encoder succeeded.'),
+    .describe(
+      'Action attempt to indicate that encoding credential data from the physical encoder onto a card succeeded.',
+    ),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Encoding credential data from physical encoder failed.'),
+    .describe(
+      'Action attempt to indicate that encoding credential data from the physical encoder onto a card failed.',
+    ),
 ])
 
 export type EncodeCredentialActionAttempt = z.infer<