@seamapi/types 1.416.1 → 1.417.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.416.1",
+  "version": "1.417.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -92,7 +92,7 @@
     "zod": "^3.24.0"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^0.48.0",
+    "@seamapi/blueprint": "^0.49.0",
     "@types/node": "^20.8.10",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -510,7 +510,7 @@ export const access_code = z.object({
   type: z
     .enum(['time_bound', 'ongoing'])
     .describe(
-      'Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.',
+      'Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.',
     ),
   is_waiting_for_code_assignment: z
     .boolean()

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -6,14 +6,12 @@ export const access_grant = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'Unique identifier for the Seam workspace associated with the access grant.',
-    ),
+    .describe('ID of the Seam workspace associated with the access grant.'),
   access_grant_id: z.string().uuid().describe('ID of the access grant.'),
   user_identity_id: z
     .string()
     .uuid()
-    .describe('ID of user identity to which access is being granted.'),
+    .describe('ID of user identity to which the access grant gives access.'),
   location_ids: z.array(z.string().uuid()).describe(`
     ---
     deprecated: Use \`space_ids\`.
@@ -21,15 +19,13 @@ export const access_grant = z.object({
   `),
   space_ids: z
     .array(z.string().uuid())
-    .describe('IDs of the spaces to which access is being given.'),
+    .describe('IDs of the spaces to which the access grant gives access.'),
   requested_access_methods: z
     .array(requested_access_method)
-    .describe('Access methods that the user requested for this access grant.'),
+    .describe('Access methods that the user requested for the access grant.'),
   access_method_ids: z
     .array(z.string().uuid())
-    .describe(
-      'IDs of the access methods that were created for this access grant.',
-    ),
+    .describe('IDs of the access methods created for the access grant.'),
   display_name: z.string().describe('Display name of the access grant.'),
   created_at: z
     .string()
@@ -40,6 +36,7 @@ export const access_grant = z.object({
   draft: Early access.
   route_path: /access_grants
   ---
+  Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant.
   `)
 
 export type AccessGrant = z.infer<typeof access_grant>

package/src/lib/seam/connect/models/access-grants/access-method.ts

@@ -4,9 +4,7 @@ export const access_method = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'Unique identifier for the Seam workspace associated with the access grant.',
-    ),
+    .describe('ID of the Seam workspace associated with the access method.'),
   access_method_id: z.string().uuid().describe('ID of the access method.'),
   display_name: z.string().describe('Display name of the access method.'),
   mode: z
@@ -26,18 +24,19 @@ export const access_method = z.object({
   instant_key_url: z
     .string()
     .optional()
-    .describe('URL of instant key for mobile key access methods.'),
+    .describe('URL of the Instant Key for mobile key access methods.'),
   is_card_encoding_required: z
     .boolean()
     .optional()
     .describe(
-      'Whether card encoding is required for plastic card access methods.',
+      'Indicates whether card encoding is required for plastic card access methods.',
     ),
 }).describe(`
   ---
   draft: Early access.
   route_path: /access_methods
   ---
+  Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
   `)
 
 export type AccessMethod = z.infer<typeof access_method>

package/src/lib/seam/connect/models/access-grants/requested-access-method.ts

@@ -11,12 +11,12 @@ export const requested_access_method = z.object({
     .string()
     .datetime()
     .describe(
-      'Date and time at which the requested access method was added to this access grant.',
+      'Date and time at which the requested access method was added to the access grant.',
     ),
   created_access_method_ids: z
     .array(z.string().uuid())
     .describe(
-      'IDs of the access methods that were created for this requested access method.',
+      'IDs of the access methods created for the requested access method.',
     ),
 })
 

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

@@ -17,7 +17,8 @@ export const acs_credential_pool = z.object({
 }).describe(`
   ---
   route_path: /acs/credential_pools
-  undocumented: Will be removed.
+  deprecated: Not used.
+  undocumented: Deprecated. Will be removed.
   ---
 `)
 

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

@@ -9,7 +9,8 @@ export const acs_credential_provisioning_automation = z.object({
 }).describe(`
   ---
   route_path: /acs/credential_provisioning_automations
-  undocumented: Will be removed.
+  deprecated: Not used.
+  undocumented: Deprecated. Will be removed.
   ---
 `)
 

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

@@ -33,6 +33,12 @@ export const acs_entrance = z.object({
     .describe(
       'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
     ),
+  connected_account_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+    ),
   errors: z
     .array(
       z.object({

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

@@ -33,7 +33,7 @@ const acs_users_deleted_externally = common_acs_user_error
     error_code: z.literal('deleted_externally'),
   })
   .describe(
-    `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.`,
+    `Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.`,
   )
 
 const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
@@ -41,7 +41,7 @@ const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
     error_code: z.literal('salto_ks_subscription_limit_exceeded'),
   })
   .describe(
-    `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.`,
+    `Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.`,
   )
 
 const acs_users_failed_to_create_on_acs_system = common_acs_user_error
@@ -49,7 +49,7 @@ const acs_users_failed_to_create_on_acs_system = common_acs_user_error
     error_code: z.literal('failed_to_create_on_acs_system'),
   })
   .describe(
-    `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
+    `Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
   )
 
 const acs_users_failed_to_update_on_acs_system = common_acs_user_error
@@ -57,7 +57,7 @@ const acs_users_failed_to_update_on_acs_system = common_acs_user_error
     error_code: z.literal('failed_to_update_on_acs_system'),
   })
   .describe(
-    `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
+    `Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
   )
 
 const acs_users_failed_to_delete_on_acs_system = common_acs_user_error
@@ -65,7 +65,7 @@ const acs_users_failed_to_delete_on_acs_system = common_acs_user_error
     error_code: z.literal('failed_to_delete_on_acs_system'),
   })
   .describe(
-    `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
+    `Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
   )
 
 const acs_users_latch_conflict_with_resident_user = common_acs_user_error
@@ -73,7 +73,7 @@ const acs_users_latch_conflict_with_resident_user = common_acs_user_error
     error_code: z.literal('latch_conflict_with_resident_user'),
   })
   .describe(
-    `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).`,
+    `Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).`,
   )
 
 const acs_user_errors = z
@@ -86,7 +86,7 @@ const acs_user_errors = z
     acs_users_latch_conflict_with_resident_user,
   ])
   .describe(
-    'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+    'Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
   )
 
 export const acs_users_error_map = z.object({
@@ -126,7 +126,7 @@ const acs_users_being_deleted = common_acs_user_warning
     warning_code: z.literal('being_deleted'),
   })
   .describe(
-    'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.',
+    'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the access system user will be deleted shortly.',
   )
 
 const acs_users_salto_ks_user_not_subscribed = common_acs_user_warning
@@ -134,7 +134,7 @@ const acs_users_salto_ks_user_not_subscribed = common_acs_user_warning
     warning_code: z.literal('salto_ks_user_not_subscribed'),
   })
   .describe(
-    'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.',
+    'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.',
   )
 
 export const unknown_issue_with_acs_user = common_acs_user_warning
@@ -142,7 +142,7 @@ export const unknown_issue_with_acs_user = common_acs_user_warning
     warning_code: z.literal('unknown_issue_with_acs_user'),
   })
   .describe(
-    'An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.',
+    'An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.',
   )
 
 export const latch_resident_user = common_acs_user_warning
@@ -150,7 +150,7 @@ export const latch_resident_user = common_acs_user_warning
     warning_code: z.literal('latch_resident_user'),
   })
   .describe(
-    'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.',
+    'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.',
   )
 
 export const acs_users_warning_map = z.object({
@@ -172,7 +172,7 @@ export const acs_users_warnings = z
     latch_resident_user,
   ])
   .describe(
-    'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+    'Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
   )
 
 export type AcsUsersWarningMap = z.infer<typeof acs_users_warning_map>
@@ -184,7 +184,7 @@ const user_fields = z.object({
     .min(1)
     .optional()
     .describe(
-      'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+      'Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
     ),
   email: z.string().email().optional().describe(`
     ---
@@ -196,12 +196,12 @@ const user_fields = z.object({
     .email()
     .optional()
     .describe(
-      'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+      'Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
     ),
   phone_number: phone_number
     .optional()
     .describe(
-      'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
+      'Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
     ),
 })
 
@@ -211,105 +211,105 @@ const common_acs_user = z
       .string()
       .uuid()
       .describe(
-        'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     acs_system_id: z
       .string()
       .uuid()
       .describe(
-        'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     hid_acs_system_id: z.string().uuid().optional(),
     workspace_id: z
       .string()
       .uuid()
       .describe(
-        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     created_at: z
       .string()
       .datetime()
       .describe(
-        'Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
+        'Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
       ),
     display_name: z
       .string()
       .describe(
-        'Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     external_type: acs_user_external_type
       .optional()
       .describe(
-        'Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
+        'Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
       ),
     external_type_display_name: z
       .string()
       .optional()
       .describe(
-        'Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
+        'Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
       ),
     is_suspended: z
       .boolean()
       .optional()
       .describe(
-        'Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
+        'Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
       ),
     access_schedule: schedule
       .optional()
       .describe(
-        "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
+        "`starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
       ),
     user_identity_id: z
       .string()
       .optional()
       .describe(
-        'ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'ID of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     user_identity_full_name: z
       .string()
       .nullable()
       .optional()
       .describe(
-        'Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'Full name of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     user_identity_email_address: z
       .string()
       .nullable()
       .optional()
       .describe(
-        'Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'Email address of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     user_identity_phone_number: z
       .string()
       .nullable()
       .optional()
       .describe(
-        'Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
+        'Phone number of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
       ),
     warnings: z
       .array(acs_users_warnings)
       .describe(
-        'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     errors: z
       .array(acs_user_errors)
       .describe(
-        'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+        'Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
     pending_mutations: z
       .array(acs_user_pending_mutations)
       .optional()
       .describe(
-        'Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.',
+        'Pending mutations associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.',
       ),
     last_successful_sync_at: z.string().datetime().nullable().describe(`
         ---
         undocumented: Only used internally.
         ---
-        The last time an internal sync job completed for this ACS user.
+        The last time an internal sync job completed for this access system user.
       `),
     connected_account_id: z.string().uuid().describe(`
-      The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+      The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
     `),
   })
   .merge(user_fields)
@@ -322,11 +322,11 @@ 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).
+  Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access 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.
+  An access system 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).
+  For details about how to configure users in your access 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(
@@ -338,7 +338,7 @@ export const unmanaged_acs_user = common_acs_user.merge(
   route_path: /acs/users/unmanaged
   undocumented: Unreleased.
   ---
-  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).
+  Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).
 `)
 
 export type AcsUser = z.output<typeof acs_user>

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

@@ -12,7 +12,11 @@ const common_pending_mutation = z.object({
 
 const creating = common_pending_mutation
   .extend({
-    mutation_code: z.literal('creating'),
+    mutation_code: z
+      .literal('creating')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system.',
+      ),
   })
   .describe(
     'Seam is in the process of pushing a user creation to the integrated access system.',
@@ -20,35 +24,69 @@ const creating = common_pending_mutation
 
 const deleting = common_pending_mutation
   .extend({
-    mutation_code: z.literal('deleting'),
+    mutation_code: z
+      .literal('deleting')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system.',
+      ),
   })
   .describe(
     'Seam is in the process of pushing a user deletion to the integrated access system.',
   )
 
 const acs_user_info = z.object({
-  email_address: z.string().email().nullable(),
-  full_name: z.string().nullable(),
-  phone_number: phone_number.optional().nullable(),
+  email_address: z
+    .string()
+    .email()
+    .nullable()
+    .describe('Email address of the access system user.'),
+  full_name: z
+    .string()
+    .nullable()
+    .describe('Full name of the access system user.'),
+  phone_number: phone_number
+    .optional()
+    .nullable()
+    .describe('Phone number of the access system user.'),
 })
 
 export const updating_user_information_mutation =
   common_pending_mutation.extend({
-    mutation_code: z.literal('updating_user_information'),
-    from: acs_user_info.partial(),
-    to: acs_user_info.partial(),
+    mutation_code: z
+      .literal('updating_user_information')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system.',
+      ),
+    from: acs_user_info
+      .partial()
+      .describe('Old access system user information.'),
+    to: acs_user_info.partial().describe('New access system user information.'),
   })
 
-const access_schedule = z.object({
-  starts_at: z.string().datetime().nullable(),
-  ends_at: z.string().datetime().nullable(),
-})
+const access_schedule = z
+  .object({
+    starts_at: z
+      .string()
+      .datetime()
+      .nullable()
+      .describe('Starting time for the access schedule.'),
+    ends_at: z
+      .string()
+      .datetime()
+      .nullable()
+      .describe('Starting time for the access schedule.'),
+  })
+  .describe('Access schedule involved in the mutation.')
 
 const updating_access_schedule_mutation = common_pending_mutation
   .extend({
-    mutation_code: z.literal('updating_access_schedule'),
-    from: access_schedule,
-    to: access_schedule,
+    mutation_code: z
+      .literal('updating_access_schedule')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.',
+      ),
+    from: access_schedule.describe('Old access schedule information.'),
+    to: access_schedule.describe('New access schedule information.'),
   })
   .describe(
     'Seam is in the process of pushing an access schedule update to the integrated access system.',
@@ -56,9 +94,17 @@ const updating_access_schedule_mutation = common_pending_mutation
 
 const updating_suspension_state_mutation = common_pending_mutation
   .extend({
-    mutation_code: z.literal('updating_suspension_state'),
-    from: z.object({ is_suspended: z.boolean() }),
-    to: z.object({ is_suspended: z.boolean() }),
+    mutation_code: z
+      .literal('updating_suspension_state')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system.',
+      ),
+    from: z
+      .object({ is_suspended: z.boolean() })
+      .describe('Old user suspension state information.'),
+    to: z
+      .object({ is_suspended: z.boolean() })
+      .describe('New user suspension state information.'),
   })
   .describe(
     'Seam is in the process of pushing a suspension state update to the integrated access system.',
@@ -66,7 +112,11 @@ const updating_suspension_state_mutation = common_pending_mutation
 
 const updating_group_membership_mutation = common_pending_mutation
   .extend({
-    mutation_code: z.literal('updating_group_membership'),
+    mutation_code: z
+      .literal('updating_group_membership')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system.',
+      ),
     from: z
       .object({
         acs_access_group_id: z