@seamapi/types 1.399.0 → 1.399.1

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

@@ -4,9 +4,15 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the device for which to create the new access code. */
+            /** ID of the device for which you want to create the new access code. */
             device_id: string;
-            /** Name of the new access code. */
+            /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                
+                Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                
+                To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                
+                To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
             name?: string | undefined;
             /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             starts_at?: string | undefined;
@@ -1147,7 +1153,7 @@ export interface Routes {
           
           An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
           
-          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
+          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
@@ -1163,7 +1169,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -1606,13 +1618,19 @@ export interface Routes {
         method: 'POST' | 'PUT';
         queryParams: {};
         jsonBody: {
-            /** IDs of the devices for which to create the new access codes. */
+            /** IDs of the devices for which you want to create the new access codes. */
             device_ids: string[];
             /** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
             behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
             /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
             preferred_code_length?: number | undefined;
-            /** Name of the new access code. */
+            /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                
+                Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                
+                To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                
+                To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
             name?: string | undefined;
             /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             starts_at?: string | undefined;
@@ -1653,7 +1671,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -2097,9 +2121,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the device for which to delete the access code. */
+            /** ID of the device for which you want to delete the access code. */
             device_id?: string | undefined;
-            /** ID of the access code to delete. */
+            /** ID of the access code that you want to delete. */
             access_code_id: string;
             /**  */
             sync?: boolean;
@@ -3217,6 +3241,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the device for which you want to generate a code. */
             device_id: string;
         };
         formData: {};
@@ -3246,7 +3271,7 @@ export interface Routes {
           
           An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
           
-          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
+          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
@@ -3262,7 +3287,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -3732,7 +3763,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -4194,7 +4231,7 @@ export interface Routes {
           
           An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
           
-          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
+          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             backup_access_code: {
@@ -4210,7 +4247,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -4650,7 +4693,7 @@ export interface Routes {
           
           An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
           
-          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
+          Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
@@ -4666,7 +4709,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -5109,7 +5158,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the device for which to report constraints. */
+            /** ID of the device for which you want to report constraints. */
             device_id: string;
             /** Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`. */
             supported_code_lengths?: number[] | undefined;
@@ -5143,7 +5192,11 @@ export interface Routes {
           
           When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
           
-          Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
+          Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
+          
+          Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
+          
+          - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
             access_code: {
                 /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
@@ -5151,7 +5204,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -5585,9 +5644,9 @@ export interface Routes {
         commonParams: {
             /** ID of the unmanaged access code that you want to convert to a managed access code. */
             access_code_id: string;
-            /** Indicates whether external modification of the access code is allowed. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
             is_external_modification_allowed?: boolean | undefined;
-            /** Indicates whether external modification of the access code is allowed. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
             allow_external_modification?: boolean | undefined;
             /** Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. */
             force?: boolean | undefined;
@@ -5603,7 +5662,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the unmanaged access code to delete. */
+            /** ID of the unmanaged access code that you want to delete. */
             access_code_id: string;
             /**  */
             sync?: boolean;
@@ -6736,7 +6795,11 @@ export interface Routes {
           
           When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
           
-          Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
+          Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
+          
+          Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
+          
+          - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
             access_code: {
                 /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
@@ -6744,7 +6807,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -7190,7 +7259,13 @@ export interface Routes {
                 access_code_id: string;
                 /** Unique identifier for the device associated with the access code. */
                 device_id: string;
-                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                      
+                      Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                      
+                      To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                      
+                      To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
                 name: string | null;
                 /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
@@ -7640,7 +7715,13 @@ export interface Routes {
         method: 'POST' | 'PATCH' | 'PUT';
         queryParams: {};
         jsonBody: {
-            /** Name of the new access code. */
+            /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                
+                Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                
+                To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                
+                To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
             name?: string | undefined;
             /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             starts_at?: string | undefined;
@@ -8794,7 +8875,13 @@ export interface Routes {
             ends_at?: string | undefined;
             /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             starts_at?: string | undefined;
-            /** Name of the new access code. */
+            /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+                
+                Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+                
+                To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+                
+                To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
             name?: string | undefined;
             /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
             common_code_key: string;
@@ -8809,9 +8896,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired access group. */
+            /** ID of the access group to which you want to add an access system user. */
             acs_access_group_id: string;
-            /** ID of the desired user. */
+            /** ID of the access system user that you want to add to an access group. */
             acs_user_id: string;
         };
         formData: {};
@@ -8823,7 +8910,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired access group. */
+            /** ID of the access group that you want to get. */
             acs_access_group_id: string;
         };
         formData: {};
@@ -8874,9 +8961,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the access control system for which you want to retrieve all access groups. */
+            /** ID of the access system for which you want to retrieve all access groups. */
             acs_system_id?: string | undefined;
-            /** ID of the user for which you want to retrieve all access groups. */
+            /** ID of the access system user for which you want to retrieve all access groups. */
             acs_user_id?: string | undefined;
             /** ID of the user identity for which you want to retrieve all access groups. */
             user_identity_id?: string | undefined;
@@ -8999,7 +9086,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the access group for which you want to retrieve all users. */
+            /** ID of the access group for which you want to retrieve all access system users. */
             acs_access_group_id: string;
         };
         formData: {};
@@ -9194,11 +9281,11 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired access group. */
+            /** ID of the access group from which you want to remove an access system user. */
             acs_access_group_id: string;
-            /** ID of the desired user. */
+            /** ID of the access system user that you want to remove from an access group. */
             acs_user_id?: string | undefined;
-            /** ID of the desired user identity. */
+            /** ID of the user identity associated with the user that you want to remove from an access group. */
             user_identity_id?: string | undefined;
         };
         formData: {};
@@ -9210,7 +9297,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired unmanaged access group. */
+            /** ID of the unmanaged access group that you want to get. */
             acs_access_group_id: string;
         };
         formData: {};
@@ -9257,9 +9344,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the access control system for which you want to retrieve all unmanaged access groups. */
+            /** ID of the access system for which you want to retrieve all unmanaged access groups. */
             acs_system_id?: string | undefined;
-            /** ID of the user for which you want to retrieve all unmanaged access groups. */
+            /** ID of the access system user for which you want to retrieve all unmanaged access groups. */
             acs_user_id?: string | undefined;
         };
         formData: {};
@@ -9305,6 +9392,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the access system for which you want to list credential pools. */
             acs_system_id: string;
         };
         formData: {};
@@ -9326,10 +9414,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the user identity for which you want to launch a credential provisioning automation. */
             user_identity_id: string;
+            /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
             credential_manager_acs_system_id: string;
+            /** ID of the credential pool for which you want to launch a credential provisioning automation. */
             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 access system 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: {};
@@ -9349,9 +9442,9 @@ export interface Routes {
         method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the desired user. */
+            /** ID of the access system user to whom you want to assign a credential. */
             acs_user_id: string;
-            /** ID of the desired credential. */
+            /** ID of the credential that you want to assign to an access system user. */
             acs_credential_id: string;
         };
         commonParams: {};
@@ -9485,11 +9578,11 @@ export interface Routes {
         commonParams: {
             /** ACS system ID of the credential manager for the new credential. */
             credential_manager_acs_system_id?: string | undefined;
-            /** ID of the ACS user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
+            /** ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
             acs_user_id?: string | undefined;
-            /** ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
+            /** ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created. */
             user_identity_id?: string | undefined;
-            /** ID of the ACS system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
+            /** ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
             acs_system_id?: string | undefined;
             /** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. */
             access_method: 'code' | 'card' | 'mobile_key';
@@ -9522,7 +9615,9 @@ export interface Routes {
             } | undefined;
             /** Salto Space-specific metadata for the new credential. */
             salto_space_metadata?: {
+                /** Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
                 assign_new_key?: boolean | undefined;
+                /** Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
                 update_current_key?: boolean | undefined;
             } | undefined;
             /** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -9658,7 +9753,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the ACS user to whom the new credential belongs. */
+            /** ID of the access system user to whom the new credential belongs. */
             acs_user_id: string;
             /** IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
             allowed_acs_entrance_id: string;
@@ -9797,7 +9892,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired credential. */
+            /** ID of the credential that you want to delete. */
             acs_credential_id: string;
         };
         formData: {};
@@ -9809,7 +9904,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired credential. */
+            /** ID of the credential that you want to get. */
             acs_credential_id: string;
         };
         formData: {};
@@ -9940,15 +10035,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: ({
-            /** ID of the ACS user for which you want to retrieve all credentials. */
+            /** ID of the access system user for which you want to retrieve all credentials. */
             acs_user_id: string;
         } | {
-            /** ID of the access control system for which you want to retrieve all credentials. */
+            /** ID of the access system for which you want to retrieve all credentials. */
             acs_system_id: string;
         } | {
-            /** ID of the ACS user for which you want to retrieve all credentials. */
+            /** ID of the access system user for which you want to retrieve all credentials. */
             acs_user_id: string;
-            /** ID of the access control system for which you want to retrieve all credentials. */
+            /** ID of the access system for which you want to retrieve all credentials. */
             acs_system_id: string;
         } | {
             /** ID of the user identity for which you want to retrieve all credentials. */
@@ -10084,7 +10179,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the credential for which you want to retrieve all entrances to which this credential grants access. */
+            /** ID of the credential for which you want to retrieve all entrances to which the credential grants access. */
             acs_credential_id: string;
         };
         formData: {};
@@ -10158,9 +10253,9 @@ export interface Routes {
         method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the desired user. */
+            /** ID of the access system user from which you want to unassign a credential. */
             acs_user_id: string;
-            /** ID of the desired credential. */
+            /** ID of the credential that you want to unassign from an access system user. */
             acs_credential_id: string;
         };
         commonParams: {};
@@ -10292,7 +10387,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired unmanaged credential. */
+            /** ID of the unmanaged credential that you want to get. */
             acs_credential_id: string;
         };
         formData: {};
@@ -10419,15 +10514,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the ACS user for which you want to retrieve all credentials. */
+            /** ID of the access system user for which you want to retrieve all credentials. */
             acs_user_id: string;
         } | {
-            /** ID of the access control system for which you want to retrieve all credentials. */
+            /** ID of the access system for which you want to retrieve all credentials. */
             acs_system_id: string;
         } | {
-            /** ID of the ACS user for which you want to retrieve all credentials. */
+            /** ID of the access system user for which you want to retrieve all credentials. */
             acs_user_id: string;
-            /** ID of the access control system for which you want to retrieve all credentials. */
+            /** ID of the access system for which you want to retrieve all credentials. */
             acs_system_id: string;
         } | {
             /** ID of the user identity for which you want to retrieve all credentials. */
@@ -10555,9 +10650,9 @@ export interface Routes {
         method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the desired credential. */
+            /** ID of the credential that you want to update. */
             acs_credential_id: string;
-            /** Replacement access (PIN) code for the credential. */
+            /** Replacement access (PIN) code for the credential that you want to update. */
             code?: string | undefined;
             /** Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. */
             ends_at?: string | undefined;
@@ -12927,7 +13022,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired encoder. */
+            /** ID of the encoder that you want to get. */
             acs_encoder_id: string;
         };
         formData: {};
@@ -12975,19 +13070,19 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. */
+            /** ID of the access system for which you want to retrieve all encoders. */
             acs_system_id: string;
-            /** Number of `acs_encoders` to return. */
+            /** Number of encoders to return. */
             limit?: number;
         } | {
-            /** IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. */
+            /** IDs of the access systems for which you want to retrieve all encoders. */
             acs_system_ids: string[];
-            /** Number of `acs_encoders` to return. */
+            /** Number of encoders to return. */
             limit?: number;
         } | {
-            /** IDs of the `acs_encoder`s that you want to retrieve. */
+            /** IDs of the encoders that you want to retrieve. */
             acs_encoder_ids: string[];
-            /** Number of `acs_encoders` to return. */
+            /** Number of encoders to return. */
             limit?: number;
         };
         formData: {};
@@ -13021,7 +13116,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the `acs_encoder` to use for the scan. */
+            /** ID of the encoder to use for the scan. */
             acs_encoder_id: string;
         };
         formData: {};
@@ -14216,6 +14311,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the entrance that you want to get. */
             acs_entrance_id: string;
         };
         formData: {};
@@ -14292,7 +14388,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the entrance to which you want to grant an access system user access. */
             acs_entrance_id: string;
+            /** ID of the access system user to whom you want to grant access to an entrance. */
             acs_user_id: string;
         };
         commonParams: {};
@@ -14305,9 +14403,11 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the access system for which you want to retrieve all entrances. */
             acs_system_id?: string | undefined;
+            /** ID of the credential for which you want to retrieve all entrances. */
             acs_credential_id?: string | undefined;
-            /**  */
+            /** ID of the location for which you want to retrieve all entrances. */
             location_id?: (string | null) | undefined;
         };
         formData: {};
@@ -14382,7 +14482,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the entrance for which you want to list all credentials that grant access. */
             acs_entrance_id: string;
+            /** Conditions that credentials must meet to be included in the returned list. */
             include_if?: Array<'visionline_metadata.is_valid'> | undefined;
         };
         formData: {};
@@ -14508,7 +14610,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired access control system. */
+            /** ID of the access system that you want to get. */
             acs_system_id: string;
         };
         formData: {};
@@ -14658,7 +14760,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the connected account by which to filter the list of returned access control systems. */
+            /** ID of the connected account by which you want to filter the list of access systems. */
             connected_account_id?: string | undefined;
         };
         formData: {};
@@ -14803,7 +14905,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. */
+            /** ID of the access system for which you want to retrieve all compatible credential manager systems. */
             acs_system_id: string;
         };
         formData: {};
@@ -14948,9 +15050,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user that you want to add to an access group. */
             acs_user_id: string;
-            /** ID of the desired access group. */
+            /** ID of the access group to which you want to add an access system user. */
             acs_access_group_id: string;
         };
         formData: {};
