@seamapi/types 1.293.0 → 1.294.0

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

@@ -11436,7 +11436,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -11474,7 +11475,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -11504,7 +11506,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -12312,7 +12315,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -12350,7 +12354,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -12380,7 +12385,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -13903,7 +13909,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -13941,7 +13948,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -13971,7 +13979,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -14596,7 +14605,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -14634,7 +14644,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -14664,7 +14675,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -15472,7 +15484,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -15510,7 +15523,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -15540,7 +15554,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -16165,7 +16180,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -16203,7 +16219,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -16233,7 +16250,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -18793,7 +18811,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -18831,7 +18850,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -18861,7 +18881,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -19486,7 +19507,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -19524,7 +19546,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -19554,7 +19577,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -24234,6 +24258,7 @@ export interface Routes {
     jsonBody: {
       /** ID of the desired thermostat device. */
       device_id: string
+      manual_override_allowed?: boolean
       /** Unique key to identify the climate preset. */
       climate_preset_key: string
       /** User-friendly name to identify the climate preset. */
@@ -24250,8 +24275,6 @@ export interface Routes {
       cooling_set_point_fahrenheit?: number | undefined
       /** Temperature to which the thermostat should heat (in °F). */
       heating_set_point_fahrenheit?: number | undefined
-      /** Indicates whether a person at the thermostat can change the thermostat's settings. */
-      manual_override_allowed: boolean
     }
     commonParams: {}
     formData: {}
@@ -24811,7 +24834,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -24849,7 +24873,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -24879,7 +24904,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -27421,7 +27447,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -27459,7 +27486,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -27489,7 +27517,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -28114,7 +28143,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -28152,7 +28182,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -28182,7 +28213,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -30220,7 +30252,8 @@ export interface Routes {
       cooling_set_point_fahrenheit?: number | undefined
       /** Temperature to which the thermostat should heat (in °F). */
       heating_set_point_fahrenheit?: number | undefined
-      /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+      /** Indicates whether a person at the thermostat can change the thermostat's settings.
+       * @deprecated Use 'thermostat_schedule.is_override_allowed' */
       manual_override_allowed: boolean
     }
     commonParams: {}
@@ -30233,7 +30266,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired user identity. */
       user_identity_id: string
+      /** ID of the desired ACS user. */
       acs_user_id: string
     }
     formData: {}
@@ -30245,21 +30280,32 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** Unique key for the user identity. */
       user_identity_key?: (string | null) | undefined
+      /** Unique email address for the user identity. */
       email_address?: (string | null) | undefined
+      /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
       phone_number?: (string | null) | undefined
+      /** Full name of the user associated with the user identity. */
       full_name?: (string | null) | undefined
     }
     formData: {}
     jsonResponse: {
+      /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
       user_identity: {
+        /** ID of the user identity. */
         user_identity_id: string
+        /** Unique key for the user identity. */
         user_identity_key: string | null
+        /** Unique email address for the user identity. */
         email_address: string | null
+        /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
         phone_number: string | null
         display_name: string
         full_name: string | null
+        /** Date and time at which the user identity was created. */
         created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
         workspace_id: string
       }
     }
@@ -30270,6 +30316,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired user identity. */
       user_identity_id: string
     }
     formData: {}
@@ -30281,6 +30328,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired enrollment automation. */
       enrollment_automation_id: string
     }
     formData: {}
@@ -30292,16 +30340,23 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired enrollment automation. */
       enrollment_automation_id: string
     }
     formData: {}
     jsonResponse: {
+      /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). */
       enrollment_automation: {
+        /** ID of the enrollment automation. */
+        enrollment_automation_id: string
+        /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
         credential_manager_acs_system_id: string
+        /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
         user_identity_id: string
+        /** Date and time at which the enrollment automation was created. */
         created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
         workspace_id: string
-        enrollment_automation_id: string
       }
     }
   }
@@ -30311,10 +30366,15 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired user identity. */
       user_identity_id: string
+      /** ID of the desired ACS system that serves as the credential manager. */
       credential_manager_acs_system_id: string
+      /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
       acs_credential_pool_id?: string | undefined
