@seamapi/types 1.360.0 → 1.360.1

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

@@ -5,25 +5,25 @@ export const acs_system_capability_flags = z.object({
     .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`.',
+      'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/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 [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
     ),
   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).',
+      'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) 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).',
+      'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) 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).',
+      'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) 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).',
     ),
 })
 
@@ -31,7 +31,9 @@ export const location = z.object({
   time_zone: z
     .string()
     .nullable()
-    .describe('Time zone in which the `acs_system` is located.'),
+    .describe(
+      'Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.',
+    ),
 })
 
 // If changed, update seam.acs_system.external_type generated column
@@ -67,14 +69,16 @@ const common_acs_system_error = z.object({
 
 const error_code_description =
   'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+const warning_code_description =
+  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
 
 const seam_bridge_disconnected = common_acs_system_error.extend({
   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).
+  .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
+  This error might also occur if 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({
@@ -82,7 +86,7 @@ const visionline_instance_unreachable = common_acs_system_error.extend({
     .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).
+  .describe(`Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with 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).`)
 
@@ -103,7 +107,7 @@ const acs_system_disconnected = common_acs_system_error
       .describe(error_code_description),
   })
   .describe(
-    'Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
+    'Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue.',
   )
 
 const account_disconnected = common_acs_system_error
@@ -113,16 +117,18 @@ const account_disconnected = common_acs_system_error
       .describe(error_code_description),
   })
   .describe(
-    'Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access.',
+    'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.',
   )
 
-const salto_ks_certification_expired = common_acs_system_error.extend({
-  error_code: z
-    .literal('salto_ks_certification_expired')
-    .describe(
-      'Indicates that the access system has lost its Salto KS certification. Please contact support to regain access.',
-    ),
-})
+const salto_ks_certification_expired = common_acs_system_error
+  .extend({
+    error_code: z
+      .literal('salto_ks_certification_expired')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.',
+  )
 const acs_system_error = z
   .discriminatedUnion('error_code', [
     seam_bridge_disconnected,
@@ -132,7 +138,9 @@ const acs_system_error = z
     account_disconnected,
     salto_ks_certification_expired,
   ])
-  .describe('Error associated with the `acs_system`.')
+  .describe(
+    'Error associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+  )
 
 export const acs_system_error_map = z.object({
   seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
@@ -163,30 +171,35 @@ const common_acs_system_warning = z.object({
     ),
 })
 
-const salto_ks_subscription_limit_almost_reached =
-  common_acs_system_warning.extend({
+const salto_ks_subscription_limit_almost_reached = common_acs_system_warning
+  .extend({
     warning_code: z
       .literal('salto_ks_subscription_limit_almost_reached')
-      .describe(
-        'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
-      ),
+      .describe(warning_code_description),
   })
+  .describe(
+    'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.',
+  )
 
-const time_zone_does_not_match_location = common_acs_system_warning.extend({
-  warning_code: z
-    .literal('time_zone_does_not_match_location')
-    .describe(
-      'Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.',
-    ),
-  misconfigured_acs_entrance_ids: z.array(z.string().uuid()).optional(),
-})
+const time_zone_does_not_match_location = common_acs_system_warning
+  .extend({
+    warning_code: z
+      .literal('time_zone_does_not_match_location')
+      .describe(warning_code_description),
+    misconfigured_acs_entrance_ids: z.array(z.string().uuid()).optional(),
+  })
+  .describe(
+    'Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+  )
 
 const acs_system_warning = z
   .discriminatedUnion('warning_code', [
     salto_ks_subscription_limit_almost_reached,
     time_zone_does_not_match_location,
   ])
-  .describe('Warning associated with the `acs_system`.')
+  .describe(
+    'Warning associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+  )
 
 export const acs_system_warning_map = z.object({
   salto_ks_subscription_limit_almost_reached:
@@ -206,26 +219,28 @@ export const acs_system = z
       .nullable()
       .optional()
       .describe(
-        `
-        ---
-        draft: Needs review
-        ---
-        ID of the default credential manager acs_system for this access control system.
-        `,
+        'ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+      ),
+    acs_system_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
       ),
-    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.')
+      .describe(
+        'Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.',
+      )
       .optional(),
     external_type_display_name: z
       .string()
       .describe(
-        'Display name that corresponds to the brand-specific terminology for the `acs_system` type.',
+        'Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.',
       )
       .optional(),
     is_credential_manager: z
       .boolean()
-      .describe('Indicates if the `acs_system` is a credential manager.'),
+      .describe('Indicates whether the `acs_system` is a credential manager.'),
     visionline_metadata: z
       .object({
         mobile_access_uuid: z
@@ -241,7 +256,7 @@ export const acs_system = z
         lan_address: z
           .string()
           .describe(
-            'IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.',
+            'IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network.',
           ),
       })
       .optional(),
@@ -260,41 +275,55 @@ export const acs_system = z
       ---
       `),
     location,