@@ -14961,17 +15063,19 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** Full name of the new `acs_user`. */
+            /** Full name of the new access system user. */
             full_name: string;
-            /** ID of the `acs_system` to which to add the new `acs_user`. */
+            /** ID of the access system to which you want to add the new access system user. */
             acs_system_id: string;
-            /** Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. */
+            /** Array of access group IDs to indicate the access groups to which you want to add the new access system user. */
             acs_access_group_ids?: string[];
-            /** ID of the user identity with which to associate the new `acs_user`. */
+            /** ID of the user identity with which you want to associate the new access system user. */
             user_identity_id?: string | undefined;
-            /** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. */
+            /** `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. */
             access_schedule?: {
+                /** Starting timestamp for the new access system user's access. */
                 starts_at?: string | undefined;
+                /** Ending timestamp for the new access system user's access. */
                 ends_at?: (string | undefined) | null;
             } | undefined;
             /**
@@ -15180,7 +15284,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user that you want to delete. */
             acs_user_id: string;
         };
         formData: {};
@@ -15192,7 +15296,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user that you want to get. */
             acs_user_id: string;
         };
         formData: {};
@@ -15392,18 +15496,19 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the user identity for which you want to retrieve all `acs_user`s. */
+            /** ID of the user identity for which you want to retrieve all access system users. */
             user_identity_id?: string | undefined;
