@seamapi/types 1.410.1 → 1.411.0

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

@@ -41081,7 +41081,7 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** Device ID of the desired phone. */
+            /** Device ID of the phone that you want to deactivate. */
             device_id: string;
         };
         commonParams: {};
@@ -41094,7 +41094,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** Device ID of the desired phone. */
+            /** Device ID of the phone that you want to get. */
             device_id: string;
         };
         formData: {};
@@ -41163,9 +41163,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the user identity that represents the owner by which to filter the list of returned phones. */
+            /** ID of the user identity that represents the owner by which you want to filter the list of returned phones. */
             owner_user_identity_id?: string | undefined;
-            /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones. */
+            /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which you want to filter the list of returned phones. */
             acs_credential_id?: string | undefined;
         };
         formData: {};
@@ -41232,11 +41232,11 @@ export interface Routes {
         method: 'GET' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the custom SDK installation to use for the simulated phone. */
+            /** ID of the custom SDK installation that you want to use for the simulated phone. */
             custom_sdk_installation_id?: string | undefined;
-            /** ID of the user identity to associate with the simulated phone. */
+            /** ID of the user identity that you want to associate with the simulated phone. */
             user_identity_id: string;
-            /** Metadata to associate with the simulated phone. */
+            /** Metadata that you want to associate with the simulated phone. */
             phone_metadata?: {
                 /** Mobile operating system that you want to use for the simulated phone. */
                 operating_system?: 'android' | 'ios';
@@ -41247,7 +41247,7 @@ export interface Routes {
                 /** Device model that you want to use for the simulated phone. */
                 device_model?: string;
             };
-            /** ASSA ABLOY metadata to associate with the simulated phone. */
+            /** ASSA ABLOY metadata that you want to associate with the simulated phone. */
             assa_abloy_metadata?: {
                 /** Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability. */
                 ble_capability?: boolean;
@@ -41329,8 +41329,11 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** Name of the Seam Bridge client that you want to create. */
             bridge_client_name: string;
+            /** Time zone for the Seam Bridge that you want to create. */
             bridge_client_time_zone: string;
+            /** Identifier key of the client machine for the Seam Bridge client that you want to create. */
             bridge_client_machine_identifier_key: string;
         };
         commonParams: {};
@@ -41521,7 +41524,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** Indicates whether Tailscale is connected. */
             is_tailscale_connected: boolean | null;
+            /** Tailscale IPv4 address. */
             tailscale_ip_v4: string | null;
         };
         commonParams: {};
@@ -41553,7 +41558,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** The short code to exchange for a client session token */
+            /** Short code that you want to exchange for a client session token. */
             short_code: string;
         };
         commonParams: {};
@@ -41711,8 +41716,11 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the custom SDK installation that you want to use for the new session. */
             custom_sdk_installation_id: string;
+            /** Phone operating system that you want to use for the new session. */
             phone_os: 'ios' | 'android';
+            /** Phone device metadata that you want to use for the new session. */
             phone_device_metadata?: {
                 os_version?: string | undefined;
                 manufacturer?: string | undefined;
@@ -41917,6 +41925,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Collection key. */
             collection_key: string;
         };
         formData: {};
@@ -41943,7 +41952,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** Filter by resource type alias. */
+            /** Resource type alias by which you want to filter partner resources. */
             resource_type_alias?: string | undefined;
         };
         formData: {};
@@ -41969,7 +41978,9 @@ export interface Routes {
         method: 'POST' | 'PUT';
         queryParams: {};
         jsonBody: {
+            /** ID of the space to which you want to add entrances. */
             space_id: string;
+            /** IDs of the entrances that you want to add to the space. */
             acs_entrance_ids: string[];
         };
         commonParams: {};
@@ -41981,7 +41992,9 @@ export interface Routes {
         method: 'POST' | 'PUT';
         queryParams: {};
         jsonBody: {
+            /** ID of the space to which you want to add devices. */
             space_id: string;
+            /** IDs of the devices that you want to add to the space. */
             device_ids: string[];
         };
         commonParams: {};
@@ -41993,8 +42006,11 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** Name of the space that you want to create. */
             name: string;
+            /** IDs of the devices that you want to add to the new space. */
             device_ids?: string[] | undefined;
+            /** IDs of the entrances that you want to add to the new space. */
             acs_entrance_ids?: string[] | undefined;
         };
         commonParams: {};
@@ -42020,6 +42036,7 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the space that you want to delete. */
             space_id: string;
         };
         commonParams: {};