-    name: z.string().describe('Name of the `acs_system`.'),
+    name: z
+      .string()
+      .describe(
+        'Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+      ),
     created_at: z
       .string()
       .datetime()
-      .describe('Date and time at which the `acs_system` was created.'),
+      .describe(
+        'Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) 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`.',
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
       ),
     connected_account_ids: z.array(z.string().uuid()).describe(`
       ---
       deprecated: Use \`connected_account_id\`.
       ---
-      IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the \`acs_system\`.
+      IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
       `),
     connected_account_id: z
       .string()
       .uuid()
       .describe(
-        'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.',
+        'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
       ),
     image_url: z
       .string()
-      .describe('URL for the image that represents the `acs_system`.'),
+      .describe(
+        'URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+      ),
     image_alt_text: z
       .string()
-      .describe('Alternative text for the `acs_system` image.'),
+      .describe(
+        'Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.',
+      ),
     errors: z
       .array(acs_system_error)
-      .describe('Errors associated with the `acs_system`.'),
+      .describe(
+        'Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+      ),
     warnings: z
       .array(acs_system_warning)
-      .describe('Warnings associated with the `acs_system`.'),
+      .describe(
+        'Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+      ),
   })
   .merge(acs_system_capability_flags).describe(`
     ---

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

@@ -32,7 +32,7 @@ const acs_users_deleted_externally = common_acs_user_error
     error_code: z.literal('deleted_externally'),
   })
   .describe(
-    `Indicates that the ACS user was deleted from the ACS system outside of Seam.`,
+    `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.`,
   )
 
 const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
@@ -40,7 +40,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 user could not be subscribed on Salto KS because the subscription limit has been exceeded.`,
+    `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.`,
   )
 
 const acs_users_failed_to_create_on_acs_system = common_acs_user_error
@@ -48,7 +48,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 user was not created on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
+    `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).`,
   )
 
 const acs_users_failed_to_update_on_acs_system = common_acs_user_error
@@ -56,7 +56,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 user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
+    `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).`,
   )
 
 const acs_users_failed_to_delete_on_acs_system = common_acs_user_error
@@ -64,7 +64,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 user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
+    `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).`,
   )
 
 const acs_user_errors = z
@@ -75,7 +75,9 @@ const acs_user_errors = z
     acs_users_failed_to_update_on_acs_system,
     acs_users_failed_to_delete_on_acs_system,
   ])