-            /** Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
+            /** Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
             user_identity_phone_number?: string | undefined;
-            /** Email address of the user identity for which you want to retrieve all `acs_user`s. */
+            /** Email address of the user identity for which you want to retrieve all access system users. */
             user_identity_email_address?: string | undefined;
-            /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
+            /** ID of the `acs_system` for which you want to retrieve all access system users. */
             acs_system_id?: string | undefined;
-            /** String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. */
+            /** String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. */
             search?: string | undefined;
             /** Maximum number of records to return per page. */
             limit?: number;
+            /** Timestamp by which to limit returned access system users. Returns users created before this timestamp. */
             created_before?: Date | undefined;
             /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
             page_cursor?: (string | undefined) | null;
@@ -15609,7 +15714,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user for whom you want to list accessible entrances. */
             acs_user_id: string;
         };
         formData: {};
@@ -15684,9 +15789,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user that you want to remove from an access group. */
             acs_user_id: string;
-            /** ID of the desired access group. */
+            /** ID of the access group from which you want to remove an access system user. */
             acs_access_group_id: string;
         };
         formData: {};
@@ -15697,7 +15802,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user for whom you want to revoke access. */
             acs_user_id: string;
         };
         commonParams: {};
@@ -15710,7 +15815,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user that you want to suspend. */
             acs_user_id: string;
         };
         formData: {};
