@seamapi/types 1.437.1 → 1.439.0

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

@@ -18662,6 +18662,8 @@ export interface Routes {
       access_method_id?: string | undefined
       /** ID of the connected account for which you want to retrieve all entrances. */
       connected_account_id?: string | undefined
+      /** IDs of the entrances for which you want to retrieve all entrances. */
+      acs_entrance_ids?: string[] | undefined
     }
     formData: {}
     jsonResponse: {
@@ -28965,6 +28967,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {}
   }
+  '/devices/simulate/connect_to_hub': {
+    route: '/devices/simulate/connect_to_hub'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** ID of the device whose hub you want to reconnect. */
+      device_id: string
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+  }
   '/devices/simulate/disconnect': {
     route: '/devices/simulate/disconnect'
     method: 'POST'
@@ -28977,6 +28991,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {}
   }
+  '/devices/simulate/disconnect_from_hub': {
+    route: '/devices/simulate/disconnect_from_hub'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** ID of the device whose hub you want to disconnect. */
+      device_id: string
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+  }
   '/devices/simulate/remove': {
     route: '/devices/simulate/remove'
     method: 'POST'
@@ -30233,6 +30259,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.created'
               }
             | {
@@ -30250,6 +30284,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.changed'
               }
             | {
@@ -30267,6 +30309,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.scheduled_on_device'
                 /** Code for the affected access code. */
                 code: string
@@ -30286,6 +30336,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.set_on_device'
                 /** Code for the affected access code. */
                 code: string
@@ -30305,6 +30363,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.removed_from_device'
               }
             | {
@@ -30322,6 +30388,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.delay_in_setting_on_device'
               }
             | {
@@ -30339,6 +30413,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.failed_to_set_on_device'
               }
             | {
@@ -30356,6 +30438,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.deleted'
                 /** Code for the affected access code. */
                 code: string | null
@@ -30375,6 +30465,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.delay_in_removing_from_device'
               }
             | {
@@ -30392,6 +30490,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.failed_to_remove_from_device'
               }
             | {
@@ -30409,6 +30515,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.modified_external_to_seam'
               }
             | {
@@ -30426,6 +30540,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.deleted_external_to_seam'
               }
             | {
@@ -30443,6 +30565,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.backup_access_code_pulled'
                 backup_access_code_id: string
               }