-  .describe('Error associated with the `acs_user`.')
+  .describe(
+    'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+  )
 
 export const acs_users_error_map = z.object({
   deleted_externally: acs_users_deleted_externally.optional().nullable(),
@@ -95,8 +97,15 @@ export const acs_users_error_map = z.object({
 export type AcsUsersErrorMap = z.infer<typeof acs_users_error_map>
 
 const common_acs_user_warning = z.object({
-  created_at: z.string().datetime(),
-  message: z.string(),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the warning.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+    ),
 })
 
 const acs_users_being_deleted = common_acs_user_warning
@@ -104,7 +113,7 @@ const acs_users_being_deleted = common_acs_user_warning
     warning_code: z.literal('being_deleted'),
   })
   .describe(
-    `Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.`,
+    '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.',
   )
 
 const acs_users_salto_ks_user_not_subscribed = common_acs_user_warning
@@ -112,7 +121,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 user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn’t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.`,
+    '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.',
   )
 
 export const unknown_issue_with_acs_user = common_acs_user_warning
@@ -120,7 +129,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 user with the provider. ' +
+    '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.',
   )
 
@@ -140,7 +149,9 @@ export const acs_users_warnings = z
     acs_users_salto_ks_user_not_subscribed,
     unknown_issue_with_acs_user,
   ])
-  .describe('Warning associated with the `acs_user`.')
+  .describe(
+    'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+  )
 
 export type AcsUsersWarningMap = z.infer<typeof acs_users_warning_map>
 
@@ -157,7 +168,7 @@ const acs_user_suspension_state_modification = common_acs_user_modification
     modification_code: z.literal('suspension_state'),
   })
   .describe(
-    "Indicates that the acs_user's is_suspended state was updated on Seam and will soon be applied on the user on the ACS System",
+    "Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) `is_suspended` state was updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
   )
 
 const acs_user_profile_modification = common_acs_user_modification
@@ -165,7 +176,7 @@ const acs_user_profile_modification = common_acs_user_modification
     modification_code: z.literal('profile'),
   })
   .describe(
-    "Indicates that the acs_user's profile details (name, email, phone) were updated on Seam and will soon be applied on the user on the ACS System",
+    "Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) profile details (name, email, phone) were updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
   )
 
 export const acs_user_unapplied_modification_map = z.object({
@@ -180,7 +191,12 @@ export type AcsUserUnappliedModificationMap = z.infer<
 >
 
 const user_fields = z.object({
-  full_name: z.string().optional().describe('Full name of the `acs_user`.'),
+  full_name: z
+    .string()
+    .optional()
+    .describe(
+      'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+    ),
   email: z.string().email().optional().describe(`
     ---
     deprecated: use email_address.
@@ -190,79 +206,96 @@ const user_fields = z.object({
     .string()
     .email()
     .optional()
-    .describe('Email address of the `acs_user`.'),
+    .describe(
+      'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+    ),
   phone_number: phone_number
     .optional()
     .describe(
-      'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
+      'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
     ),
 })
 
 const common_acs_user = z
   .object({
-    acs_user_id: z.string().uuid().describe('ID of the `acs_user`.'),
+    acs_user_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [ACS 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 that contains the `acs_user`.',
+        '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).',
       ),
     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`.',
+        '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).',
       ),
     created_at: z
       .string()
       .datetime()
-      .describe('Date and time at which the `acs_user` was created.'),
-    display_name: z.string().describe('Display name for the `acs_user`.'),
+      .describe(
+        'Date and time at which the [ACS 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).',
+      ),
     external_type: acs_user_external_type
       .optional()
-      .describe('Brand-specific terminology for the `acs_user` type.'),
+      .describe(
+        'Brand-specific terminology for the [ACS 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` type.',
+        '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.',
       ),
     is_suspended: z
       .boolean()
       .optional()
       .describe(
-        'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
+        '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).',
       ),
     access_schedule: schedule
       .optional()
       .describe(
-        "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
+        "`starts_at` and `ends_at` timestamps for the [ACS 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`.'),
+      .describe(
+        'ID of the user identity associated with the [ACS 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`.',
+        'Full name of the user identity associated with the [ACS 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`.',
+        'Email address of the user identity associated with the [ACS 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` in E.164 format (for example, `+15555550100`).',
+        '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`).',
       ),
     latest_desired_state_synced_with_provider_at: z
       .string()
@@ -283,10 +316,14 @@ const common_acs_user = z
       `),
     warnings: z
       .array(acs_users_warnings)
-      .describe('Warnings associated with the `acs_user`.'),
+      .describe(
+        'Warnings associated with the [ACS 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`.'),
+      .describe(
+        'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
+      ),
   })
   .merge(user_fields)
 

package/src/lib/seam/connect/models/thermostats/climate-preset.ts

@@ -5,24 +5,36 @@ import { fan_mode_setting, hvac_mode_setting } from './modes.js'
 export const climate_preset = z.object({
   climate_preset_key: z
     .string()
-    .describe('Unique key to identify the climate preset.'),
+    .describe(
+      'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
   can_edit: z
     .boolean()
-    .describe('Indicates whether this climate preset key can be edited.'),
+    .describe(
+      'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
+    ),
   can_delete: z
     .boolean()
-    .describe('Indicates whether this climate preset key can be deleted.'),
+    .describe(
+      'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
+    ),
   name: z
     .string()
     .nullable()
     .default(null)
     .optional()
-    .describe('User-friendly name to identify the climate preset.'),
-  display_name: z.string().describe('Display name for the climate preset.'),
+    .describe(
+      'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
+  display_name: z
+    .string()
+    .describe(
+      'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
   fan_mode_setting: fan_mode_setting
     .optional()
     .describe(
-      'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
+      'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
     ),
   hvac_mode_setting: hvac_mode_setting
     .optional()
@@ -38,21 +50,27 @@ export const climate_preset = z.object({
   heating_set_point_celsius: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should heat (in °C).'),
+    .describe(
+      'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   cooling_set_point_fahrenheit: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should cool (in °F).'),
+    .describe(
+      'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   heating_set_point_fahrenheit: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should heat (in °F).'),
+    .describe(
+      'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   manual_override_allowed: z.boolean().describe(
     `
       ---
       deprecated: Use 'thermostat_schedule.is_override_allowed'
       ---
-      Indicates whether a person at the thermostat can change the thermostat's settings.`,
+      Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).`,
   ),
 })