@@ -15722,6 +15827,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the unmanaged access system user that you want to get. */
             acs_user_id: string;
         };
         formData: {};
@@ -15917,10 +16023,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the user identity for which you want to retrieve all unmanaged access system users. */
             user_identity_id?: string | undefined;
+            /** Phone number of the user identity for which you want to retrieve all unmanaged access system users. */
             user_identity_phone_number?: string | undefined;
+            /** Email address of the user identity for which you want to retrieve all unmanaged access system users. */
             user_identity_email_address?: string | undefined;
+            /** ID of the access system for which you want to retrieve all unmanaged access system users. */
             acs_system_id?: string | undefined;
+            /** Number of unmanaged access system users to return. */
             limit?: number;
         };
         formData: {};
@@ -16115,7 +16226,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired `acs_user`. */
+            /** ID of the access system user that you want to unsuspend. */
             acs_user_id: string;
         };
         formData: {};
@@ -16126,9 +16237,11 @@ export interface Routes {
         method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. */
+            /** `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. */
             access_schedule?: ({
+                /** Starting timestamp for the access system user's access. */
                 starts_at: string;
+                /** Ending timestamp for the access system user's access. */
                 ends_at: string;
             } | null) | undefined;
             /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
@@ -16154,6 +16267,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the action attempt that you want to get. */
             action_attempt_id: string;
         };
         formData: {};
@@ -17269,6 +17383,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** IDs of the action attempts that you want to retrieve. */
             action_attempt_ids: string[];
         };
         formData: {};
@@ -18383,6 +18498,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the Seam Bridge that you want to get. */
             bridge_id: string;
         };
         formData: {};
