@seamapi/types 1.50.0 → 1.52.0

package/dist/connect.d.cts

@@ -681,6 +681,7 @@ declare const _default: {
             device: {
                 properties: {
                     capabilities_supported: {
+                        description: string;
                         items: {
                             enum: string[];
                             type: string;
@@ -688,24 +689,29 @@ declare const _default: {
                         type: string;
                     };
                     connected_account_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     created_at: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     device_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     device_type: {
+                        description: string;
                         oneOf: {
                             enum: string[];
                             type: string;
                         }[];
                     };
                     errors: {
+                        description: string;
                         items: {
                             properties: {
                                 error_code: {
@@ -721,16 +727,20 @@ declare const _default: {
                         type: string;
                     };
                     is_managed: {
+                        description: string;
                         enum: boolean[];
                         type: string;
                     };
                     location: {
+                        description: string;
                         nullable: boolean;
                         properties: {
                             location_name: {
+                                description: string;
                                 type: string;
                             };
                             timezone: {
+                                description: string;
                                 type: string;
                             };
                         };
@@ -741,6 +751,7 @@ declare const _default: {
                             allOf: ({
                                 properties: {
                                     battery: {
+                                        description: string;
                                         properties: {
                                             level: {
                                                 maximum: number;
@@ -756,38 +767,48 @@ declare const _default: {
                                         type: string;
                                     };
                                     battery_level: {
+                                        description: string;
                                         maximum: number;
                                         minimum: number;
                                         type: string;
                                     };
                                     has_direct_power: {
+                                        description: string;
                                         type: string;
                                     };
                                     image_alt_text: {
+                                        description: string;
                                         type: string;
                                     };
                                     image_url: {
+                                        description: string;
                                         format: string;
                                         type: string;
                                     };
                                     manufacturer: {
+                                        description: string;
                                         type: string;
                                     };
                                     model: {
                                         properties: {
                                             accessory_keypad_supported: {
+                                                description: string;
                                                 type: string;
                                             };
                                             display_name: {
+                                                description: string;
                                                 type: string;
                                             };
                                             manufacturer_display_name: {
+                                                description: string;
                                                 type: string;
                                             };
                                             offline_access_codes_supported: {
+                                                description: string;
                                                 type: string;
                                             };
                                             online_access_codes_supported: {
+                                                description: string;
                                                 type: string;
                                             };
                                         };
@@ -795,6 +816,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     name: {
+                                        description: string;
                                         type: string;
                                     };
                                     offline_access_codes_enabled: {
@@ -802,6 +824,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     online: {
+                                        description: string;
                                         type: string;
                                     };
                                     online_access_codes_enabled: {
@@ -809,6 +832,7 @@ declare const _default: {
                                         type: string;
                                     };
                                     serial_number: {
+                                        description: string;
                                         type: string;
                                     };
                                     supports_accessory_keypad: {
@@ -1990,8 +2014,10 @@ declare const _default: {
                                 type?: never;
                             })[];
                         })[];
+                        description: string;
                     };
                     warnings: {
+                        description: string;
                         items: {
                             properties: {
                                 message: {
@@ -2007,6 +2033,7 @@ declare const _default: {
                         type: string;
                     };
                     workspace_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
@@ -2177,6 +2204,7 @@ declare const _default: {
             unmanaged_device: {
                 properties: {
                     capabilities_supported: {
+                        description: string;
                         items: {
                             enum: string[];
                             type: string;
@@ -2184,24 +2212,29 @@ declare const _default: {
                         type: string;
                     };
                     connected_account_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     created_at: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     device_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     device_type: {
+                        description: string;
                         oneOf: {
                             enum: string[];
                             type: string;
                         }[];
                     };
                     errors: {
+                        description: string;
                         items: {
                             properties: {
                                 error_code: {
@@ -2254,6 +2287,7 @@ declare const _default: {
                         type: string;
                     };
                     warnings: {
+                        description: string;
                         items: {
                             properties: {
                                 message: {
@@ -2269,6 +2303,7 @@ declare const _default: {
                         type: string;
                     };
                     workspace_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
@@ -2339,6 +2374,16 @@ declare const _default: {
                 name: string;
                 type: string;
             };
+            console_session: {
+                bearerFormat: string;
+                scheme: string;
+                type: string;
+            };
+            pat_with_workspace: {
+                bearerFormat: string;
+                scheme: string;
+                type: string;
+            };
             seam_client_session_token: {
                 in: string;
                 name: string;
@@ -5588,6 +5633,119 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
             };
         };
+        '/acs/credentials/update': {
+            post: {
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    code: {
+                                        pattern: string;
+                                        type: string;
+                                    };
+                                    name: {
+                                        maxLength: number;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        acs_credential: {
+                                            properties: {
+                                                acs_credential_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                acs_credential_pool_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                acs_system_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                acs_user_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                code: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                created_at: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                display_name: {
+                                                    minLength: number;
+                                                    type: string;
+                                                };
+                                                external_type: {
+                                                    enum: string[];
+                                                    type: string;
+                                                };
+                                                external_type_display_name: {
+                                                    type: string;
+                                                };
+                                                workspace_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    access_token: never[];
+                    seam_workspace: never[];
+                    seam_client_session_token?: never;
+                    client_session_token?: never;
+                } | {
+                    seam_client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    client_session_token?: never;
+                } | {
+                    client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    seam_client_session_token?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+            };
+        };
         '/acs/entrances/get': {
             post: {
                 operationId: string;
@@ -7063,20 +7221,25 @@ declare const _default: {
                     };
                 };
                 security: ({
-                    access_token: never[];
-                    seam_workspace: never[];
-                    seam_client_session_token?: never;
-                    client_session_token?: never;
+                    client_session: never[];
+                    pat_with_workspace?: never;
+                    console_session?: never;
+                    api_key?: never;
                 } | {
-                    seam_client_session_token: never[];
-                    access_token?: never;
-                    seam_workspace?: never;
-                    client_session_token?: never;
+                    pat_with_workspace: never[];
+                    client_session?: never;
+                    console_session?: never;
+                    api_key?: never;
                 } | {
-                    client_session_token: never[];
-                    access_token?: never;
-                    seam_workspace?: never;
-                    seam_client_session_token?: never;
+                    console_session: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    console_session?: never;
                 })[];
                 summary: string;
                 tags: string[];
@@ -11975,6 +12138,14 @@ declare const _default: {
                                         nullable: boolean;
                                         type: string;
                                     };
+                                    first_name: {
+                                        nullable: boolean;
+                                        type: string;
+                                    };
+                                    last_name: {
+                                        nullable: boolean;
+                                        type: string;
+                                    };
                                     user_identity_key: {
                                         nullable: boolean;
                                         type: string;
@@ -12005,6 +12176,14 @@ declare const _default: {
                                                     nullable: boolean;
                                                     type: string;
                                                 };
+                                                first_name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                last_name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
                                                 user_identity_id: {
                                                     format: string;
                                                     type: string;
@@ -12109,6 +12288,14 @@ declare const _default: {
                                                     nullable: boolean;
                                                     type: string;
                                                 };
+                                                first_name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                last_name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
                                                 user_identity_id: {
                                                     format: string;
                                                     type: string;
@@ -14078,6 +14265,31 @@ interface Routes {
             };
         };
     };
+    '/acs/credentials/update': {
+        route: '/acs/credentials/update';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            code?: string | undefined;
+            name?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            acs_credential: {
+                acs_credential_id: string;
+                acs_user_id?: string | undefined;
+                acs_credential_pool_id?: string | undefined;
+                acs_system_id: string;
+                display_name: string;
+                code: string | null;
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
+                external_type_display_name: string;
+                created_at: string;
+                workspace_id: string;
+            };
+        };
+    };
     '/acs/entrances/get': {
         route: '/acs/entrances/get';
         method: 'GET' | 'POST';
@@ -14542,7 +14754,7 @@ interface Routes {
             device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
             custom_redirect_url?: string | undefined;
             custom_redirect_failure_url?: string | undefined;
-            accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'yale_access' | 'hid_cm'> | undefined;
+            accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'yale_access' | 'hid_cm'> | undefined;
             provider_category?: ('stable' | 'consumer_smartlocks' | 'internal_beta') | undefined;
             custom_metadata?: Record<string, string | number | null | boolean> | undefined;
             automatically_manage_new_devices?: boolean | undefined;
@@ -14754,36 +14966,54 @@ interface Routes {
         formData: {};
         jsonResponse: {
             device: {
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -15133,21 +15363,30 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             };
         };
@@ -15173,36 +15412,54 @@ interface Routes {
         formData: {};
         jsonResponse: {
             devices: Array<{
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -15552,21 +15809,30 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             }>;
         };
@@ -15601,19 +15867,27 @@ interface Routes {
         formData: {};
         jsonResponse: {
             device: {
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
                 is_managed: false;
                 properties: {
@@ -15651,19 +15925,27 @@ interface Routes {
         formData: {};
         jsonResponse: {
             devices: Array<{
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
                 is_managed: false;
                 properties: {
@@ -15847,36 +16129,54 @@ interface Routes {
         formData: {};
         jsonResponse: {
             lock: {
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -16226,54 +16526,81 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             };
             device: {
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -16623,21 +16950,30 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             };
         };
@@ -16663,36 +16999,54 @@ interface Routes {
         formData: {};
         jsonResponse: {
             locks: Array<{
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -17042,54 +17396,81 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             }>;
             devices: Array<{
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -17439,21 +17820,30 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             }>;
         };
@@ -17877,36 +18267,54 @@ interface Routes {
         formData: {};
         jsonResponse: {
             thermostat: {
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -18256,21 +18664,30 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             };
         };
@@ -18326,36 +18743,54 @@ interface Routes {
         formData: {};
         jsonResponse: {
             thermostats: Array<{
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -18705,21 +19140,30 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             }>;
         };
@@ -18791,6 +19235,8 @@ interface Routes {
         commonParams: {
             user_identity_key?: (string | null) | undefined;
             email_address?: (string | null) | undefined;
+            first_name?: (string | null) | undefined;
+            last_name?: (string | null) | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -18798,6 +19244,8 @@ interface Routes {
                 user_identity_id: string;
                 user_identity_key?: (string | null) | undefined;
                 email_address?: (string | null) | undefined;
+                first_name?: (string | null) | undefined;
+                last_name?: (string | null) | undefined;
                 created_at: string;
                 workspace_id: string;
             };
@@ -18819,6 +19267,8 @@ interface Routes {
                 user_identity_id: string;
                 user_identity_key?: (string | null) | undefined;
                 email_address?: (string | null) | undefined;
+                first_name?: (string | null) | undefined;
+                last_name?: (string | null) | undefined;
                 created_at: string;
                 workspace_id: string;
             };
@@ -18847,36 +19297,54 @@ interface Routes {
         formData: {};
         jsonResponse: {
             accessible_devices: Array<{
+                /** Unique identifier for the device. */
                 device_id: string;
+                /** Type of the device. */
                 device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
+                /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
+                /** Properties of the device. */
                 properties: ({
+                    /** Indicates whether the device is online. */
                     online: boolean;
+                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
                     model: {
+                        /** Display name of the device model. */
                         display_name: string;
+                        /** Display name that corresponds to the manufacturer-specific terminology for the device. */
                         manufacturer_display_name: string;
+                        /** Indicates whether the device supports offline access codes. */
                         offline_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports online access codes. */
                         online_access_codes_supported?: boolean | undefined;
+                        /** Indicates whether the device supports an accessory keypad. */
                         accessory_keypad_supported?: boolean | undefined;
                     };
+                    /** Indicates whether the device has direct power. */
                     has_direct_power?: boolean | undefined;
+                    /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
                     battery_level?: number | undefined;
+                    /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
                     battery?: {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
+                    /** Manufacturer of the device. */
                     manufacturer?: string | undefined;
+                    /** Image URL for the device. */
                     image_url?: string | undefined;
+                    /** Alt text for the device image. */
                     image_alt_text?: string | undefined;
+                    /** Serial number of the device. */
                     serial_number?: string | undefined;
-                    /** Currently possible to use online access codes */
+                    /** Indicates whether it is currently possible to use online access codes for the device. */
                     online_access_codes_enabled?: boolean | undefined;
-                    /** Currently possible to use offline access codes */
+                    /** Indicates whether it is currently possible to use offline access codes for the device. */
                     offline_access_codes_enabled?: boolean | undefined;
-                    /** Deprecated: use model.offline_access_codes_enabled. */
+                    /** Deprecated: Use model.offline_access_codes_enabled. */
                     supports_accessory_keypad?: boolean | undefined;
-                    /** Deprecated: use model.accessory_keypad_supported. */
+                    /** Deprecated: Use model.accessory_keypad_supported. */
                     supports_offline_access_codes?: boolean | undefined;
                 } & {
                     august_metadata?: {
@@ -19226,21 +19694,30 @@ interface Routes {
                     max_cooling_set_point_celsius?: number | undefined;
                     max_cooling_set_point_fahrenheit?: number | undefined;
                 }));
+                /** Location information for the device. */
                 location: {
+                    /** Name of the device location. */
                     location_name?: string | undefined;
+                    /** Time zone of the device location. */
                     timezone?: string | undefined;
                 } | null;
+                /** Unique identifier for the account associated with the device. */
                 connected_account_id: string;
+                /** Unique identifier for the Seam workspace associated with the device. */
                 workspace_id: string;
+                /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
                 errors: Array<{
                     error_code: string;
                     message: string;
                 }>;
+                /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
                 warnings: Array<{
                     warning_code: string;
                     message: string;
                 }>;
+                /** Date and time at which the device object was created. */
                 created_at: string;
+                /** Indicates whether Seam manages the device. */
                 is_managed: true;
             }>;
         };