+      /** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
       create_credential_manager_user?: boolean | undefined
+      /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
       credential_manager_acs_user_id?: string | undefined
     }
     formData: {}
@@ -30335,16 +30395,22 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the user identity for which you want to retrieve all enrollment automations. */
       user_identity_id: string
     }
     formData: {}
     jsonResponse: {
       enrollment_automations: Array<{
+        /** ID of the enrollment automation. */
+        enrollment_automation_id: string
+        /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
         credential_manager_acs_system_id: string
+        /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
         user_identity_id: string
+        /** Date and time at which the enrollment automation was created. */
         created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
         workspace_id: string
-        enrollment_automation_id: string
       }>
     }
   }
@@ -30355,6 +30421,7 @@ export interface Routes {
     jsonBody: {}
     commonParams:
       | {
+          /** ID of the desired user identity. */
           user_identity_id: string
         }
       | {
@@ -30362,14 +30429,21 @@ export interface Routes {
         }
     formData: {}
     jsonResponse: {
+      /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
       user_identity: {
+        /** ID of the user identity. */
         user_identity_id: string
+        /** Unique key for the user identity. */
         user_identity_key: string | null
+        /** Unique email address for the user identity. */
         email_address: string | null
+        /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
         phone_number: string | null
         display_name: string
         full_name: string | null
+        /** Date and time at which the user identity was created. */
         created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
         workspace_id: string
       }
     }
@@ -30380,7 +30454,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired user identity. */
       user_identity_id: string
+      /** ID of the desired managed device. */
       device_id: string
     }
     formData: {}
@@ -30397,13 +30473,19 @@ export interface Routes {
     formData: {}
     jsonResponse: {
       user_identities: Array<{
+        /** ID of the user identity. */
         user_identity_id: string
+        /** Unique key for the user identity. */
         user_identity_key: string | null
+        /** Unique email address for the user identity. */
         email_address: string | null
+        /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
         phone_number: string | null
         display_name: string
         full_name: string | null
+        /** Date and time at which the user identity was created. */
         created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
         workspace_id: string
       }>
     }
@@ -30414,6 +30496,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the user identity for which you want to retrieve all accessible devices. */
       user_identity_id: string
     }
     formData: {}
@@ -30945,7 +31028,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -30983,7 +31067,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -31013,7 +31098,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -31640,7 +31726,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -31678,7 +31765,8 @@ export interface Routes {
                   heating_set_point_fahrenheit?:
                     | (number | undefined)
                     | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed?: boolean | undefined
                 }
               | undefined
@@ -31708,7 +31796,8 @@ export interface Routes {
                   cooling_set_point_fahrenheit?: number | undefined
                   /** Temperature to which the thermostat should heat (in °F). */
                   heating_set_point_fahrenheit?: number | undefined
-                  /** Indicates whether a person at the thermostat can change the thermostat's settings. */
+                  /** Indicates whether a person at the thermostat can change the thermostat's settings.
+                   * @deprecated Use 'thermostat_schedule.is_override_allowed' */
                   manual_override_allowed: boolean
                 }>
               | undefined
@@ -31814,6 +31903,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the user identity for which you want to retrieve all access control systems. */
       user_identity_id: string
     }
     formData: {}
@@ -31960,6 +32050,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the user identity for which you want to retrieve all ACS users. */
       user_identity_id: string
     }
     formData: {}
@@ -32082,7 +32173,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired user identity. */
       user_identity_id: string
+      /** ID of the ACS user. */
       acs_user_id: string
     }
     formData: {}
@@ -32094,7 +32187,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired user identity. */
       user_identity_id: string
+      /** ID of the desired managed device. */
       device_id: string
     }
     formData: {}
@@ -32105,9 +32200,13 @@ export interface Routes {
     method: 'PATCH' | 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the user identity. */
       user_identity_id: string
+      /** Unique key for the user identity. */
       user_identity_key?: (string | null) | undefined
+      /** Unique email address for the user identity. */
       email_address?: (string | null) | undefined
+      /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
       phone_number?: (string | null) | undefined
       full_name?: (string | null) | undefined
     }