@@ -18415,16 +18531,29 @@ export interface Routes {
         method: 'POST' | 'PUT';
         queryParams: {};
         jsonBody: {
+            /** Your user ID for the user for whom you want to create a client session. */
             user_identifier_key?: string | undefined;
+            /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session. */
             connect_webview_ids?: string[] | undefined;
+            /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
             connected_account_ids?: string[] | undefined;
+            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
             user_identity_ids?: string[] | undefined;
+            /** Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             expires_at?: Date | undefined;
         };
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
+          
+          You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
+          
+          When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
+          
+          A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
+          
+          See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -18445,6 +18574,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the client session that you want to delete. */
             client_session_id: string;
         };
         formData: {};
@@ -18456,12 +18586,22 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the client session that you want to get. */
             client_session_id?: string | undefined;
+            /** User identifier key associated with the client session that you want to get. */
             user_identifier_key?: string | undefined;
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
+          
+          You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
+          
+          When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
+          
+          A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
+          
+          See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -18481,16 +18621,29 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). */
             user_identifier_key?: string | undefined;
+            /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). */
             connect_webview_ids?: string[] | undefined;
+            /** IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). */
             connected_account_ids?: string[] | undefined;
+            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
             user_identity_ids?: string[] | undefined;
+            /** Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             expires_at?: Date | undefined;
         };
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
+          
+          You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
+          
+          When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
+          
+          A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
+          
+          See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -18511,15 +18664,28 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the client session to which you want to grant access to resources. */
             client_session_id?: string | undefined;
+            /** Your user ID for the user that you want to associate with the client session. */
             user_identifier_key?: string | undefined;
+            /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session. */
             connected_account_ids?: string[] | undefined;
+            /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
             connect_webview_ids?: string[] | undefined;
+            /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
             user_identity_ids?: string[] | undefined;
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
+          
+          You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
+          
+          When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
+          
+          A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
+          
+          See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -18540,10 +18706,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the client session that you want to retrieve. */
             client_session_id?: string | undefined;
+            /** Your user ID for the user by which you want to filter client sessions. */
             user_identifier_key?: string | undefined;
+            /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions. */
             connect_webview_id?: string | undefined;
+            /** Indicates whether to retrieve only client sessions without associated user identifier keys. */
             without_user_identifier_key?: boolean | undefined;
+            /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. */
             user_identity_id?: string | undefined;
         };
         formData: {};
@@ -18568,6 +18739,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the client session that you want to revoke. */
             client_session_id: string;
         };
         formData: {};
@@ -18578,19 +18750,37 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /**  */
             device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
+            /** URL that you want to redirect the user to after the provider login is complete. */
             custom_redirect_url?: string | undefined;
+            /** Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`. */
             custom_redirect_failure_url?: string | undefined;
+            /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
             accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
+            /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
             provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
+            /** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
             custom_metadata?: Record<string, string | boolean | null> | undefined;
+            /** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
             automatically_manage_new_devices?: boolean;
+            /** Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
             wait_for_device_creation?: boolean;
         };
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
+          
+          Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
+          
+          Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
+          
+          To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
+          
+          When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
+          
+          To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
             connect_webview: {
                 connect_webview_id: string;
                 workspace_id: string;
@@ -18623,6 +18813,7 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the Connect Webview that you want to delete. */
             connect_webview_id: string;
         };
         commonParams: {};
@@ -18635,11 +18826,22 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the Connect Webview that you want to get. */
             connect_webview_id: string;
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
+          
+          Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
+          
+          Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
+          
+          To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
+          
+          When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
+          
+          To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
             connect_webview: {
                 connect_webview_id: string;
                 workspace_id: string;
@@ -18673,10 +18875,11 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** Returns webviews that can be accessed by the provided user_identifier_key. */
+            /** Your user ID for the user by which you want to filter Connect Webviews. */
             user_identifier_key?: string | undefined;
-            /** Returns webviews whose custom_metadata contains all of the provided key/value pairs. */
+            /** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. */
             custom_metadata_has?: Record<string, string | boolean> | undefined;
+            /** Maximum number of records to return per page. */
             limit?: number;
         };
         formData: {};
@@ -18713,7 +18916,9 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the connected account that you want to delete. */
             connected_account_id: string;
+            /**  */
             sync?: boolean;
         };
         commonParams: {};
