@seamapi/types 1.246.0 → 1.247.1

package/lib/seam/connect/route-types.d.ts

@@ -2318,25 +2318,41 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_users: Array<{
+                /** ID of the `acs_user`. */
                 acs_user_id: string;
+                /** ID of the access control system that contains the `acs_user`. */
                 acs_system_id: string;
                 hid_acs_system_id?: string | undefined;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
                 workspace_id: string;
+                /** Date and time at which the `acs_user` was created. */
                 created_at: string;
+                /** Display name for the `acs_user`. */
                 display_name: string;
+                /** Brand-specific terminology for the `acs_user` type. */
                 external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
                 external_type_display_name?: string | undefined;
+                /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
                 is_suspended: boolean;
+                /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
                     starts_at: string;
                     ends_at: string;
                 } | undefined;
+                /** ID of the user identity associated with the `acs_user`. */
                 user_identity_id?: string | undefined;
+                /** Full name of the user identity associated with the `acs_user`. */
                 user_identity_full_name?: (string | null) | undefined;
+                /** Email address of the user identity associated with the `acs_user`. */
                 user_identity_email_address?: (string | null) | undefined;
+                /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
                 user_identity_phone_number?: (string | null) | undefined;
+                /**  */
                 latest_desired_state_synced_with_provider_at?: string | undefined;
