@seamapi/types 1.246.0 → 1.247.0

package/dist/connect.d.cts

@@ -9971,6 +9971,7 @@ declare const _default: {
             acs_user: {
                 properties: {
                     access_schedule: {
+                        description: string;
                         properties: {
                             ends_at: {
                                 format: string;
@@ -9985,18 +9986,22 @@ declare const _default: {
                         type: string;
                     };
                     acs_system_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     acs_user_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     created_at: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     display_name: {
+                        description: string;
                         type: string;
                     };
                     email: {
@@ -10006,10 +10011,12 @@ declare const _default: {
                         'x-deprecated': string;
                     };
                     email_address: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     errors: {
+                        description: string;
                         items: {
                             description: string;
                             oneOf: {
@@ -10036,13 +10043,16 @@ declare const _default: {
                         type: string;
                     };
                     external_type: {
+                        description: string;
                         enum: string[];
                         type: string;
                     };
                     external_type_display_name: {
+                        description: string;
                         type: string;
                     };
                     full_name: {
+                        description: string;
                         type: string;
                     };
                     hid_acs_system_id: {
@@ -10051,37 +10061,46 @@ declare const _default: {
                     };
                     is_latest_desired_state_synced_with_provider: {
                         type: string;
+                        'x-undocumented': string;
                     };
                     is_managed: {
                         enum: boolean[];
                         type: string;
                     };
                     is_suspended: {
+                        description: string;
                         type: string;
                     };
                     latest_desired_state_synced_with_provider_at: {
                         format: string;
                         type: string;
+                        'x-undocumented': string;
                     };
                     phone_number: {
+                        description: string;
                         type: string;
                     };
                     user_identity_email_address: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     user_identity_full_name: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     user_identity_id: {
+                        description: string;
                         type: string;
                     };
                     user_identity_phone_number: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     warnings: {
+                        description: string;
                         items: {
                             description: string;
                             oneOf: {
@@ -10106,6 +10125,7 @@ declare const _default: {
                         type: string;
                     };
                     workspace_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
@@ -17742,13 +17762,16 @@ declare const _default: {
                                         'x-deprecated': string;
                                     };
                                     email_address: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
                                     full_name: {
+                                        description: string;
                                         type: string;
                                     };
                                     phone_number: {
+                                        description: string;
                                         type: string;
                                     };
                                     user_identity_id: {
@@ -18358,21 +18381,37 @@ declare const _default: {
                                         acs_user: {
                                             properties: {
                                                 access_schedule: {
-                                                    $ref: string;
+                                                    description: string;
+                                                    properties: {
+                                                        ends_at: {
+                                                            format: string;
+                                                            type: string;
+                                                        };
+                                                        starts_at: {
+                                                            format: string;
+                                                            type: string;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                    type: string;
                                                 };
                                                 acs_system_id: {
+                                                    description: string;
                                                     format: string;
                                                     type: string;
                                                 };
                                                 acs_user_id: {
+                                                    description: string;
                                                     format: string;
                                                     type: string;
                                                 };
                                                 created_at: {
+                                                    description: string;
                                                     format: string;
                                                     type: string;
                                                 };
                                                 display_name: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                                 email: {
@@ -18382,10 +18421,12 @@ declare const _default: {
                                                     'x-deprecated': string;
                                                 };
                                                 email_address: {
+                                                    description: string;
                                                     format: string;
                                                     type: string;
                                                 };
                                                 errors: {
+                                                    description: string;
                                                     items: {
                                                         description: string;
                                                         oneOf: {
@@ -18412,13 +18453,16 @@ declare const _default: {
                                                     type: string;
                                                 };
                                                 external_type: {
+                                                    description: string;
                                                     enum: string[];
                                                     type: string;
                                                 };
                                                 external_type_display_name: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                                 full_name: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                                 hid_acs_system_id: {
@@ -18427,37 +18471,46 @@ declare const _default: {
                                                 };
                                                 is_latest_desired_state_synced_with_provider: {
                                                     type: string;
+                                                    'x-undocumented': string;
                                                 };
                                                 is_managed: {
                                                     enum: boolean[];
                                                     type: string;
                                                 };
                                                 is_suspended: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                                 latest_desired_state_synced_with_provider_at: {
                                                     format: string;
                                                     type: string;
+                                                    'x-undocumented': string;
                                                 };
                                                 phone_number: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                                 user_identity_email_address: {
+                                                    description: string;
                                                     nullable: boolean;
                                                     type: string;
                                                 };
                                                 user_identity_full_name: {
+                                                    description: string;
                                                     nullable: boolean;
                                                     type: string;
                                                 };
                                                 user_identity_id: {
+                                                    description: string;
                                                     type: string;
                                                 };
                                                 user_identity_phone_number: {
+                                                    description: string;
                                                     nullable: boolean;
                                                     type: string;
                                                 };
                                                 warnings: {
+                                                    description: string;
                                                     items: {
                                                         description: string;
                                                         oneOf: {
@@ -18482,6 +18535,7 @@ declare const _default: {
                                                     type: string;
                                                 };
                                                 workspace_id: {
+                                                    description: string;
                                                     format: string;
                                                     type: string;
                                                 };
@@ -18571,21 +18625,37 @@ declare const _default: {
                                             items: {
                                                 properties: {
                                                     access_schedule: {
-                                                        $ref: string;
+                                                        description: string;
+                                                        properties: {
+                                                            ends_at: {
+                                                                format: string;
+                                                                type: string;
+                                                            };
+                                                            starts_at: {
+                                                                format: string;
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
                                                     };
                                                     acs_system_id: {
+                                                        description: string;
                                                         format: string;
                                                         type: string;
                                                     };
                                                     acs_user_id: {
+                                                        description: string;
                                                         format: string;
                                                         type: string;
                                                     };
                                                     created_at: {
+                                                        description: string;
                                                         format: string;
                                                         type: string;
                                                     };
                                                     display_name: {
+                                                        description: string;
                                                         type: string;
                                                     };
                                                     email: {
@@ -18595,10 +18665,12 @@ declare const _default: {
                                                         'x-deprecated': string;
                                                     };
                                                     email_address: {
+                                                        description: string;
                                                         format: string;
                                                         type: string;
                                                     };
                                                     errors: {
+                                                        description: string;
                                                         items: {
                                                             description: string;
                                                             oneOf: {
@@ -18625,13 +18697,16 @@ declare const _default: {
                                                         type: string;
                                                     };
                                                     external_type: {
+                                                        description: string;
                                                         enum: string[];
                                                         type: string;
                                                     };
                                                     external_type_display_name: {
+                                                        description: string;
                                                         type: string;
                                                     };
                                                     full_name: {
+                                                        description: string;
                                                         type: string;
                                                     };
                                                     hid_acs_system_id: {
@@ -18640,37 +18715,46 @@ declare const _default: {
                                                     };
                                                     is_latest_desired_state_synced_with_provider: {
                                                         type: string;
+                                                        'x-undocumented': string;
                                                     };
                                                     is_managed: {
                                                         enum: boolean[];
                                                         type: string;
                                                     };
                                                     is_suspended: {
+                                                        description: string;
                                                         type: string;
                                                     };
                                                     latest_desired_state_synced_with_provider_at: {
                                                         format: string;
                                                         type: string;
+                                                        'x-undocumented': string;
                                                     };
                                                     phone_number: {
+                                                        description: string;
                                                         type: string;
                                                     };
                                                     user_identity_email_address: {
+                                                        description: string;
                                                         nullable: boolean;
                                                         type: string;
                                                     };
                                                     user_identity_full_name: {
+                                                        description: string;
                                                         nullable: boolean;
                                                         type: string;
                                                     };
                                                     user_identity_id: {
+                                                        description: string;
                                                         type: string;
                                                     };
                                                     user_identity_phone_number: {
+                                                        description: string;
                                                         nullable: boolean;
                                                         type: string;
                                                     };
                                                     warnings: {
+                                                        description: string;
                                                         items: {
                                                             description: string;
                                                             oneOf: {
@@ -18695,6 +18779,7 @@ declare const _default: {
                                                         type: string;
                                                     };
                                                     workspace_id: {
+                                                        description: string;
                                                         format: string;
                                                         type: string;
                                                     };
@@ -18834,6 +18919,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     acs_user_id: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
@@ -18844,10 +18930,12 @@ declare const _default: {
                                         'x-deprecated': string;
                                     };
                                     email_address: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
                                     full_name: {
+                                        description: string;
                                         type: string;
                                     };
                                     hid_acs_system_id: {
@@ -18855,6 +18943,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     phone_number: {
+                                        description: string;
                                         type: string;
                                     };
                                 };
@@ -18931,6 +19020,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     acs_user_id: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
@@ -18941,10 +19031,12 @@ declare const _default: {
                                         'x-deprecated': string;
                                     };
                                     email_address: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
                                     full_name: {
+                                        description: string;
                                         type: string;
                                     };
                                     hid_acs_system_id: {
@@ -18952,6 +19044,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     phone_number: {
+                                        description: string;
                                         type: string;
                                     };
                                 };
@@ -29588,25 +29681,41 @@ 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;
@@ -29616,6 +29725,7 @@ 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;
@@ -29647,11 +29757,14 @@ 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;
             }>;
@@ -30719,36 +30832,55 @@ 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;
@@ -30758,6 +30890,7 @@ 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;
@@ -30789,11 +30922,14 @@ 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;
             };
@@ -30823,25 +30959,41 @@ 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;
@@ -30851,6 +31003,7 @@ 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;
@@ -30882,11 +31035,14 @@ 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;
             };
@@ -30912,25 +31068,41 @@ 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;
@@ -30940,6 +31112,7 @@ 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;
@@ -30971,11 +31144,14 @@ 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;
             }>;
@@ -31067,25 +31243,41 @@ 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;
@@ -31095,6 +31287,7 @@ 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;
@@ -31126,11 +31319,14 @@ 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;
             };
@@ -31151,25 +31347,41 @@ 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;
@@ -31179,6 +31391,7 @@ 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;
@@ -31210,11 +31423,14 @@ 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;
             }>;
@@ -31242,12 +31458,16 @@ 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;
         };
@@ -43363,25 +43583,41 @@ 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;
@@ -43391,6 +43627,7 @@ 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;
@@ -43422,11 +43659,14 @@ 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;
             }>;