@@ -18726,13 +18931,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the connected account that you want to get. */
             connected_account_id: string;
         } | {
+            /** Email address associated with the connected account that you want to get. */
             email: string;
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
             connected_account: {
                 connected_account_id?: string | undefined;
                 created_at?: string | undefined;
@@ -18824,9 +19031,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** Returns accounts that can be accessed by the provided user_identifier_key. */
+            /** Your user ID for the user by which you want to filter connected accounts. */
             user_identifier_key?: string | undefined;
-            /** Returns accounts whose custom_metadata contains all of the provided key/value pairs. */
+            /** Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. */
             custom_metadata_has?: Record<string, string | boolean> | undefined;
             customer_ids?: string[] | undefined;
             /** Maximum number of records to return per page. */
@@ -18935,14 +19142,17 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the connected account that you want to update. */
             connected_account_id: string;
+            /** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
             automatically_manage_new_devices?: boolean | undefined;
+            /** Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
             custom_metadata?: Record<string, string | boolean | null> | undefined;
         };
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
             connected_account: {
                 connected_account_id?: string | undefined;
                 created_at?: string | undefined;
@@ -19034,6 +19244,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the device that you want to delete. */
             device_id: string;
         };
         formData: {};
@@ -19045,12 +19256,14 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the device that you want to get. */
             device_id?: string | undefined;
+            /** Name of the device that you want to get. */
             name?: string | undefined;
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -19108,7 +19321,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -19387,6 +19600,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -19812,27 +20026,27 @@ export interface Routes {
         jsonBody: {};
         commonParams: {
             customer_ids?: string[] | undefined;
-            /** ID of the connected account by which to filter. */
+            /** ID of the connected account for which you want to list devices. */
             connected_account_id?: string | undefined;
-            /** Array of IDs of the connected accounts by which to filter devices. */
+            /** Array of IDs of the connected accounts for which you want to list devices. */
             connected_account_ids?: string[] | undefined;
-            /** ID of the Connect Webview by which to filter devices. */
+            /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
-            /** Device type by which to filter devices. */
+            /** Device type for which you want to list devices. */
             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')) | undefined;
-            /** Array of device types by which to filter devices. */
+            /** Array of device types for which you want to list devices. */
             device_types?: Array<('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')> | undefined;
-            /** Manufacturer by which to filter devices. */
+            /** Manufacturer for which you want to list devices. */
             manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi') | undefined;
-            /** Array of device IDs by which to filter devices. */
+            /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
             /** Numerical limit on the number of devices to return. */
             limit?: number;
-            /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
+            /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
             created_before?: Date | undefined;
-            /** Your own internal user ID for the user by which to filter devices. */
+            /** Your own internal user ID for the user for which you want to list devices. */
             user_identifier_key?: string | undefined;
-            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
+            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
             custom_metadata_has?: Record<string, string | boolean> | undefined;
             /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
             page_cursor?: (string | undefined) | null;
@@ -19840,7 +20054,7 @@ export interface Routes {
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
             /**  */
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
-            /**  */
+            /** ID of the location for which you want to list devices. */
             unstable_location_id?: (string | null) | undefined;
         };
         formData: {};
@@ -19902,7 +20116,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -20181,6 +20395,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -20614,6 +20829,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Category for which you want to list providers. */
             provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems') | undefined;
         };
         formData: {};
@@ -20642,6 +20858,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device that you want to simulate connecting to Seam. */
             device_id: string;
         };
         commonParams: {};
@@ -20653,6 +20870,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device that you want to simulate disconnecting from Seam. */
             device_id: string;
         };
         commonParams: {};
@@ -20664,6 +20882,7 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device that you want to simulate removing from Seam. */
             device_id: string;
         };
         commonParams: {};
@@ -20676,12 +20895,14 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the unmanaged device that you want to get. */
             device_id?: string | undefined;