+                /**  */
                 is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                /** Warnings associated with the `acs_user`. */
                 warnings: Array<{
                     created_at: string;
                     message: string;
@@ -2346,6 +2362,7 @@ export interface Routes {
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
                 }>;
+                /** Errors associated with the `acs_user`. */
                 errors: Array<{
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -2377,11 +2394,14 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /** Full name of the `acs_user`. */
                 full_name?: string | undefined;
                 /**
                  * @deprecated use email_address. */
                 email?: string | undefined;
+                /** Email address of the `acs_user`. */
                 email_address?: string | undefined;
+                /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
                 phone_number?: string | undefined;
                 is_managed: true;
             }>;
@@ -3449,36 +3469,55 @@ export interface Routes {
                 starts_at: string;
                 ends_at: string;
             } | undefined;
+            /** Full name of the `acs_user`. */
             full_name?: string | undefined;
             /**
              * @deprecated use email_address. */
             email?: string | undefined;
+            /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
             phone_number?: string | undefined;
+            /** Email address of the `acs_user`. */
             email_address?: string | undefined;
         };
         commonParams: {};
         formData: {};
         jsonResponse: {
             acs_user: {
+                /** ID of the `acs_user`. */
                 acs_user_id: string;
+                /** ID of the access control system that contains the `acs_user`. */
                 acs_system_id: string;
                 hid_acs_system_id?: string | undefined;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
                 workspace_id: string;
+                /** Date and time at which the `acs_user` was created. */
                 created_at: string;
+                /** Display name for the `acs_user`. */
                 display_name: string;
+                /** Brand-specific terminology for the `acs_user` type. */
                 external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
                 external_type_display_name?: string | undefined;
+                /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
                 is_suspended: boolean;
+                /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
                     starts_at: string;
                     ends_at: string;
                 } | undefined;
+                /** ID of the user identity associated with the `acs_user`. */
                 user_identity_id?: string | undefined;
+                /** Full name of the user identity associated with the `acs_user`. */
                 user_identity_full_name?: (string | null) | undefined;
+                /** Email address of the user identity associated with the `acs_user`. */
                 user_identity_email_address?: (string | null) | undefined;
+                /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
                 user_identity_phone_number?: (string | null) | undefined;
+                /**  */
                 latest_desired_state_synced_with_provider_at?: string | undefined;
+                /**  */
                 is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                /** Warnings associated with the `acs_user`. */
                 warnings: Array<{
                     created_at: string;
                     message: string;
@@ -3488,6 +3527,7 @@ export interface Routes {
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
                 }>;
+                /** Errors associated with the `acs_user`. */
                 errors: Array<{
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3519,11 +3559,14 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /** Full name of the `acs_user`. */
                 full_name?: string | undefined;
                 /**
                  * @deprecated use email_address. */
                 email?: string | undefined;
+                /** Email address of the `acs_user`. */
                 email_address?: string | undefined;
+                /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
                 phone_number?: string | undefined;
                 is_managed: true;
             };
@@ -3553,25 +3596,41 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_user: {
+                /** ID of the `acs_user`. */
                 acs_user_id: string;
+                /** ID of the access control system that contains the `acs_user`. */
                 acs_system_id: string;
                 hid_acs_system_id?: string | undefined;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
                 workspace_id: string;
+                /** Date and time at which the `acs_user` was created. */
                 created_at: string;
+                /** Display name for the `acs_user`. */
                 display_name: string;
+                /** Brand-specific terminology for the `acs_user` type. */
                 external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
                 external_type_display_name?: string | undefined;
+                /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
                 is_suspended: boolean;
+                /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
                     starts_at: string;
                     ends_at: string;
                 } | undefined;
+                /** ID of the user identity associated with the `acs_user`. */
                 user_identity_id?: string | undefined;
+                /** Full name of the user identity associated with the `acs_user`. */
                 user_identity_full_name?: (string | null) | undefined;
+                /** Email address of the user identity associated with the `acs_user`. */
                 user_identity_email_address?: (string | null) | undefined;
+                /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
                 user_identity_phone_number?: (string | null) | undefined;
+                /**  */
                 latest_desired_state_synced_with_provider_at?: string | undefined;
+                /**  */
                 is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                /** Warnings associated with the `acs_user`. */
                 warnings: Array<{
                     created_at: string;
                     message: string;
@@ -3581,6 +3640,7 @@ export interface Routes {
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
                 }>;
+                /** Errors associated with the `acs_user`. */
                 errors: Array<{
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3612,11 +3672,14 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /** Full name of the `acs_user`. */
                 full_name?: string | undefined;
                 /**
                  * @deprecated use email_address. */
                 email?: string | undefined;
+                /** Email address of the `acs_user`. */
                 email_address?: string | undefined;
+                /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
                 phone_number?: string | undefined;
                 is_managed: true;
             };
@@ -3642,25 +3705,41 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_users: Array<{
+                /** ID of the `acs_user`. */
                 acs_user_id: string;
+                /** ID of the access control system that contains the `acs_user`. */
                 acs_system_id: string;
                 hid_acs_system_id?: string | undefined;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
                 workspace_id: string;
+                /** Date and time at which the `acs_user` was created. */
                 created_at: string;
+                /** Display name for the `acs_user`. */
                 display_name: string;
+                /** Brand-specific terminology for the `acs_user` type. */
                 external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
                 external_type_display_name?: string | undefined;
+                /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
                 is_suspended: boolean;
+                /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
                     starts_at: string;
                     ends_at: string;
                 } | undefined;
+                /** ID of the user identity associated with the `acs_user`. */
                 user_identity_id?: string | undefined;
+                /** Full name of the user identity associated with the `acs_user`. */
                 user_identity_full_name?: (string | null) | undefined;
+                /** Email address of the user identity associated with the `acs_user`. */
                 user_identity_email_address?: (string | null) | undefined;
+                /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
                 user_identity_phone_number?: (string | null) | undefined;
+                /**  */
                 latest_desired_state_synced_with_provider_at?: string | undefined;
+                /**  */
                 is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                /** Warnings associated with the `acs_user`. */
                 warnings: Array<{
                     created_at: string;
                     message: string;
@@ -3670,6 +3749,7 @@ export interface Routes {
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
                 }>;
+                /** Errors associated with the `acs_user`. */
                 errors: Array<{
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3701,11 +3781,14 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /** Full name of the `acs_user`. */
                 full_name?: string | undefined;
                 /**
                  * @deprecated use email_address. */
                 email?: string | undefined;
+                /** Email address of the `acs_user`. */
                 email_address?: string | undefined;
+                /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
                 phone_number?: string | undefined;
                 is_managed: true;
             }>;
@@ -3797,25 +3880,41 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_user: {
+                /** ID of the `acs_user`. */
                 acs_user_id: string;
+                /** ID of the access control system that contains the `acs_user`. */
                 acs_system_id: string;
                 hid_acs_system_id?: string | undefined;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
                 workspace_id: string;
+                /** Date and time at which the `acs_user` was created. */
                 created_at: string;
+                /** Display name for the `acs_user`. */
                 display_name: string;
+                /** Brand-specific terminology for the `acs_user` type. */
                 external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
                 external_type_display_name?: string | undefined;
+                /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
                 is_suspended: boolean;
+                /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
                     starts_at: string;
                     ends_at: string;
                 } | undefined;
+                /** ID of the user identity associated with the `acs_user`. */
                 user_identity_id?: string | undefined;
+                /** Full name of the user identity associated with the `acs_user`. */
                 user_identity_full_name?: (string | null) | undefined;
+                /** Email address of the user identity associated with the `acs_user`. */
                 user_identity_email_address?: (string | null) | undefined;
+                /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
                 user_identity_phone_number?: (string | null) | undefined;
+                /**  */
                 latest_desired_state_synced_with_provider_at?: string | undefined;
+                /**  */
                 is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                /** Warnings associated with the `acs_user`. */
                 warnings: Array<{
                     created_at: string;
                     message: string;
@@ -3825,6 +3924,7 @@ export interface Routes {
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
                 }>;
+                /** Errors associated with the `acs_user`. */
                 errors: Array<{
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3856,11 +3956,14 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /** Full name of the `acs_user`. */
                 full_name?: string | undefined;
                 /**
                  * @deprecated use email_address. */
                 email?: string | undefined;
+                /** Email address of the `acs_user`. */
                 email_address?: string | undefined;
+                /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
                 phone_number?: string | undefined;
                 is_managed: false;
             };
@@ -3881,25 +3984,41 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_users: Array<{
+                /** ID of the `acs_user`. */
                 acs_user_id: string;
+                /** ID of the access control system that contains the `acs_user`. */
                 acs_system_id: string;
                 hid_acs_system_id?: string | undefined;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
                 workspace_id: string;
+                /** Date and time at which the `acs_user` was created. */
                 created_at: string;
+                /** Display name for the `acs_user`. */
                 display_name: string;
+                /** Brand-specific terminology for the `acs_user` type. */
                 external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
                 external_type_display_name?: string | undefined;
+                /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
                 is_suspended: boolean;
+                /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
                     starts_at: string;
                     ends_at: string;
                 } | undefined;
+                /** ID of the user identity associated with the `acs_user`. */
                 user_identity_id?: string | undefined;
+                /** Full name of the user identity associated with the `acs_user`. */
                 user_identity_full_name?: (string | null) | undefined;
+                /** Email address of the user identity associated with the `acs_user`. */
                 user_identity_email_address?: (string | null) | undefined;
+                /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
                 user_identity_phone_number?: (string | null) | undefined;
+                /**  */
                 latest_desired_state_synced_with_provider_at?: string | undefined;
+                /**  */
                 is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                /** Warnings associated with the `acs_user`. */
                 warnings: Array<{
                     created_at: string;
                     message: string;
@@ -3909,6 +4028,7 @@ export interface Routes {
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
                 }>;
+                /** Errors associated with the `acs_user`. */
                 errors: Array<{
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3940,11 +4060,14 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /** Full name of the `acs_user`. */
                 full_name?: string | undefined;
                 /**
                  * @deprecated use email_address. */
                 email?: string | undefined;
+                /** Email address of the `acs_user`. */
                 email_address?: string | undefined;
+                /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
                 phone_number?: string | undefined;
                 is_managed: false;
             }>;
@@ -3972,12 +4095,16 @@ export interface Routes {
                 starts_at: string;
                 ends_at: string;
             } | null) | undefined;
+            /** ID of the `acs_user`. */
             acs_user_id: string;
+            /** Full name of the `acs_user`. */
             full_name?: string | undefined;
             /**
              * @deprecated use email_address. */
             email?: string | undefined;
+            /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
             phone_number?: string | undefined;
+            /** Email address of the `acs_user`. */
             email_address?: string | undefined;
             hid_acs_system_id?: string | undefined;
         };
@@ -14463,20 +14590,7 @@ export interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {
-            thermostat_schedule: {
-                thermostat_schedule_id: string;
-                device_id: string;
-                name?: string | undefined;
-                climate_preset_key: string;
-                max_override_period_minutes?: number;
-                starts_at: string;
-                ends_at: string;
-                created_at: string;
-                /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
-                errors?: any;
-            };
-        };
+        jsonResponse: {};
     };
     '/thermostats/set_fallback_climate_preset': {
         route: '/thermostats/set_fallback_climate_preset';
@@ -14910,22 +15024,7 @@ export interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {
-            climate_preset: {
-                climate_preset_key: string;
-                can_edit: boolean;
-                can_delete: boolean;
-                name?: string | null;
-                display_name: string;
-                fan_mode_setting?: ('auto' | 'on') | undefined;
-                hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
-                cooling_set_point_celsius?: number | undefined;
-                heating_set_point_celsius?: number | undefined;
-                cooling_set_point_fahrenheit?: number | undefined;
-                heating_set_point_fahrenheit?: number | undefined;
-                manual_override_allowed: boolean;
-            };
-        };
+        jsonResponse: {};
     };
     '/user_identities/add_acs_user': {
         route: '/user_identities/add_acs_user';
@@ -16093,25 +16192,41 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             acs_users: Array<{
+                /** ID of the `acs_user`. */
                 acs_user_id: string;
+                /** ID of the access control system that contains the `acs_user`. */
                 acs_system_id: string;
                 hid_acs_system_id?: string | undefined;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
                 workspace_id: string;
+                /** Date and time at which the `acs_user` was created. */
                 created_at: string;
+                /** Display name for the `acs_user`. */
                 display_name: string;
+                /** Brand-specific terminology for the `acs_user` type. */
                 external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
                 external_type_display_name?: string | undefined;
+                /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
                 is_suspended: boolean;
+                /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
                     starts_at: string;
                     ends_at: string;
                 } | undefined;
+                /** ID of the user identity associated with the `acs_user`. */
                 user_identity_id?: string | undefined;
+                /** Full name of the user identity associated with the `acs_user`. */
                 user_identity_full_name?: (string | null) | undefined;
+                /** Email address of the user identity associated with the `acs_user`. */
                 user_identity_email_address?: (string | null) | undefined;
+                /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
                 user_identity_phone_number?: (string | null) | undefined;
+                /**  */
                 latest_desired_state_synced_with_provider_at?: string | undefined;
+                /**  */
                 is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                /** Warnings associated with the `acs_user`. */
                 warnings: Array<{
                     created_at: string;
                     message: string;
@@ -16121,6 +16236,7 @@ export interface Routes {
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
                 }>;
+                /** Errors associated with the `acs_user`. */
                 errors: Array<{
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -16152,11 +16268,14 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /** Full name of the `acs_user`. */
                 full_name?: string | undefined;
                 /**
                  * @deprecated use email_address. */
                 email?: string | undefined;
+                /** Email address of the `acs_user`. */
                 email_address?: string | undefined;
+                /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
                 phone_number?: string | undefined;
                 is_managed: true;
             }>;

package/package.json

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

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

@@ -127,39 +127,109 @@ export const acs_users_warnings = z
 export type AcsUsersWarningMap = z.infer<typeof acs_users_warning_map>
 
 const user_fields = z.object({
-  full_name: z.string().optional(),
+  full_name: z.string().optional().describe('Full name of the `acs_user`.'),
   email: z.string().email().optional().describe(`
     ---
     deprecated: use email_address.
     ---
     `),
-  email_address: z.string().email().optional(),
-  phone_number: phone_number.optional(),
+  email_address: z
+    .string()
+    .email()
+    .optional()
+    .describe('Email address of the `acs_user`.'),
+  phone_number: phone_number
+    .optional()
+    .describe(
+      'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
+    ),
 })
 
 const common_acs_user = z
   .object({
-    acs_user_id: z.string().uuid(),
-    acs_system_id: z.string().uuid(),
+    acs_user_id: z.string().uuid().describe('ID of the `acs_user`.'),
+    acs_system_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the access control system that contains the `acs_user`.',
+      ),
     hid_acs_system_id: z.string().uuid().optional(),
-    workspace_id: z.string().uuid(),
-    created_at: z.string().datetime(),
-    display_name: z.string(),
-    external_type: acs_user_external_type.optional(),
-    external_type_display_name: z.string().optional(),
-    is_suspended: z.boolean(),
-    access_schedule: schedule.optional(),
-    user_identity_id: z.string().optional(),
-    user_identity_full_name: z.string().nullable().optional(),
-    user_identity_email_address: z.string().nullable().optional(),
-    user_identity_phone_number: z.string().nullable().optional(),
+    workspace_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
+      ),
+    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`.'),
+    external_type: acs_user_external_type
+      .optional()
+      .describe('Brand-specific terminology for the `acs_user` type.'),
+    external_type_display_name: z
+      .string()
+      .optional()
+      .describe(
+        'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
+      ),
+    is_suspended: z
+      .boolean()
+      .describe(
+        'Indicates whether the `acs_user` 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.",
+      ),
+    user_identity_id: z
+      .string()
+      .optional()
+      .describe('ID of the user identity associated with the `acs_user`.'),
+    user_identity_full_name: z
+      .string()
+      .nullable()
+      .optional()
+      .describe(
+        'Full name of the user identity associated with the `acs_user`.',
+      ),
+    user_identity_email_address: z
+      .string()
+      .nullable()
+      .optional()
+      .describe(
+        'Email address of the user identity associated with the `acs_user`.',
+      ),
+    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`).',
+      ),
     latest_desired_state_synced_with_provider_at: z
       .string()
       .datetime()
-      .optional(),
-    is_latest_desired_state_synced_with_provider: z.boolean().optional(),
-    warnings: z.array(acs_users_warnings),
-    errors: z.array(acs_user_errors),
+      .optional().describe(`
+      ---
+      undocumented: Only used internally.
+      ---
+      `),
+    is_latest_desired_state_synced_with_provider: z.boolean().optional()
+      .describe(`
+      ---
+      undocumented: Only used internally.
+      ---
+      `),
+    warnings: z
+      .array(acs_users_warnings)
+      .describe('Warnings associated with the `acs_user`.'),
+    errors: z
+      .array(acs_user_errors)
+      .describe('Errors associated with the `acs_user`.'),
   })
   .merge(user_fields)