@@ -42032,6 +42049,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the space that you want to get. */
             space_id: string;
         };
         formData: {};
@@ -42079,7 +42097,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the space from which you want to remove entrances. */
             space_id: string;
+            /** IDs of the entrances that you want to remove from the space. */
             acs_entrance_ids: string[];
         };
         formData: {};
@@ -42091,7 +42111,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the space from which you want to remove devices. */
             space_id: string;
+            /** IDs of the devices that you want to remove from the space. */
             device_ids: string[];
         };
         formData: {};
@@ -42102,7 +42124,9 @@ export interface Routes {
         method: 'POST' | 'PATCH';
         queryParams: {};
         jsonBody: {
+            /** ID of the space that you want to update. */
             space_id: string;
+            /** Name of the space. */
             name?: string | undefined;
         };
         commonParams: {};
@@ -43248,9 +43272,9 @@ export interface Routes {
         jsonBody: {
             /** ID of the thermostat device that you want to set to cool mode. */
             device_id: string;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_celsius?: number | undefined;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_fahrenheit?: number | undefined;
             /**  */
             sync?: boolean;
@@ -44401,7 +44425,7 @@ export interface Routes {
         jsonBody: {
             /** ID of the thermostat device for which you want to create a daily program. */
             device_id: string;
-            /** User-friendly name to identify the thermostat daily program. */
+            /** Name of the thermostat daily program. */
             name: string;
             /** Array of thermostat daily program periods. */
             periods: Array<{
@@ -44455,7 +44479,7 @@ export interface Routes {
         jsonBody: {
             /** ID of the thermostat daily program that you want to update. */
             thermostat_daily_program_id: string;
-            /** User-friendly name to identify the thermostat daily program that you want to update. */
+            /** Name of the thermostat daily program that you want to update. */
             name: string;
             /** Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. */
             periods: Array<{
@@ -45593,9 +45617,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the thermostat device that you want to retrieve. */
+            /** ID of the thermostat device that you want to get. */
             device_id?: string | undefined;
-            /** User-friendly name of the thermostat device that you want to retrieve. */
+            /** Name of the thermostat device that you want to retrieve. */
             name?: string | undefined;
         };
         formData: {};
@@ -46813,9 +46837,9 @@ export interface Routes {
         jsonBody: {
             /** ID of the thermostat device that you want to set to heat mode. */
             device_id: string;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_celsius?: number | undefined;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_fahrenheit?: number | undefined;
             /**  */
             sync?: boolean;
@@ -47935,13 +47959,13 @@ export interface Routes {
         jsonBody: {
             /** ID of the thermostat device that you want to set to heat-cool mode. */
             device_id: string;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_celsius?: number | undefined;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_fahrenheit?: number | undefined;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_celsius?: number | undefined;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_fahrenheit?: number | undefined;
             /**  */
             sync?: boolean;
@@ -49067,11 +49091,11 @@ export interface Routes {
             connected_account_ids?: string[] | undefined;
             /** 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 by which you want to filter thermostat devices. */
             device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | undefined;
-            /** Array of device types by which to filter thermostat devices. */
+            /** Array of device types by which you want to filter thermostat devices. */
             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 by which you want to filter thermostat devices. */
             manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi' | 'smartthings') | undefined;
             /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
@@ -52628,19 +52652,19 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the desired thermostat device. */
+            /** ID of the thermostat device for which you want to create a schedule. */
             device_id: string;
-            /** User-friendly name to identify the thermostat schedule. */
+            /** Name of the thermostat schedule. */
             name?: string | undefined;
-            /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
+            /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. */
             climate_preset_key: string;
             /** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
             max_override_period_minutes?: (number | null) | undefined;
-            /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+            /** Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             starts_at: string;
-            /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+            /** Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
             ends_at: string;
-            /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
+            /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
             is_override_allowed?: boolean | undefined;
         };
         commonParams: {};
@@ -52684,7 +52708,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired thermostat schedule. */
+            /** ID of the thermostat schedule that you want to delete. */
             thermostat_schedule_id: string;
         };
         formData: {};
@@ -52696,7 +52720,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired thermostat schedule. */
+            /** ID of the thermostat schedule that you want to get. */
             thermostat_schedule_id: string;
         };
         formData: {};
@@ -52739,7 +52763,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired thermostat device. */
+            /** ID of the thermostat device for which you want to list schedules. */
             device_id: string;
             /** User identifier key by which to filter the list of returned thermostat schedules. */
             user_identifier_key?: string | undefined;
@@ -52782,9 +52806,9 @@ export interface Routes {
         method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the desired thermostat schedule. */
+            /** ID of the thermostat schedule that you want to update. */
             thermostat_schedule_id: string;
-            /** User-friendly name to identify the thermostat schedule. */
+            /** Name of the thermostat schedule. */
             name?: string | undefined;
             /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
             climate_preset_key?: string | undefined;
@@ -52825,7 +52849,7 @@ export interface Routes {
             /**
              * @deprecated Use `fan_mode_setting` instead. */
             fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
-            /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
+            /** [Fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat. */
             fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
             /**  */
             sync?: boolean;
@@ -53950,29 +53974,29 @@ export interface Routes {
             hvac_mode_setting: 'cool';
             /** ID of the thermostat device for which you want to set the HVAC mode. */
             device_id: string;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_celsius?: number | undefined;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_fahrenheit?: number | undefined;
         } | {
             hvac_mode_setting: 'heat';
             /** ID of the thermostat device for which you want to set the HVAC mode. */
             device_id: string;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_celsius?: number | undefined;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_fahrenheit?: number | undefined;
         } | {
             hvac_mode_setting: 'heat_cool';
             /** ID of the thermostat device for which you want to set the HVAC mode. */
             device_id: string;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_celsius?: number | undefined;
-            /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
+            /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
             cooling_set_point_fahrenheit?: number | undefined;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_celsius?: number | undefined;
-            /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
+            /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
             heating_set_point_fahrenheit?: number | undefined;
         };
         commonParams: {};
@@ -55108,40 +55132,40 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
+            /** HVAC mode that you want to simulate. */
             hvac_mode: 'off';
-            /** ID of the desired thermostat device. */
+            /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
             device_id: string;
         } | {
-            /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
+            /** HVAC mode that you want to simulate. */
             hvac_mode: 'cool';
-            /** ID of the desired thermostat device. */
+            /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
             device_id: string;
-            /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
+            /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
             cooling_set_point_celsius?: number | undefined;
-            /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
+            /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
             cooling_set_point_fahrenheit?: number | undefined;
         } | {
-            /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
+            /** HVAC mode that you want to simulate. */
             hvac_mode: 'heat';
-            /** ID of the desired thermostat device. */
+            /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
             device_id: string;
-            /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
+            /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
             heating_set_point_celsius?: number | undefined;
-            /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
+            /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
             heating_set_point_fahrenheit?: number | undefined;
         } | {
-            /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
+            /** HVAC mode that you want to simulate. */
             hvac_mode: 'heat_cool';
-            /** ID of the desired thermostat device. */
+            /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
             device_id: string;
-            /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
+            /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
             cooling_set_point_celsius?: number | undefined;
-            /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
+            /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
             cooling_set_point_fahrenheit?: number | undefined;
-            /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
+            /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
             heating_set_point_celsius?: number | undefined;
-            /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
+            /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
             heating_set_point_fahrenheit?: number | undefined;
         };
         commonParams: {};
@@ -55153,11 +55177,11 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the desired thermostat device. */
+            /** ID of the thermostat device that you want to simulate reaching a specified temperature. */
             device_id: string;
-            /** Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. */
+            /** Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`. */
             temperature_celsius?: number | undefined;
-            /** Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. */
+            /** Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`. */
             temperature_fahrenheit?: number | undefined;
         };
         commonParams: {};
@@ -56331,10 +56355,10 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: ({
-            /** ID of user identity for whom access is being granted. */
+            /** ID of user identity for whom you want to grant access. */
             user_identity_id: string;
         } | {
-            /** When used, creates a new user identity with the given details, and grants them access. */
+            /** User identity. When used, creates a new user identity with the specified details and grants them access. */
             user_identity: {
                 /** Unique email address for the user identity. */
                 email_address?: (string | null) | undefined;
@@ -56346,9 +56370,9 @@ export interface Routes {
             /**
              * @deprecated Use `space_ids`. */
             location_ids?: string[] | undefined;
-            /** Set of IDs of existing spaces to which access is being granted. */
+            /** IDs of the existing spaces to which you want to grant access. */
             space_ids?: string[] | undefined;
-            /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
+            /** Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location. */
             location?: {
                 /** Name of the location. */
                 name?: string | undefined;
@@ -56359,12 +56383,12 @@ export interface Routes {
                  * @deprecated Use `device_ids` at the top level. */
                 device_ids?: string[];
             } | undefined;
-            /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted. */
+            /** IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access. */
             acs_entrance_ids?: string[];
-            /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted. */
+            /** IDs of the devices to which you want to grant access. */
             device_ids?: string[];
             requested_access_methods: Array<{
-                /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                /** Access method mode. */
                 mode: 'code' | 'card' | 'mobile_key';
             }>;
             /** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -56413,7 +56437,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access grant to delete. */
+            /** ID of access grant that you want to delete. */
             access_grant_id: string;
         };
         formData: {};
@@ -56425,7 +56449,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access grant to get. */
+            /** ID of access grant that you want to get. */
             access_grant_id: string;
         };
         formData: {};
@@ -56469,16 +56493,16 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of user identity to filter list of access grants by. */
+            /** ID of the user identity by which you want to filter the list of access grants. */
             user_identity_id?: string | undefined;
-            /** ID of system to filter list of access grants by. */
+            /** ID of the access system by which you want to filter the list of access grants. */
             acs_system_id?: string | undefined;
-            /** ID of entrance to filter list of access grants by. */
+            /** ID of the entrance by which you want to filter the list of access grants. */
             acs_entrance_id?: string | undefined;
             /**
              * @deprecated Use `space_id`. */
             location_id?: string | undefined;
-            /** ID of space to filter list of access grants by. */
+            /** ID of the space by which you want to filter the list of access grants. */
             space_id?: string | undefined;
         };
         formData: {};
@@ -56521,7 +56545,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access method to get. */
+            /** ID of the access method that you want to delete. */
             access_method_id: string;
         };
         formData: {};
@@ -56533,7 +56557,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access method to get. */
+            /** ID of the access method that you want to get. */
             access_method_id: string;
         };
         formData: {};
@@ -56565,7 +56589,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of access grant to list access methods for. */
+            /** ID of the access grant by which to filter the list of access methods. */
             access_grant_id: string;
         };
         formData: {};
@@ -56595,7 +56619,9 @@ export interface Routes {
         method: 'POST' | 'PUT';
         queryParams: {};
         jsonBody: {
+            /** ID of the location to which you want to add entrances. */
             location_id: string;
+            /** IDs of the entrances that you want to add to the location. */
             acs_entrance_ids: string[];
         };
         commonParams: {};
@@ -56607,7 +56633,9 @@ export interface Routes {
         method: 'POST' | 'PUT';
         queryParams: {};
         jsonBody: {
+            /** ID of the location to which you want to add devices. */
             location_id: string;
+            /** IDs of the devices that you want to add to the location. */
             device_ids: string[];
         };
         commonParams: {};
@@ -56619,13 +56647,18 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** Name of the new location. */
             name: string;
+            /** Geolocation of the new location. */
             geolocation?: {
                 latitude: number;
                 longitude: number;
             } | undefined;
+            /** Time zone of the new location. */
             time_zone?: string | undefined;
+            /** IDs of the devices that you want to add to the new location. */
             device_ids?: string[] | undefined;
+            /** IDs of the entrances that you want to add to the new location. */
             acs_entrance_ids?: string[] | undefined;
         };
         commonParams: {};
@@ -56657,6 +56690,7 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the location that you want to delete. */
             location_id: string;
         };
         commonParams: {};
@@ -56669,6 +56703,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the location that you want to get. */
             location_id: string;
         };
         formData: {};
@@ -56729,7 +56764,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the location from which you want to remove entrances. */
             location_id: string;
+            /** IDs of the entrances that you want to remove from the location. */
             acs_entrance_ids: string[];
         };
         formData: {};
@@ -56741,7 +56778,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the location from which you want to remove devices. */
             location_id: string;
+            /** IDs of the devices that you want to remove from the location. */
             device_ids: string[];
         };
         formData: {};
@@ -56752,12 +56791,16 @@ export interface Routes {
         method: 'POST' | 'PATCH';
         queryParams: {};
         jsonBody: {
+            /** ID of the location that you want to update. */
             location_id: string;
+            /** Name of the location. */
             name?: string | undefined;
+            /** Geolocation of the location. */
             geolocation?: {
                 latitude: number;
                 longitude: number;
             } | undefined;
+            /** Time zone of the the location. */
             time_zone?: string | undefined;
         };
         commonParams: {};
@@ -56790,6 +56833,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Customer key for which you want to connect accounts. */
             customer_key: string;
         };
         formData: {};
@@ -56797,7 +56841,7 @@ export interface Routes {
             /**  */
             magic_link: {
                 url: string;
-                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
                 customer_key: string;
                 expires_at: string;
                 workspace_id: string;
@@ -56811,17 +56855,13 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            building_block_type: 'connect_accounts';
-            customer_key: string;
-        } | {
-            building_block_type: 'manage_devices';
-            customer_key: string;
-        } | {
-            building_block_type: 'organize_spaces';
+            /** Type of building block to create a magic link for. */
+            building_block_type: 'connect_accounts' | 'organize_spaces' | 'console' | 'manage_devices';
+            /** Customer key for which you want to create a new building block magic link. */
             customer_key: string;
-            /** Optional list of partner resources to include in the magic link. */
-            partner_resources?: Array<{
-                partner_resource_key: string;
+            /** Optional list of spaces that you want to include in the new building block magic link. */
+            spaces?: Array<{
+                space_key: string;
                 name: string;
                 description?: string | undefined;
                 custom_metadata?: Record<string, string> | undefined;
@@ -56832,7 +56872,7 @@ export interface Routes {
             /**  */
             magic_link: {
                 url: string;
-                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
                 customer_key: string;
                 expires_at: string;
                 workspace_id: string;
@@ -56846,6 +56886,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Customer key for which you want to manage devices. */
             customer_key: string;
         };
         formData: {};
@@ -56853,7 +56894,7 @@ export interface Routes {
             /**  */
             magic_link: {
                 url: string;
-                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
                 customer_key: string;
                 expires_at: string;
                 workspace_id: string;
@@ -56867,9 +56908,11 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** Customer key for which you want to organize spaces. */
             customer_key: string;
-            partner_resources?: Array<{
-                partner_resource_key: string;
+            /** Optional list of spaces that you want to include in the new building block magic link. */
+            spaces?: Array<{
+                space_key: string;
                 name: string;
                 description?: string | undefined;
                 custom_metadata?: Record<string, string> | undefined;
@@ -56880,7 +56923,7 @@ export interface Routes {
             /**  */
             magic_link: {
                 url: string;
-                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
                 customer_key: string;
                 expires_at: string;
                 workspace_id: string;
@@ -56893,8 +56936,11 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: Array<{
+            /** Type of the resource that you want to push to Seam. */
             partner_resource_type?: string | undefined;
+            /** Key of the resource that you want to push to Seam. */
             partner_resource_key?: string | undefined;
+            /** Customer key associated with the resource that you want to push to Seam. */
             customer_key?: string | undefined;
             email_address?: string | undefined;
             phone_number?: string | undefined;
@@ -56906,8 +56952,11 @@ export interface Routes {
             description?: string | undefined;
             custom_metadata?: Record<string, string> | undefined;
         }> | {
+            /** Type of the resource that you want to push to Seam. */
             partner_resource_type?: string | undefined;
+            /** Key of the resource that you want to push to Seam. */
             partner_resource_key?: string | undefined;
+            /** Customer key associated with the resource that you want to push to Seam. */
             customer_key?: string | undefined;
             email_address?: string | undefined;
             phone_number?: string | undefined;
@@ -56929,9 +56978,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired user identity. */
+            /** ID of the user identity to which you want to add an access system user. */
             user_identity_id: string;
-            /** ID of the desired ACS user. */
+            /** ID of the access system user that you want to add to the user identity. */
             acs_user_id: string;
         };
         formData: {};
@@ -56943,15 +56992,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** Unique key for the user identity. */
+            /** Unique key for the new user identity. */
             user_identity_key?: (string | null) | undefined;
-            /** Unique email address for the user identity. */
+            /** Unique email address for the new user identity. */
             email_address?: (string | null) | undefined;
-            /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
+            /** Unique phone number for the new user identity in E.164 format (for example, +15555550100). */
             phone_number?: (string | null) | undefined;
-            /** Full name of the user associated with the user identity. */
+            /** Full name of the user associated with the new user identity. */
             full_name?: (string | null) | undefined;
-            /** List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity. */
+            /** List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. */
             acs_system_ids?: string[] | undefined;
         };
         formData: {};
@@ -56981,7 +57030,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired user identity. */
+            /** ID of the user identity that you want to delete. */
             user_identity_id: string;
         };
         formData: {};
@@ -56993,7 +57042,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired enrollment automation. */
+            /** ID of the enrollment automation that you want to delete. */
             enrollment_automation_id: string;
         };
         formData: {};
@@ -57005,7 +57054,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired enrollment automation. */
+            /** ID of the enrollment automation that you want to get. */
             enrollment_automation_id: string;
         };
         formData: {};
@@ -57031,15 +57080,15 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired user identity. */
+            /** ID of the user identity for which you want to launch an enrollment automation. */
             user_identity_id: string;
-            /** ID of the desired ACS system that serves as the credential manager. */
+            /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
             credential_manager_acs_system_id: string;
-            /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
+            /** ID of the credential pool from which to obtain credentials for the user identity. */
             acs_credential_pool_id?: string | undefined;
             /** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
             create_credential_manager_user?: boolean | undefined;
-            /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
+            /** 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: {};
@@ -57060,7 +57109,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the user identity for which you want to retrieve all enrollment automations. */
+            /** ID of the user identity for which you want to retrieve enrollment automations. */
             user_identity_id: string;
         };
         formData: {};
@@ -57087,7 +57136,7 @@ export interface Routes {
         commonParams: {
             /** ID of the user identity for which you want to generate an instant key. */
             user_identity_id: string;
-            /** The maximum number of times the instant key can be used. Defaults to 1. */
+            /** Maximum number of times the instant key can be used. Default: 1. */
             max_use_count?: number;
         };
         formData: {};
@@ -57110,7 +57159,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired user identity. */
+            /** ID of the user identity that you want to get. */
             user_identity_id: string;
         } | {
             user_identity_key: string;
@@ -57142,9 +57191,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired user identity. */
+            /** ID of the user identity that you want to grant access to a device. */
             user_identity_id: string;
-            /** ID of the desired managed device. */
+            /** ID of the managed device to which you want to grant access to the user identity. */
             device_id: string;
         };
         formData: {};
@@ -57156,6 +57205,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
             credential_manager_acs_system_id?: string | undefined;
         };
         formData: {};
@@ -58393,7 +58443,7 @@ export interface Routes {
                 can_simulate_disconnection?: boolean | undefined;
             }>;
             /**
-             * @deprecated use devices. */
+             * @deprecated Use devices. */
             accessible_devices: Array<{
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -59605,7 +59655,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the user identity for which you want to retrieve all access control systems. */
+            /** ID of the user identity for which you want to retrieve all access systems. */
             user_identity_id: string;
         };
         formData: {};
@@ -59736,7 +59786,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the user identity for which you want to retrieve all ACS users. */
+            /** ID of the user identity for which you want to retrieve all access system users. */
             user_identity_id: string;
         };
         formData: {};
@@ -59935,9 +59985,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired user identity. */
+            /** ID of the user identity from which you want to remove an access system user. */
             user_identity_id: string;
-            /** ID of the ACS user. */
+            /** ID of the access system user that you want to remove from the user identity.. */
             acs_user_id: string;
         };
         formData: {};
@@ -59949,9 +59999,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the desired user identity. */
+            /** ID of the user identity from which you want to revoke access to a device. */
             user_identity_id: string;
-            /** ID of the desired managed device. */
+            /** ID of the managed device to which you want to revoke access from the user identity. */
             device_id: string;
         };
         formData: {};
@@ -59962,14 +60012,15 @@ export interface Routes {
         method: 'PATCH' | 'POST';
         queryParams: {};
         jsonBody: {
-            /** ID of the user identity. */
+            /** ID of the user identity that you want to update. */
             user_identity_id: string;
             /** Unique key for the user identity. */
             user_identity_key?: (string | null) | undefined;
             /** Unique email address for the user identity. */
             email_address?: (string | null) | undefined;
-            /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
+            /** Unique phone number for the user identity. */
             phone_number?: (string | null) | undefined;
+            /** Full name of the user associated with the user identity. */
             full_name?: (string | null) | undefined;
         };
         commonParams: {};
@@ -59981,7 +60032,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** URL for the new webhook. */
             url: string;
+            /** Types of events that you want the new webhook to receive. */
             event_types?: string[];
         };
         commonParams: {};
@@ -60002,6 +60055,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the webhook that you want to delete. */
             webhook_id: string;
         };
         formData: {};
@@ -60013,6 +60067,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the webhook that you want to get. */
             webhook_id: string;
         };
         formData: {};
@@ -60047,7 +60102,9 @@ export interface Routes {
         method: 'PUT' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the webhook that you want to update. */
             webhook_id: string;
+            /** Types of events that you want the webhook to receive. */
             event_types: string[];
         };
         commonParams: {};
@@ -60059,11 +60116,13 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** Name of the new workspace. */
             name: string;
+            /** Company name for the new workspace. */
             company_name?: string | undefined;
-            /**
-             * @deprecated use company_name */
+            /** Connect partner name for the new workspace. */
             connect_partner_name?: ((string | null) | null) | undefined;
+            /** Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
             is_sandbox?: boolean;
             /**
              * @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
@@ -60077,10 +60136,15 @@ export interface Routes {
             /**
              * @deprecated Use `connect_webview_customization.webview_success_message` instead. */
             webview_success_message?: string | undefined;
+            /** [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
             connect_webview_customization?: {
+                /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 primary_button_color?: (string | null) | undefined;
+                /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 primary_button_text_color?: (string | null) | undefined;
+                /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 success_message?: (string | null) | undefined;
+                /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 logo_shape?: (('circle' | 'square') | null) | undefined;
             } | undefined;
         };
@@ -61283,14 +61347,22 @@ export interface Routes {
         method: 'POST' | 'PATCH';
         queryParams: {};
         jsonBody: {
+            /** Name of the workspace. */
             name?: string | undefined;
+            /** Connect partner name for the workspace. */
             connect_partner_name?: string | undefined;
+            /** [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
             connect_webview_customization?: {
+                /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 primary_button_color?: (string | null) | undefined;
+                /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 primary_button_text_color?: (string | null) | undefined;
+                /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 success_message?: (string | null) | undefined;
+                /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
                 logo_shape?: (('circle' | 'square') | null) | undefined;
             } | undefined;
+            /** Indicates whether the workspace is suspended. */
             is_suspended?: boolean | undefined;
         };
         commonParams: {};