+            /** Name of the unmanaged device that you want to get. */
             name?: string | undefined;
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -20903,7 +21124,7 @@ export interface Routes {
                     name: string;
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -20959,27 +21180,27 @@ export interface Routes {
         jsonBody: {};
         commonParams: {
             customer_ids?: string[] | undefined;
-            /** ID of the connected account by which to filter. */
+            /** ID of the connected account for which you want to list devices. */
             connected_account_id?: string | undefined;
-            /** Array of IDs of the connected accounts by which to filter devices. */
+            /** Array of IDs of the connected accounts for which you want to list devices. */
             connected_account_ids?: string[] | undefined;
-            /** ID of the Connect Webview by which to filter devices. */
+            /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
-            /** Device type by which to filter devices. */
+            /** Device type for which you want to list devices. */
             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')) | undefined;
-            /** Array of device types by which to filter devices. */
+            /** Array of device types for which you want to list devices. */
             device_types?: Array<('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')> | undefined;
-            /** Manufacturer by which to filter devices. */
+            /** Manufacturer for which you want to list devices. */
             manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi') | undefined;
-            /** Array of device IDs by which to filter devices. */
+            /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
             /** Numerical limit on the number of devices to return. */
             limit?: number;
-            /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
+            /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
             created_before?: Date | undefined;
-            /** Your own internal user ID for the user by which to filter devices. */
+            /** Your own internal user ID for the user for which you want to list devices. */
             user_identifier_key?: string | undefined;
-            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
+            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
             custom_metadata_has?: Record<string, string | boolean> | undefined;
             /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
             page_cursor?: (string | undefined) | null;
@@ -20987,7 +21208,7 @@ export interface Routes {
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
             /**  */
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
-            /**  */
+            /** ID of the location for which you want to list devices. */
             unstable_location_id?: (string | null) | undefined;
         };
         formData: {};
@@ -21213,7 +21434,7 @@ export interface Routes {
                     name: string;
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -21268,7 +21489,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the unmanaged device that you want to update. */
             device_id: string;
+            /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
             is_managed: true;
         };
         formData: {};
@@ -21280,12 +21503,17 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the device that you want to update. */
             device_id: string;
             properties?: {
+                /** Name for the device. */
                 name?: (string | null) | undefined;
             } | undefined;
+            /** Name for the device. */
             name?: (string | null) | undefined;
+            /** Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`. */
             is_managed?: boolean;
+            /** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a 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. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata). */
             custom_metadata?: Record<string, string | boolean | null> | undefined;
         };
         formData: {};
@@ -21303,7 +21531,9 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.
+          
+          As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. */
             event?: ({
                 /** ID of the event. */
                 event_id: string;
@@ -24067,7 +24297,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
             lock: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -24125,7 +24355,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -24404,6 +24634,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -24820,7 +25051,7 @@ export interface Routes {
                 can_simulate_connection?: boolean | undefined;
                 can_simulate_disconnection?: boolean | undefined;
             };
-            /**  */
+            /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -24878,7 +25109,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -25157,6 +25388,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -25582,11 +25814,11 @@ export interface Routes {
         jsonBody: {};
         commonParams: {
             customer_ids?: string[] | undefined;
-            /** ID of the connected account by which to filter. */
+            /** ID of the connected account for which you want to list devices. */
             connected_account_id?: string | undefined;
-            /** Array of IDs of the connected accounts by which to filter devices. */
+            /** Array of IDs of the connected accounts for which you want to list devices. */
             connected_account_ids?: string[] | undefined;
-            /** ID of the Connect Webview by which to filter devices. */
+            /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
             /** Device type by which to filter devices. */
             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') | undefined;
@@ -25594,15 +25826,15 @@ export interface Routes {
             device_types?: Array<'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'> | undefined;
             /** Manufacturer by which to filter devices. */
             manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'smartthings' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles') | undefined;
-            /** Array of device IDs by which to filter devices. */
+            /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
             /** Numerical limit on the number of devices to return. */
             limit?: number;
-            /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
+            /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
             created_before?: Date | undefined;
-            /** Your own internal user ID for the user by which to filter devices. */
+            /** Your own internal user ID for the user for which you want to list devices. */
             user_identifier_key?: string | undefined;
-            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
+            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
             custom_metadata_has?: Record<string, string | boolean> | undefined;
             /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
             page_cursor?: (string | undefined) | null;
@@ -25610,7 +25842,7 @@ export interface Routes {
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
             /**  */
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
-            /**  */
+            /** ID of the location for which you want to list devices. */
             unstable_location_id?: (string | null) | undefined;
         };
         formData: {};
@@ -25672,7 +25904,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -25951,6 +26183,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -26424,7 +26657,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -26703,6 +26936,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -31626,11 +31860,11 @@ export interface Routes {
         jsonBody: {};
         commonParams: {
             customer_ids?: string[] | undefined;
-            /** ID of the connected account by which to filter. */
+            /** ID of the connected account for which you want to list devices. */
             connected_account_id?: string | undefined;
-            /** Array of IDs of the connected accounts by which to filter devices. */
+            /** Array of IDs of the connected accounts for which you want to list devices. */
             connected_account_ids?: string[] | undefined;
-            /** ID of the Connect Webview by which to filter devices. */
+            /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
             /** Device type by which to filter devices. */
             device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
@@ -31638,15 +31872,15 @@ export interface Routes {
             device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
             /** Manufacturer by which to filter devices. */
             manufacturer?: ('minut' | 'noiseaware') | undefined;
-            /** Array of device IDs by which to filter devices. */
+            /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
             /** Numerical limit on the number of devices to return. */
             limit?: number;
-            /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
+            /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
             created_before?: Date | undefined;
-            /** Your own internal user ID for the user by which to filter devices. */
+            /** Your own internal user ID for the user for which you want to list devices. */
             user_identifier_key?: string | undefined;
-            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
+            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
             custom_metadata_has?: Record<string, string | boolean> | undefined;
             /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
             page_cursor?: (string | undefined) | null;
@@ -31654,7 +31888,7 @@ export interface Routes {
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
             /**  */
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
-            /**  */
+            /** ID of the location for which you want to list devices. */
             unstable_location_id?: (string | null) | undefined;
         };
         formData: {};
@@ -31716,7 +31950,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -31995,6 +32229,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -32468,7 +32703,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -32747,6 +32982,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -37046,7 +37282,15 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
+          
+          You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
+          
+          When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
+          
+          A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
+          
+          See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -40661,7 +40905,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
             thermostat: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -40719,7 +40963,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -40998,6 +41242,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -43671,11 +43916,11 @@ export interface Routes {
         jsonBody: {};
         commonParams: {
             customer_ids?: string[] | undefined;
-            /** ID of the connected account by which to filter. */
+            /** ID of the connected account for which you want to list devices. */
             connected_account_id?: string | undefined;
-            /** Array of IDs of the connected accounts by which to filter devices. */
+            /** Array of IDs of the connected accounts for which you want to list devices. */
             connected_account_ids?: string[] | undefined;
-            /** ID of the Connect Webview by which to filter devices. */
+            /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
             /** Device type by which to filter thermostat devices. */
             device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | undefined;
@@ -43683,15 +43928,15 @@ export interface Routes {
             device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
             /** Manufacturer by which to filter thermostat devices. */
             manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
-            /** Array of device IDs by which to filter devices. */
+            /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
             /** Numerical limit on the number of devices to return. */
             limit?: number;
-            /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
+            /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
             created_before?: Date | undefined;
-            /** Your own internal user ID for the user by which to filter devices. */
+            /** Your own internal user ID for the user for which you want to list devices. */
             user_identifier_key?: string | undefined;
-            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
+            /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
             custom_metadata_has?: Record<string, string | boolean> | undefined;
             /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
             page_cursor?: (string | undefined) | null;
@@ -43699,7 +43944,7 @@ export interface Routes {
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
             /**  */
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
-            /**  */
+            /** ID of the location for which you want to list devices. */
             unstable_location_id?: (string | null) | undefined;
         };
         formData: {};
@@ -43761,7 +44006,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -44040,6 +44285,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -44513,7 +44759,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -44792,6 +45038,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -50444,6 +50691,43 @@ export interface Routes {
             };
         };
     };
+    '/unstable_partner/resources/push': {
+        route: '/unstable_partner/resources/push';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: Array<{
+            partner_resource_type?: string | undefined;
+            partner_resource_key?: string | undefined;
+            customer_key?: string | undefined;
+            email_address?: string | undefined;
+            phone_number?: string | undefined;
+            starts_at?: string | undefined;
+            ends_at?: string | undefined;
+            user_identity_key?: string | undefined;
+            location_keys?: string[] | undefined;
+            name?: string | undefined;
+            description?: string | undefined;
+            icon_url?: string | undefined;
+            custom_metadata?: Record<string, string> | undefined;
+        }> | {
+            partner_resource_type?: string | undefined;
+            partner_resource_key?: string | undefined;
+            customer_key?: string | undefined;
+            email_address?: string | undefined;
+            phone_number?: string | undefined;
+            starts_at?: string | undefined;
+            ends_at?: string | undefined;
+            user_identity_key?: string | undefined;
+            location_keys?: string[] | undefined;
+            name?: string | undefined;
+            description?: string | undefined;
+            icon_url?: string | undefined;
+            custom_metadata?: Record<string, string> | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+    };
     '/user_identities/add_acs_user': {
         route: '/user_identities/add_acs_user';
         method: 'POST' | 'PUT';
@@ -50477,7 +50761,7 @@ 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. */
+            /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/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;
@@ -50638,7 +50922,7 @@ 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. */
+            /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/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;
@@ -50767,7 +51051,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -51046,6 +51330,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -51521,7 +51806,7 @@ export interface Routes {
                         level: number;
                         status: 'critical' | 'low' | 'good' | 'full';
                     } | undefined;
-                    /** Manufacturer of the device. */
+                    /** 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;
@@ -51800,6 +52085,7 @@ export interface Routes {
                     } | 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<{
                         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';
                     } | {
@@ -52716,7 +53002,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces). */
             workspace: {
                 workspace_id: string;
                 name: string;
@@ -52745,7 +53031,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces). */
             workspace: {
                 workspace_id: string;
                 name: string;