@@ -30461,6 +30591,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.unmanaged.converted_to_managed'
               }
             | {
@@ -30478,6 +30616,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.unmanaged.failed_to_convert_to_managed'
               }
             | {
@@ -30495,6 +30641,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.unmanaged.created'
               }
             | {
@@ -30512,6 +30666,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'access_code.unmanaged.removed'
               }
             | {
@@ -30900,6 +31062,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'connected_account.connected'
                 /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
                 connect_webview_id: string
@@ -30915,6 +31081,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'connected_account.created'
                 /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
                 connect_webview_id: string
@@ -30930,6 +31100,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'connected_account.successful_login'
                 /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
                 connect_webview_id: string
@@ -30945,6 +31119,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'connected_account.disconnected'
               }
             | {
@@ -30958,6 +31136,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'connected_account.completed_first_sync'
               }
             | {
@@ -30971,6 +31153,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'connected_account.deleted'
               }
             | {
@@ -30984,6 +31170,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
                 connected_account_id: string
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'connected_account.completed_first_sync_after_reconnection'
               }
             | {
@@ -31068,6 +31258,10 @@ export interface Routes {
                 event_type: 'connect_webview.login_succeeded'
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the connected account; present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
               }
             | {
                 /** ID of the event. */
@@ -31095,6 +31289,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.connected'
               }
             | {
@@ -31110,6 +31312,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.added'
               }
             | {
@@ -31125,6 +31335,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.converted_to_unmanaged'
               }
             | {
@@ -31140,6 +31358,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.unmanaged.converted_to_managed'
               }
             | {
@@ -31155,6 +31381,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.unmanaged.connected'
               }
             | {
@@ -31170,6 +31404,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.disconnected'
                 /** Error code associated with the disconnection event, if any. */
                 error_code:
@@ -31190,6 +31432,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.unmanaged.disconnected'
                 /** Error code associated with the disconnection event, if any. */
                 error_code:
@@ -31210,6 +31460,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.tampered'
               }
             | {
@@ -31225,6 +31483,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.low_battery'
                 /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
                 battery_level: number
@@ -31242,6 +31508,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.battery_status_changed'
                 /** Battery status of the affected device, calculated from the numeric `battery_level` value. */
                 battery_status: 'critical' | 'low' | 'good' | 'full'
@@ -31261,6 +31535,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.removed'
               }
             | {
@@ -31276,6 +31558,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.deleted'
               }
             | {
@@ -31291,6 +31581,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.third_party_integration_detected'
               }
             | {
@@ -31306,6 +31604,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.third_party_integration_no_longer_detected'
               }
             | {
@@ -31321,6 +31627,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.salto.privacy_mode_activated'
               }
             | {
@@ -31336,6 +31650,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.salto.privacy_mode_deactivated'
               }
             | {
@@ -31351,6 +31673,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.connection_became_flaky'
               }
             | {
@@ -31366,6 +31696,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.connection_stabilized'
               }
             | {
@@ -31381,6 +31719,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.error.subscription_required'
               }
             | {
@@ -31396,6 +31742,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.error.subscription_required.resolved'
               }
             | {
@@ -31411,6 +31765,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.accessory_keypad_connected'
               }
             | {
@@ -31426,6 +31788,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.accessory_keypad_disconnected'
               }
             | {
@@ -31441,6 +31811,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'noise_sensor.noise_threshold_triggered'
                 /** Detected noise level in decibels. */
                 noise_level_decibels?: number | undefined
@@ -31468,6 +31846,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'lock.locked'
                 /** ID of the access code that was used to lock the device. */
                 access_code_id?: string | undefined
@@ -31494,6 +31880,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'lock.unlocked'
                 /** ID of the access code that was used to unlock the affected device. */
                 access_code_id?: string | undefined
@@ -31520,6 +31914,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'lock.access_denied'
                 /** ID of the access code that was used in the unlock attempts. */
                 access_code_id?: string | undefined
@@ -31537,6 +31939,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'thermostat.climate_preset_activated'
                 /** ID of the thermostat schedule that prompted the affected climate preset to be activated. */
                 thermostat_schedule_id: string | null
@@ -31558,6 +31968,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'thermostat.manually_adjusted'
                 /** Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat. */
                 method: 'seam' | 'external'
@@ -31591,6 +32009,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'thermostat.temperature_threshold_exceeded'
                 /** Temperature, in °C, reported by the affected thermostat. */
                 temperature_celsius: number
@@ -31618,6 +32044,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'thermostat.temperature_threshold_no_longer_exceeded'
                 /** Temperature, in °C, reported by the affected thermostat. */
                 temperature_celsius: number
@@ -31645,6 +32079,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'thermostat.temperature_reached_set_point'
                 /** Temperature, in °C, reported by the affected thermostat. */
                 temperature_celsius: number
@@ -31668,6 +32110,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'thermostat.temperature_changed'
                 /** Temperature, in °C, reported by the affected thermostat. */
                 temperature_celsius: number
@@ -31687,6 +32137,14 @@ export interface Routes {
                 device_id: string
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
                 connected_account_id: string
+                /** Custom metadata of the device, present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
+                /** Custom metadata of the connected account, present when connected_account_id is provided. */
+                connected_account_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'device.name_changed'
                 /** The new name of the affected device. */
                 device_name: string
@@ -31715,6 +32173,10 @@ export interface Routes {
                 occurred_at: string
                 /** ID of the affected phone device. */
                 device_id: string
+                /** Custom metadata of the device; present when device_id is provided. */
+                device_custom_metadata?:
+                  | Record<string, string | boolean>
+                  | undefined
                 event_type: 'phone.deactivated'
               }
           )
@@ -31965,6 +32427,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.created'
           }
         | {
@@ -31982,6 +32452,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.changed'
           }
         | {
@@ -31999,6 +32477,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.scheduled_on_device'
             /** Code for the affected access code. */
             code: string
@@ -32018,6 +32504,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.set_on_device'
             /** Code for the affected access code. */
             code: string
@@ -32037,6 +32531,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.removed_from_device'
           }
         | {
@@ -32054,6 +32556,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.delay_in_setting_on_device'
           }
         | {
@@ -32071,6 +32581,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.failed_to_set_on_device'
           }
         | {
@@ -32088,6 +32606,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.deleted'
             /** Code for the affected access code. */
             code: string | null
@@ -32107,6 +32633,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.delay_in_removing_from_device'
           }
         | {
@@ -32124,6 +32658,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.failed_to_remove_from_device'
           }
         | {
@@ -32141,6 +32683,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.modified_external_to_seam'
           }
         | {
@@ -32158,6 +32708,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.deleted_external_to_seam'
           }
         | {
@@ -32175,6 +32733,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.backup_access_code_pulled'
             backup_access_code_id: string
           }
@@ -32193,6 +32759,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.unmanaged.converted_to_managed'
           }
         | {
@@ -32210,6 +32784,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.unmanaged.failed_to_convert_to_managed'
           }
         | {
@@ -32227,6 +32809,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.unmanaged.created'
           }
         | {
@@ -32244,6 +32834,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'access_code.unmanaged.removed'
           }
         | {
@@ -32632,6 +33230,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'connected_account.connected'
             /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
             connect_webview_id: string
@@ -32647,6 +33249,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'connected_account.created'
             /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
             connect_webview_id: string
@@ -32662,6 +33268,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'connected_account.successful_login'
             /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
             connect_webview_id: string
@@ -32677,6 +33287,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'connected_account.disconnected'
           }
         | {
@@ -32690,6 +33304,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'connected_account.completed_first_sync'
           }
         | {
@@ -32703,6 +33321,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'connected_account.deleted'
           }
         | {
@@ -32716,6 +33338,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
             connected_account_id: string
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'connected_account.completed_first_sync_after_reconnection'
           }
         | {
@@ -32800,6 +33426,10 @@ export interface Routes {
             event_type: 'connect_webview.login_succeeded'
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the connected account; present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
           }
         | {
             /** ID of the event. */
@@ -32827,6 +33457,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.connected'
           }
         | {
@@ -32842,6 +33480,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.added'
           }
         | {
@@ -32857,6 +33503,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.converted_to_unmanaged'
           }
         | {
@@ -32872,6 +33526,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.unmanaged.converted_to_managed'
           }
         | {
@@ -32887,6 +33549,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.unmanaged.connected'
           }
         | {
@@ -32902,6 +33572,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.disconnected'
             /** Error code associated with the disconnection event, if any. */
             error_code:
@@ -32922,6 +33600,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.unmanaged.disconnected'
             /** Error code associated with the disconnection event, if any. */
             error_code:
@@ -32942,6 +33628,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.tampered'
           }
         | {
@@ -32957,6 +33651,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.low_battery'
             /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
             battery_level: number
@@ -32974,6 +33676,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.battery_status_changed'
             /** Battery status of the affected device, calculated from the numeric `battery_level` value. */
             battery_status: 'critical' | 'low' | 'good' | 'full'
@@ -32993,6 +33703,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.removed'
           }
         | {
@@ -33008,6 +33726,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.deleted'
           }
         | {
@@ -33023,6 +33749,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.third_party_integration_detected'
           }
         | {
@@ -33038,6 +33772,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.third_party_integration_no_longer_detected'
           }
         | {
@@ -33053,6 +33795,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.salto.privacy_mode_activated'
           }
         | {
@@ -33068,6 +33818,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.salto.privacy_mode_deactivated'
           }
         | {
@@ -33083,6 +33841,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.connection_became_flaky'
           }
         | {
@@ -33098,6 +33864,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.connection_stabilized'
           }
         | {
@@ -33113,6 +33887,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.error.subscription_required'
           }
         | {
@@ -33128,6 +33910,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.error.subscription_required.resolved'
           }
         | {
@@ -33143,6 +33933,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.accessory_keypad_connected'
           }
         | {
@@ -33158,6 +33956,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.accessory_keypad_disconnected'
           }
         | {
@@ -33173,6 +33979,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'noise_sensor.noise_threshold_triggered'
             /** Detected noise level in decibels. */
             noise_level_decibels?: number | undefined
@@ -33200,6 +34014,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'lock.locked'
             /** ID of the access code that was used to lock the device. */
             access_code_id?: string | undefined
@@ -33221,6 +34043,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'lock.unlocked'
             /** ID of the access code that was used to unlock the affected device. */
             access_code_id?: string | undefined
@@ -33242,6 +34072,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'lock.access_denied'
             /** ID of the access code that was used in the unlock attempts. */
             access_code_id?: string | undefined
@@ -33259,6 +34097,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'thermostat.climate_preset_activated'
             /** ID of the thermostat schedule that prompted the affected climate preset to be activated. */
             thermostat_schedule_id: string | null
@@ -33280,6 +34126,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'thermostat.manually_adjusted'
             /** Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat. */
             method: 'seam' | 'external'
@@ -33313,6 +34167,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'thermostat.temperature_threshold_exceeded'
             /** Temperature, in °C, reported by the affected thermostat. */
             temperature_celsius: number
@@ -33340,6 +34202,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'thermostat.temperature_threshold_no_longer_exceeded'
             /** Temperature, in °C, reported by the affected thermostat. */
             temperature_celsius: number
@@ -33367,6 +34237,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'thermostat.temperature_reached_set_point'
             /** Temperature, in °C, reported by the affected thermostat. */
             temperature_celsius: number
@@ -33390,6 +34268,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'thermostat.temperature_changed'
             /** Temperature, in °C, reported by the affected thermostat. */
             temperature_celsius: number
@@ -33409,6 +34295,14 @@ export interface Routes {
             device_id: string
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
             connected_account_id: string
+            /** Custom metadata of the device, present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
+            /** Custom metadata of the connected account, present when connected_account_id is provided. */
+            connected_account_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'device.name_changed'
             /** The new name of the affected device. */
             device_name: string
@@ -33437,6 +34331,10 @@ export interface Routes {
             occurred_at: string
             /** ID of the affected phone device. */
             device_id: string
+            /** Custom metadata of the device; present when device_id is provided. */
+            device_custom_metadata?:
+              | Record<string, string | boolean>
+              | undefined
             event_type: 'phone.deactivated'
           }
       >
@@ -54068,6 +54966,1638 @@ export interface Routes {
       }
     }
   }
+  '/spaces/get_related': {
+    route: '/spaces/get_related'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** IDs of the spaces that you want to get along with their related resources. */
+      space_ids: string[]
+      include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
+      exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents a resource batch. */
+      batch: {
+        batch_type: 'spaces'
+        spaces?:
+          | Array<{
+              /** ID of the space. */
+              space_id: string
+              /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
+              workspace_id: string
+              /** Name of the space. */
+              name: string
+              /** Display name for the space. */
+              display_name: string
+              /** Date and time at which the space was created. */
+              created_at: string
+            }>
+          | undefined
+        devices?:
+          | Array<{
+              /** ID of 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'
+                    | 'tedee_lock'
+                    | 'akiles_lock'
+                  )
+                | ('noiseaware_activity_zone' | 'minut_sensor')
+                | (
+                    | 'ecobee_thermostat'
+                    | 'nest_thermostat'
+                    | 'honeywell_resideo_thermostat'
+                    | 'tado_thermostat'
+                    | 'sensi_thermostat'
+                    | 'smartthings_thermostat'
+                  )
+                | ('ios_phone' | 'android_phone')
+              /** Optional nickname to describe the device, settable through Seam. */
+              nickname?: string | undefined
+              /** Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+              display_name: 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
+                     */
+              capabilities_supported: Array<
+                | 'access_code'
+                | 'lock'
+                | 'noise_detection'
+                | 'thermostat'
+                | 'battery'
+                | 'phone'
+              >
+              /** Properties of the device. */
+              properties: (({
+                /** Indicates whether the device is online. */
+                online: boolean
+                /** Name of the device.
+                 * @deprecated use device.display_name instead */
+                name: string
+                /** Accessory keypad properties and state. */
+                accessory_keypad?:
+                  | {
+                      /** Indicates if an accessory keypad is connected to the device.
+                       */
+                      is_connected: boolean
+                      /** Keypad battery properties.
+                       */
+                      battery?:
+                        | {
+                            level: number
+                          }
+                        | undefined
+                    }
+                  | undefined
+                /** Appearance-related properties, as reported by the device. */
+                appearance: {
+                  /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                  name: string
+                }
+                /** Device model-related properties. */
+                model: {
+                  /**
+                              Indicates whether the device can connect a accessory keypad.
+                           */
+                  can_connect_accessory_keypad?: boolean | undefined
+                  /**
+                              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 has a built in accessory keypad.
+                           */
+                  has_built_in_keypad?: boolean | undefined
+                  /**
+                   * @deprecated use device.can_program_offline_access_codes. */
+                  offline_access_codes_supported?: boolean | undefined
+                  /**
+                   * @deprecated use device.can_program_online_access_codes. */
+                  online_access_codes_supported?: boolean | undefined
+                  /**
+                   * @deprecated use device.properties.model.can_connect_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. */
+                battery?:
+                  | {
+                      /** Battery charge level as a value between 0 and 1, inclusive.
+                       */
+                      level: number
+                      /** 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.
+                       */
+                      status: 'critical' | 'low' | 'good' | 'full'
+                    }
+                  | undefined
+                /** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
+                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
+                /** Indicates whether it is currently possible to use online access codes for the device. */
+                online_access_codes_enabled?: boolean | undefined
+                /** Indicates whether it is currently possible to use offline access codes for the device. */
+                offline_access_codes_enabled?: boolean | undefined
+                /**
+                 * @deprecated use device.properties.model.can_connect_accessory_keypad */
+                supports_accessory_keypad?: boolean | undefined
+                /**
+                 * @deprecated use offline_access_codes_enabled */
+                supports_offline_access_codes?: boolean | undefined
+                /** Indicates current noise level in decibels, if the device supports noise detection. */
+                noise_level_decibels?: number | undefined
+                /** Array of noise threshold IDs that are currently triggering. */
+                currently_triggering_noise_threshold_ids?: string[] | undefined
+              } & {
+                /** ASSA ABLOY Credential Service metadata for the phone. */
+                assa_abloy_credential_service_metadata?:
+                  | (
+                      | {
+                          /** Indicates whether the credential service has active endpoints associated with the phone. */
+                          has_active_endpoint: boolean
+                          /** Endpoints associated with the phone. */
+                          endpoints: Array<{
+                            /** ID of the associated endpoint. */
+                            endpoint_id: string
+                            /** Indicated whether the endpoint is active. */
+                            is_active: boolean
+                          }>
+                        }
+                      | undefined
+                    )
+                  | undefined
+                /** Salto Space credential service metadata for the phone. */
+                salto_space_credential_service_metadata?:
+                  | (
+                      | {
+                          /** Indicates whether the credential service has an active associated phone. */
+                          has_active_phone: boolean
+                        }
+                      | undefined
+                    )
+                  | undefined
+              }) & {
+                /** Metadata for an August device. */
+                august_metadata?:
+                  | {
+                      /** Lock ID for an August device. */
+                      lock_id: string
+                      /** Lock name for an August device. */
+                      lock_name: string
+                      /** House name for an August device. */
+                      house_name: string
+                      /** Indicates whether an August device has a keypad. */
+                      has_keypad: boolean
+                      /** Keypad battery level for an August device. */
+                      keypad_battery_level?: string | undefined
+                      /** Model for an August device. */
+                      model?: string | undefined
+                      /** House ID for an August device. */
+                      house_id?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for an Avigilon Alta system. */
+                avigilon_alta_metadata?:
+                  | {
+                      /** Entry name for an Avigilon Alta system. */
+                      entry_name: string
+                      /** Organization name for an Avigilon Alta system. */
+                      org_name: string
+                      /** Zone ID for an Avigilon Alta system. */
+                      zone_id: number
+                      /** Zone name for an Avigilon Alta system. */
+                      zone_name: string
+                      /** Site ID for an Avigilon Alta system. */
+                      site_id: number
+                      /** Site name for an Avigilon Alta system. */
+                      site_name: string
+                      /** Total count of entry relays for an Avigilon Alta system. */
+                      entry_relays_total_count: number
+                    }
+                  | undefined
+                /** Metadata for a Schlage device. */
+                schlage_metadata?:
+                  | {
+                      /** Device ID for a Schlage device. */
+                      device_id: string
+                      /** Device name for a Schlage device. */
+                      device_name: string
+                      /** Model for a Schlage device. */
+                      model?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for a SmartThings device. */
+                smartthings_metadata?:
+                  | {
+                      /** Device ID for a SmartThings device. */
+                      device_id: string
+                      /** Device name for a SmartThings device. */
+                      device_name: string
+                      /** Model for a SmartThings device. */
+                      model?: string | undefined
+                      /** Location ID for a SmartThings device. */
+                      location_id?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for a Lockly device. */
+                lockly_metadata?:
+                  | {
+                      /** Device ID for a Lockly device. */
+                      device_id: string
+                      /** Device name for a Lockly device. */
+                      device_name: string
+                      /** Model for a Lockly device. */
+                      model?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for a Nuki device. */
+                nuki_metadata?:
+                  | {
+                      /** Device ID for a Nuki device. */
+                      device_id: string
+                      /** Device name for a Nuki device. */
+                      device_name: string
+                      /** Indicates whether the keypad battery is in a critical state for a Nuki device. */
+                      keypad_battery_critical?: boolean | undefined
+                      /** Indicates whether the keypad is paired for a Nuki device. */
+                      keypad_paired?: boolean | undefined
+                      /** Indicates whether keypad 2 is paired for a Nuki device. */
+                      keypad_2_paired?: boolean | undefined
+                    }
+                  | undefined
+                /** Metadata for a Kwikset device. */
+                kwikset_metadata?:
+                  | {
+                      /** Device ID for a Kwikset device. */
+                      device_id: string
+                      /** Device name for a Kwikset device. */
+                      device_name: string
+                      /** Model number for a Kwikset device. */
+                      model_number: string
+                    }
+                  | undefined
+                /** Metada for a Salto device.
+                 * @deprecated Use `salto_ks_metadata ` instead. */
+                salto_metadata?:
+                  | {
+                      /** Lock ID for a Salto device. */
+                      lock_id: string
+                      /** Customer reference for a Salto device. */
+                      customer_reference: string
+                      /** Lock type for a Salto device. */
+                      lock_type: string
+                      /** Battery level for a Salto device. */
+                      battery_level: string
+                      /** Locked state for a Salto device. */
+                      locked_state: string
+                      /** Model for a Salto device. */
+                      model?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for a Salto KS device. */
+                salto_ks_metadata?:
+                  | {
+                      /** Lock ID for a Salto KS device. */
+                      lock_id: string
+                      /** Customer reference for a Salto KS device. */
+                      customer_reference: string
+                      /** Lock type for a Salto KS device. */
+                      lock_type: string
+                      /** Battery level for a Salto KS device. */
+                      battery_level: string
+                      /** Locked state for a Salto KS device. */
+                      locked_state: string
+                      /** Model for a Salto KS device. */
+                      model?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for a Genie device. */
+                genie_metadata?:
+                  | {
+                      /** Lock name for a Genie device. */
+                      device_name: string
+                      /** Door name for a Genie device. */
+                      door_name: string
+                    }
+                  | undefined
+                /** Metadata for a Brivo device. */
+                brivo_metadata?:
+                  | {
+                      /** Device name for a Brivo device. */
+                      device_name: string
+                    }
+                  | undefined
+                /** Metadata for an igloo device. */
+                igloo_metadata?:
+                  | {
+                      /** Device ID for an igloo device. */
+                      device_id: string
+                      /** Bridge ID for an igloo device. */
+                      bridge_id: string
+                      /** Model for an igloo device. */
+                      model?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for a NoiseAware device. */
+                noiseaware_metadata?:
+                  | {
+                      /** Device model for a NoiseAware device. */
+                      device_model: 'indoor' | 'outdoor'
+                      /** Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device. */
+                      noise_level_nrs: number
+                      /** Noise level, in decibels, for a NoiseAware device. */
+                      noise_level_decibel: number
+                      /** Device name for a NoiseAware device. */
+                      device_name: string
+                      /** Device ID for a NoiseAware device. */
+                      device_id: string
+                    }
+                  | undefined
+                /** Metadata for a Minut device. */
+                minut_metadata?:
+                  | {
+                      /** Device ID for a Minut device. */
+                      device_id: string
+                      /** Device name for a Minut device. */
+                      device_name: string
+                      /** Latest sensor values for a Minut device. */
+                      latest_sensor_values: {
+                        /** Latest temperature reading for a Minut device. */
+                        temperature: {
+                          /** Time of latest temperature reading for a Minut device. */
+                          time: string
+                          /** Value of latest temperature reading for a Minut device. */
+                          value: number
+                        }
+                        /** Latest sound reading for a Minut device. */
+                        sound: {
+                          /** Time of latest sound reading for a Minut device. */
+                          time: string
+                          /** Value of latest sound reading for a Minut device. */
+                          value: number
+                        }
+                        /** Latest humidity reading for a Minut device. */
+                        humidity: {
+                          /** Time of latest humidity reading for a Minut device. */
+                          time: string
+                          /** Value of latest humidity reading for a Minut device. */
+                          value: number
+                        }
+                        /** Latest pressure reading for a Minut device. */
+                        pressure: {
+                          /** Time of latest pressure reading for a Minut device. */
+                          time: string
+                          /** Value of latest pressure reading for a Minut device. */
+                          value: number
+                        }
+                        /** Latest accelerometer Z-axis reading for a Minut device. */
+                        accelerometer_z: {
+                          /** Time of latest accelerometer Z-axis reading for a Minut device. */
+                          time: string
+                          /** Value of latest accelerometer Z-axis reading for a Minut device. */
+                          value: number
+                        }
+                      }
+                    }
+                  | undefined
+                /** Metadata for a 4SUITES device. */
+                four_suites_metadata?:
+                  | {
+                      /** Device ID for a 4SUITES device. */
+                      device_id: number
+                      /** Device name for a 4SUITES device. */
+                      device_name: string
+                      /** Reclose delay, in seconds, for a 4SUITES device. */
+                      reclose_delay_in_seconds: number
+                    }
+                  | undefined
+                /** Metadata for a 2N device. */
+                two_n_metadata?:
+                  | {
+                      /** Device ID for a 2N device. */
+                      device_id: number
+                      /** Device name for a 2N device. */
+                      device_name: string
+                    }
+                  | undefined
+                /** Metadata for a ControlByWeb device. */
+                controlbyweb_metadata?:
+                  | {
+                      /** Device ID for a ControlByWeb device. */
+                      device_id: string
+                      /** Device name for a ControlByWeb device. */
+                      device_name: string
+                      /** Relay name for a ControlByWeb device. */
+                      relay_name: string | null
+                    }
+                  | undefined
+                /** Metadata for a TTLock device. */
+                ttlock_metadata?:
+                  | {
+                      /** Lock ID for a TTLock device. */
+                      lock_id: number
+                      /** Lock alias for a TTLock device. */
+                      lock_alias: string
+                      /** Feature value for a TTLock device. */
+                      feature_value: string
+                      /** Features for a TTLock device. */
+                      features: {
+                        /** Indicates whether a TTLock device supports a passcode. */
+                        passcode: boolean
+                        /** Indicates whether a TTLock device supports passcode management. */
+                        passcode_management: boolean
+                        /** Indicates whether a TTLock device supports unlock via gateway. */
+                        unlock_via_gateway: boolean
+                        /** Indicates whether a TTLock device supports the lock command. */
+                        lock_command: boolean
+                        /** Indicates whether a TTLock device supports an incomplete keyboard passcode. */
+                        incomplete_keyboard_passcode: boolean
+                        /** Indicates whether a TTLock device supports Wi-Fi. */
+                        wifi: boolean
+                      }
+                      /** Indicates whether a TTLock device has a gateway. */
+                      has_gateway?: boolean | undefined
+                      /** Wireless keypads for a TTLock device. */
+                      wireless_keypads?:
+                        | Array<{
+                            /** ID for a wireless keypad for a TTLock device. */
+                            wireless_keypad_id: number
+                            /** Name for a wireless keypad for a TTLock device. */
+                            wireless_keypad_name: string
+                          }>
+                        | undefined
+                    }
+                  | undefined
+                /** Metadata for Seam Bridge. */
+                seam_bridge_metadata?:
+                  | {
+                      /** Unlock method for Seam Bridge. */
+                      unlock_method?: ('bridge' | 'doorking') | undefined
+                      /** Device number for Seam Bridge. */
+                      device_num: number
+                      /** Name for Seam Bridge. */
+                      name: string
+                    }
+                  | undefined
+                /** Metadata for an igloohome device. */
+                igloohome_metadata?:
+                  | {
+                      /** Device ID for an igloohome device. */
+                      device_id: string
+                      /** Device name for an igloohome device. */
+                      device_name: string
+                      /** Bridge ID for an igloohome device. */
+                      bridge_id?: string | undefined
+                      /** Bridge name for an igloohome device. */
+                      bridge_name?: string | undefined
+                      /** Keypad ID for an igloohome device. */
+                      keypad_id?: string | undefined
+                      /** Indicates whether a keypad is linked to a bridge for an igloohome device. */
+                      is_keypad_linked_to_bridge?: boolean | undefined
+                    }
+                  | undefined
+                /** Metadata for a Google Nest device. */
+                nest_metadata?:
+                  | {
+                      /** Device ID for a Google Nest device. */
+                      nest_device_id: string
+                      /** Device name for a Google Nest device. Google sets this value. */
+                      device_name: string
+                      /** Custom device name for a Google Nest device. The device owner sets this value. */
+                      device_custom_name: string
+                      /** Display name for a Google Nest device. */
+                      display_name?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for an ecobee device. */
+                ecobee_metadata?:
+                  | {
+                      /** Device ID for an ecobee device. */
+                      ecobee_device_id: string
+                      /** Device name for an ecobee device. */
+                      device_name: string
+                    }
+                  | undefined
+                /** Metadata for a Honeywell Resideo device. */
+                honeywell_resideo_metadata?:
+                  | {
+                      /** Device ID for a Honeywell Resideo device. */
+                      honeywell_resideo_device_id: string
+                      /** Device name for a Honeywell Resideo device. */
+                      device_name: string
+                    }
+                  | undefined
+                /** Metadata for a Hubitat device. */
+                hubitat_metadata?:
+                  | {
+                      /** Device ID for a Hubitat device. */
+                      device_id: string
+                      /** Device name for a Hubitat device. */
+                      device_name: string
+                      /** Device label for a Hubitat device. */
+                      device_label: string
+                    }
+                  | undefined
+                /** Metadata for a dormakaba Oracode device. */
+                dormakaba_oracode_metadata?:
+                  | {
+                      /** Door ID for a dormakaba Oracode device. */
+                      door_id?: number | undefined
+                      /** Door name for a dormakaba Oracode device. */
+                      door_name: string
+                      /** Device ID for a dormakaba Oracode device. */
+                      device_id?: (number | string) | undefined
+                      /** Indicates whether a door is wireless for a dormakaba Oracode device. */
+                      door_is_wireless: boolean
+                      /** Site ID for a dormakaba Oracode device.
+                       * @deprecated Previously marked as "@DEPRECATED." */
+                      site_id: number | null
+                      /** Site name for a dormakaba Oracode device. */
+                      site_name: string
+                      /** IANA time zone for a dormakaba Oracode device. */
+                      iana_timezone?: string | undefined
+                      /** Predefined time slots for a dormakaba Oracode device. */
+                      predefined_time_slots?:
+                        | Array<{
+                            /** Name of a time slot for a dormakaba Oracode device. */
+                            name: string
+                            /** Prefix for a time slot for a dormakaba Oracode device. */
+                            prefix: number
+                            /** Check in time for a time slot for a dormakaba Oracode device. */
+                            check_in_time: string
+                            /** Checkout time for a time slot for a dormakaba Oracode device. */
+                            check_out_time: string
+                            /** Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot. */
+                            is_24_hour: boolean
+                            /** Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode. */
+                            is_biweekly_mode: boolean
+                            /** Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot. */
+                            is_one_shot: boolean
+                            /** Indicates whether a time slot for a dormakaba Oracode device is a master time slot. */
+                            is_master: boolean
+                            /** Prefix for a user level for a dormakaba Oracode device. */
+                            ext_dormakaba_oracode_user_level_prefix: number
+                            /** ID of a user level for a dormakaba Oracode device. */
+                            dormakaba_oracode_user_level_id: string
+                          }>
+                        | undefined
+                    }
+                  | undefined
+                /** Metadata for a Wyze device. */
+                wyze_metadata?:
+                  | {
+                      /** Device ID for a Wyze device. */
+                      device_id: string
+                      /** Device name for a Wyze device. */
+                      device_name: string
+                      /** Product name for a Wyze device. */
+                      product_name: string
+                      /** Product type for a Wyze device. */
+                      product_type: string
+                      /** Product model for a Wyze device. */
+                      product_model: string
+                      /** Device information model for a Wyze device. */
+                      device_info_model: string
+                      /** Keypad UUID for a Wyze device. */
+                      keypad_uuid?: string | undefined
+                      /** Locker status (hardlock) for a Wyze device. */
+                      locker_status_hardlock?: number | undefined
+                    }
+                  | undefined
+                /** Metadata for a Tedee device. */
+                tedee_metadata?:
+                  | {
+                      /** Device ID for a Tedee device. */
+                      device_id: number
+                      /** Serial number for a Tedee device. */
+                      serial_number: string
+                      /** Device name for a Tedee device. */
+                      device_name: string
+                      /** Device model for a Tedee device. */
+                      device_model: string
+                      /** Bridge ID for a Tedee device. */
+                      bridge_id: number
+                      /** Bridge name for a Tedee device. */
+                      bridge_name: string
+                      /** Keypad ID for a Tedee device. */
+                      keypad_id?: number | undefined
+                    }
+                  | undefined
+                /** Metadata for an ASSA ABLOY Visionline system. */
+                visionline_metadata?:
+                  | {
+                      /** Encoder ID for an ASSA ABLOY Visionline system. */
+                      encoder_id: string
+                    }
+                  | undefined
+                /** Metadata for an Akiles device. */
+                akiles_metadata?:
+                  | {
+                      /** Gadget name for an Akiles device. */
+                      gadget_name: string
+                      /** Gadget ID for an Akiles device. */
+                      gadget_id: string
+                      /** Product name for an Akiles device. */
+                      product_name: string
+                      /** Group ID to which to add users for an Akiles device. */
+                      _member_group_id?: string | undefined
+                    }
+                  | undefined
+                /** Metadata for an ASSA ABLOY Vostio system. */
+                assa_abloy_vostio_metadata?:
+                  | {
+                      /** Encoder name for an ASSA ABLOY Vostio system. */
+                      encoder_name: string
+                    }
+                  | undefined
+                /** Metadata for a tado° device. */
+                tado_metadata?:
+                  | {
+                      /** Serial number for a tado° device. */
+                      serial_no: string
+                      /** Device type for a tado° device. */
+                      device_type: string
+                    }
+                  | undefined
+                /** Metadata for a Sensi device. */
+                sensi_metadata?:
+                  | {
+                      /** Device ID for a Sensi device. */
+                      device_id: string
+                      /** Device name for a Sensi device. */
+                      device_name: string
+                      /** Product type for a Sensi device. */
+                      product_type: string
+                    }
+                  | undefined
+              }) &
+                ({
+                  /**  */
+                  _experimental_supported_code_from_access_codes_lengths?:
+                    | (number[] | undefined)
+                    | undefined
+                  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
+                  code_constraints?:
+                    | (
+                        | Array<
+                            | {
+                                /** Code constraint type for access codes. */
+                                constraint_type:
+                                  | 'no_zeros'
+                                  | 'cannot_start_with_12'
+                                  | 'no_triple_consecutive_ints'
+                                  | 'cannot_specify_pin_code'
+                                  | 'pin_code_matches_existing_set'
+                                  | 'start_date_in_future'
+                                  | 'no_ascending_or_descending_sequence'
+                                  | 'at_least_three_unique_digits'
+                                  | 'cannot_contain_089'
+                                  | 'cannot_contain_0789'
+                              }
+                            | {
+                                constraint_type:
+                                  | 'name_length'
+                                  | 'name_must_be_unique'
+                                /** Minimum name length constraint for access codes. */
+                                min_length?: number | undefined
+                                /** Maximum name length constraint for access codes. */
+                                max_length?: number | undefined
+                              }
+                          >
+                        | undefined
+                      )
+                    | undefined
+                  /** Supported code lengths for access codes. */
+                  supported_code_lengths?: (number[] | undefined) | undefined
+                  /** Maximum number of active access codes that the device supports. */
+                  max_active_codes_supported?: (number | undefined) | undefined
+                  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). */
+                  supports_backup_access_code_pool?:
+                    | (boolean | undefined)
+                    | undefined
+                  /** Indicates whether the device supports native entry events. */
+                  has_native_entry_events?: (boolean | undefined) | undefined
+                  /** Indicates whether the lock is locked. */
+                  locked?: (boolean | undefined) | undefined
+                  /** Keypad battery status. */
+                  keypad_battery?:
+                    | (
+                        | {
+                            /**
+                              Keypad battery charge level.
+                               */
+                            level: number
+                          }
+                        | undefined
+                      )
+                    | undefined
+                  /** Indicates whether the door is open. */
+                  door_open?: (boolean | undefined) | undefined
+                } & {
+                  /** Reported temperature in °F. */
+                  temperature_fahrenheit?: number | undefined
+                  /** Reported temperature in °C. */
+                  temperature_celsius?: number | undefined
+                  /** Reported relative humidity, as a value between 0 and 1, inclusive. */
+                  relative_humidity?: number | undefined
+                  /** HVAC mode settings that the thermostat supports. */
+                  available_hvac_mode_settings?:
+                    | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
+                    | undefined
+                  /** Fan mode settings that the thermostat supports. */
+                  available_fan_mode_settings?:
+                    | Array<'auto' | 'on' | 'circulate'>
+                    | undefined
+                  /** Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied". */
+                  available_climate_preset_modes?:
+                    | Array<
+                        | 'home'
+                        | 'away'
+                        | 'wake'
+                        | 'sleep'
+                        | 'occupied'
+                        | 'unoccupied'
+                      >
+                    | undefined
+                  /** Indicates whether the connected HVAC system is currently heating, as reported by the thermostat. */
+                  is_heating?: boolean | undefined
+                  /** Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat. */
+                  is_cooling?: boolean | undefined
+                  /** Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat. */
+                  is_fan_running?: boolean | undefined
+                  /**
+                   * @deprecated Use `current_climate_setting.fan_mode_setting` instead. */
+                  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
+                  /** Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`. */
+                  is_temporary_manual_override_active?: boolean | undefined
+                  /** Current climate setting. */
+                  current_climate_setting?:
+                    | {
+                        /** Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        climate_preset_key?: string | undefined
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */
+                        can_edit?: boolean | undefined
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */
+                        can_delete?: boolean | undefined
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */
+                        can_program?: boolean | undefined
+                        /** User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        name?: ((string | null) | undefined) | undefined
+                        /** Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        display_name?: string | undefined
+                        /**
+                        The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
+                       */
+                        climate_preset_mode?:
+                          | (
+                              | (
+                                  | 'home'
+                                  | 'away'
+                                  | 'wake'
+                                  | 'sleep'
+                                  | 'occupied'
+                                  | 'unoccupied'
+                                )
+                              | undefined
+                            )
+                          | undefined
+                        /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
+                        fan_mode_setting?:
+                          | (('auto' | 'on' | 'circulate') | undefined)
+                          | undefined
+                        /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
+                        hvac_mode_setting?:
+                          | (
+                              | ('off' | 'heat' | 'cool' | 'heat_cool')
+                              | undefined
+                            )
+                          | undefined
+                        /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        cooling_set_point_celsius?:
+                          | (number | undefined)
+                          | undefined
+                        /** Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        heating_set_point_celsius?:
+                          | (number | undefined)
+                          | undefined
+                        /** Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        cooling_set_point_fahrenheit?:
+                          | (number | undefined)
+                          | undefined
+                        /** Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        heating_set_point_fahrenheit?:
+                          | (number | undefined)
+                          | undefined
+                        /** Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+                         * @deprecated Use 'thermostat_schedule.is_override_allowed' */
+                        manual_override_allowed?: boolean | undefined
+                        /**
+                        Metadata specific to the Ecobee climate, if applicable.
+                       */
+                        ecobee_metadata?:
+                          | (
+                              | {
+                                  /** Reference to the Ecobee climate, if applicable. */
+                                  climate_ref: string
+                                  /** Indicates if the climate preset is optimized by Ecobee. */
+                                  is_optimized: boolean
+                                  /** Indicates whether the climate preset is owned by the user or the system. */
+                                  owner: 'user' | 'system'
+                                }
+                              | undefined
+                            )
+                          | undefined
+                      }
+                    | undefined
+                  /**
+                   * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
+                  default_climate_setting?:
+                    | {
+                        /** Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        climate_preset_key?: string | undefined
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */
+                        can_edit?: boolean | undefined
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */
+                        can_delete?: boolean | undefined
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */
+                        can_program?: boolean | undefined
+                        /** User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        name?: ((string | null) | undefined) | undefined
+                        /** Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        display_name?: string | undefined
+                        /**
+                        The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
+                       */
+                        climate_preset_mode?:
+                          | (
+                              | (
+                                  | 'home'
+                                  | 'away'
+                                  | 'wake'
+                                  | 'sleep'
+                                  | 'occupied'
+                                  | 'unoccupied'
+                                )
+                              | undefined
+                            )
+                          | undefined
+                        /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
+                        fan_mode_setting?:
+                          | (('auto' | 'on' | 'circulate') | undefined)
+                          | undefined
+                        /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
+                        hvac_mode_setting?:
+                          | (
+                              | ('off' | 'heat' | 'cool' | 'heat_cool')
+                              | undefined
+                            )
+                          | undefined
+                        /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        cooling_set_point_celsius?:
+                          | (number | undefined)
+                          | undefined
+                        /** Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        heating_set_point_celsius?:
+                          | (number | undefined)
+                          | undefined
+                        /** Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        cooling_set_point_fahrenheit?:
+                          | (number | undefined)
+                          | undefined
+                        /** Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        heating_set_point_fahrenheit?:
+                          | (number | undefined)
+                          | undefined
+                        /** Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+                         * @deprecated Use 'thermostat_schedule.is_override_allowed' */
+                        manual_override_allowed?: boolean | undefined
+                        /**
+                        Metadata specific to the Ecobee climate, if applicable.
+                       */
+                        ecobee_metadata?:
+                          | (
+                              | {
+                                  /** Reference to the Ecobee climate, if applicable. */
+                                  climate_ref: string
+                                  /** Indicates if the climate preset is optimized by Ecobee. */
+                                  is_optimized: boolean
+                                  /** Indicates whether the climate preset is owned by the user or the system. */
+                                  owner: 'user' | 'system'
+                                }
+                              | undefined
+                            )
+                          | undefined
+                      }
+                    | undefined
+                  /** Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. */
+                  available_climate_presets?:
+                    | Array<{
+                        /** Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        climate_preset_key: string
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */
+                        can_edit: boolean
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */
+                        can_delete: boolean
+                        /** Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */
+                        can_program: boolean
+                        /** User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        name?: (string | null) | undefined
+                        /** Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). */
+                        display_name: string
+                        /**
+                        The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
+                       */
+                        climate_preset_mode?:
+                          | (
+                              | 'home'
+                              | 'away'
+                              | 'wake'
+                              | 'sleep'
+                              | 'occupied'
+                              | 'unoccupied'
+                            )
+                          | undefined
+                        /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
+                        fan_mode_setting?:
+                          | ('auto' | 'on' | 'circulate')
+                          | undefined
+                        /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
+                        hvac_mode_setting?:
+                          | ('off' | 'heat' | 'cool' | 'heat_cool')
+                          | undefined
+                        /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        cooling_set_point_celsius?: number | undefined
+                        /** Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        heating_set_point_celsius?: number | undefined
+                        /** Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        cooling_set_point_fahrenheit?: number | undefined
+                        /** Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
+                        heating_set_point_fahrenheit?: number | undefined
+                        /** Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+                         * @deprecated Use 'thermostat_schedule.is_override_allowed' */
+                        manual_override_allowed: boolean
+                        /**
+                        Metadata specific to the Ecobee climate, if applicable.
+                       */
+                        ecobee_metadata?:
+                          | {
+                              /** Reference to the Ecobee climate, if applicable. */
+                              climate_ref: string
+                              /** Indicates if the climate preset is optimized by Ecobee. */
+                              is_optimized: boolean
+                              /** Indicates whether the climate preset is owned by the user or the system. */
+                              owner: 'user' | 'system'
+                            }
+                          | undefined
+                      }>
+                    | undefined
+                  /** Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */
+                  fallback_climate_preset_key?: (string | null) | undefined
+                  /** Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+                   * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */
+                  active_thermostat_schedule?:
+                    | ({
+                        /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
+                        thermostat_schedule_id: string
+                        /** ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. */
+                        device_id: string
+                        /** User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
+                        name: string | null
+                        /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
+                        climate_preset_key: string
+                        /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
+                        max_override_period_minutes?:
+                          | (number | null)
+                          | undefined
+                        /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string
+                        /** Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */
+                        is_override_allowed?: boolean | undefined
+                        /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        ends_at: string
+                        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. */
+                        workspace_id: string
+                        /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */
+                        created_at: string
+                        /** Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
+                        errors: Array<{
+                          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                          error_code: string
+                          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                          message: string
+                        }>
+                      } | null)
+                    | undefined
+                  /** ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
+                  active_thermostat_schedule_id?: (string | null) | undefined
+                  /** Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
+                  thermostat_daily_programs?:
+                    | (
+                        | Array<{
+                            /** ID of the thermostat daily program. */
+                            thermostat_daily_program_id: string
+                            /** ID of the thermostat device on which the thermostat daily program is configured. */
+                            device_id: string
+                            /** User-friendly name to identify the thermostat daily program. */
+                            name: string | null
+                            /** Array of thermostat daily program periods. */
+                            periods: Array<{
+                              /** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                              starts_at_time: string
+                              /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
+                              climate_preset_key: string
+                            }>
+                            /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program. */
+                            workspace_id: string
+                            /** Date and time at which the thermostat daily program was created. */
+                            created_at: string
+                          }>
+                        | undefined
+                      )
+                    | undefined
+                  /** Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */
+                  thermostat_weekly_program?:
+                    | (
+                        | ({
+                            /** ID of the thermostat daily program to run on Mondays. */
+                            monday_program_id: string | null
+                            /** ID of the thermostat daily program to run on Tuesdays. */
+                            tuesday_program_id: string | null
+                            /** ID of the thermostat daily program to run on Wednesdays. */
+                            wednesday_program_id: string | null
+                            /** ID of the thermostat daily program to run on Thursdays. */
+                            thursday_program_id: string | null
+                            /** ID of the thermostat daily program to run on Fridays. */
+                            friday_program_id: string | null
+                            /** ID of the thermostat daily program to run on Saturdays. */
+                            saturday_program_id: string | null
+                            /** ID of the thermostat daily program to run on Sundays. */
+                            sunday_program_id: string | null
+                            /** Date and time at which the thermostat weekly program was created. */
+                            created_at: string
+                          } | null)
+                        | undefined
+                      )
+                    | undefined
+                  /** Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. */
+                  min_cooling_set_point_celsius?: number | undefined
+                  /** Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. */
+                  min_cooling_set_point_fahrenheit?: number | undefined
+                  /** Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. */
+                  max_cooling_set_point_celsius?: number | undefined
+                  /** Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. */
+                  max_cooling_set_point_fahrenheit?: number | undefined
+                  /** Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. */
+                  min_heating_set_point_celsius?: number | undefined
+                  /** Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. */
+                  min_heating_set_point_fahrenheit?: number | undefined
+                  /** Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. */
+                  max_heating_set_point_celsius?: number | undefined
+                  /** Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. */
+                  max_heating_set_point_fahrenheit?: number | undefined
+                  /** Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode. */
+                  min_heating_cooling_delta_celsius?: number | undefined
+                  /** Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode. */
+                  min_heating_cooling_delta_fahrenheit?: number | undefined
+                  /** Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */
+                  temperature_threshold?:
+                    | (
+                        | {
+                            /** Lower limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
+                             */
+                            lower_limit_celsius: number | null
+                            /** Lower limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
+                             */
+                            lower_limit_fahrenheit: number | null
+                            /** Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
+                             */
+                            upper_limit_celsius: number | null
+                            /** Upper limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
+                             */
+                            upper_limit_fahrenheit: number | null
+                          }
+                        | undefined
+                      )
+                    | 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<
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is not a device error. */
+                    is_device_error: false
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'account_disconnected'
+                    /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
+                    is_connected_account_error: true
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is not a device error. */
+                    is_device_error: false
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'salto_ks_subscription_limit_exceeded'
+                    /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
+                    is_connected_account_error: true
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'device_offline'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'device_removed'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'hub_disconnected'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'device_disconnected'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'empty_backup_access_code_pool'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'august_lock_not_authorized'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'august_lock_missing_bridge'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'ttlock_lock_not_paired_to_gateway'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'missing_device_credentials'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'auxiliary_heat_running'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'subscription_required'
+                  }
+                | {
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates that the error is a device error. */
+                    is_device_error: true
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'lockly_missing_wifi_bridge'
+                  }
+                | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates whether the error is related specifically to the connected account. */
+                    is_connected_account_error?: boolean | undefined
+                    /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
+                    is_bridge_error?: boolean | undefined
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'invalid_credentials'
+                  }
+                | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Indicates whether the error is related specifically to the connected account. */
+                    is_connected_account_error?: boolean | undefined
+                    /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
+                    is_bridge_error?: boolean | undefined
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'bridge_disconnected'
+                  }
+              >
+              /** 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<
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'partial_backup_access_code_pool'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'many_active_backup_codes'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'wyze_device_missing_gateway'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'functional_offline_device'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'third_party_integration_detected'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'nest_thermostat_in_manual_eco_mode'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'ttlock_lock_gateway_unlocking_not_enabled'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'ttlock_weak_gateway_signal'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'power_saving_mode'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'temperature_threshold_exceeded'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'device_communication_degraded'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'scheduled_maintenance_window'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'device_has_flaky_connection'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_office_mode'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_privacy_mode'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_subscription_limit_almost_reached'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'unknown_issue_with_phone'
+                  }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'lockly_time_zone_not_configured'
+                  }
+              >
+              /** Date and time at which the device object was created. */
+              created_at: string
+              /** Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
+              is_managed: true
+              /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
+              custom_metadata: Record<string, string | boolean>
+              can_remotely_unlock?: boolean | undefined
+              can_remotely_lock?: boolean | undefined
+              can_program_offline_access_codes?: boolean | undefined
+              can_program_online_access_codes?: boolean | undefined
+              can_hvac_heat?: boolean | undefined
+              can_hvac_cool?: boolean | undefined
+              can_hvac_heat_cool?: boolean | undefined
+              can_turn_off_hvac?: boolean | undefined
+              can_simulate_removal?: boolean | undefined
+              can_simulate_connection?: boolean | undefined
+              can_simulate_disconnection?: boolean | undefined
+              can_unlock_with_code?: boolean | undefined
+            }>
+          | undefined
+        acs_entrances?:
+          | Array<{
+              /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              acs_system_id: string
+              /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              acs_entrance_id: string
+              /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
+              created_at: string
+              /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              display_name: string
+              /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              connected_account_id: string
+              /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              errors: Array<{
+                /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                error_code: string
+                /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                message: string
+              }>
+              /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              latch_metadata?:
+                | {
+                    /** Accessibility type in the Latch access system. */
+                    accessibility_type: string
+                    /** Name of the door in the Latch access system. */
+                    door_name: string
+                    /** Type of the door in the Latch access system. */
+                    door_type: string
+                    /** Indicates whether the entrance is connected. */
+                    is_connected: boolean
+                  }
+                | undefined
+              /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              visionline_metadata?:
+                | {
+                    /** Name of the door in the Visionline access system. */
+                    door_name: string
+                    /** Category of the door in the Visionline access system. */
+                    door_category:
+                      | 'entrance'
+                      | 'guest'
+                      | 'elevator reader'
+                      | 'common'
+                      | 'common (PMS)'
+                    /** Profile for the door in the Visionline access system. */
+                    profiles?:
+                      | Array<{
+                          /** Door profile ID in the Visionline access system. */
+                          visionline_door_profile_id: string
+                          /** Door profile type in the Visionline access system. */
+                          visionline_door_profile_type:
+                            | 'BLE'
+                            | 'commonDoor'
+                            | 'touch'
+                        }>
+                      | undefined
+                  }
+                | undefined
+              /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              salto_ks_metadata?:
+                | {
+                    /** Name of the door in the Salto KS access system. */
+                    door_name: string
+                    /** Locked state of the door in the Salto KS access system. */
+                    locked_state: string
+                    /** Type of the lock in the Salto KS access system. */
+                    lock_type: string
+                    /** Indicates whether the door access device is online. */
+                    online?: boolean | undefined
+                    /** Battery level of the door access device. */
+                    battery_level: string
+                    /** Indicates whether the door is left open. */
+                    left_open_alarm?: boolean | undefined
+                    /** Indicates whether an intrusion alarm is active on the door. */
+                    intrusion_alarm?: boolean | undefined
+                    /** Indicates whether privacy mode is enabled for the lock. */
+                    privacy_mode?: boolean | undefined
+                  }
+                | undefined
+              /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              dormakaba_community_metadata?:
+                | {
+                    /** Name of the access point in the dormakaba Community access system. */
+                    access_point_name: string
+                  }
+                | undefined
+              /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              assa_abloy_vostio_metadata?:
+                | {
+                    /** Type of the door in the Vostio access system. */
+                    door_type:
+                      | 'CommonDoor'
+                      | 'EntranceDoor'
+                      | 'GuestDoor'
+                      | 'Elevator'
+                    /** Name of the door in the Vostio access system. */
+                    door_name: string
+                    /** Number of the door in the Vostio access system. */
+                    door_number?: number | undefined
+                    /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
+                    stand_open?: boolean | undefined
+                    /** PMS ID of the door in the Vostio access system. */
+                    pms_id?: string | undefined
+                  }
+                | undefined
+              /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              salto_space_metadata?:
+                | {
+                    /** Name of the door in the Salto Space access system. */
+                    door_name: string
+                    /** External door ID in the Salto Space access system. */
+                    ext_door_id: string
+                    /** Description of the door in the Salto Space access system. */
+                    door_description?: string | undefined
+                  }
+                | undefined
+              /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
+              can_unlock_with_mobile_key?: boolean | undefined
+              /** Indicates whether the ACS entrance can be unlocked with card credentials. */
+              can_unlock_with_card?: boolean | undefined
+              /** Indicates whether the ACS entrance can be unlocked with pin codes. */
+              can_unlock_with_code?: boolean | undefined
+            }>
+          | undefined
+      }
+    }
+  }
   '/spaces/list': {
     route: '/spaces/list'
     method: 'GET' | 'POST'
@@ -72854,6 +75384,8 @@ export interface Routes {
               warning_code: 'acs_user_profile_does_not_match_user_identity'
             }
         >
+        /** Array of access system user IDs associated with the user identity. */
+        acs_user_ids: string[]
       }
     }
   }
@@ -73065,6 +75597,8 @@ export interface Routes {
               warning_code: 'acs_user_profile_does_not_match_user_identity'
             }
         >
+        /** Array of access system user IDs associated with the user identity. */
+        acs_user_ids: string[]
       }
     }
   }
@@ -73142,6 +75676,8 @@ export interface Routes {
               warning_code: 'acs_user_profile_does_not_match_user_identity'
             }
         >
+        /** Array of access system user IDs associated with the user identity. */
+        acs_user_ids: string[]
       }>
     }
   }