fix: missing deprecation warning for request parameters (#946)

mikewuu · seambot · web-flow · commit 121455059882 · 2025-10-30T09:58:40.000-07:00
* fix: add missing request param deprecated warnings

* ci: Generate docs

---------

Co-authored-by: Seam Bot &lt;seambot@getseam.com&gt;
diff --git a/codegen/layouts/api-endpoint.hbs b/codegen/layouts/api-endpoint.hbs
@@ -42,6 +42,10 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 {{this.description}}
 {{/if}}
+{{#if this.isDeprecated}}
+
+{{> deprecated-warning}}
+{{/if}}
 {{#if this.itemEnumValues}}
 <details>
 
diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md
@@ -375,6 +375,10 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
 
 **`use_offline_access_code`** *Boolean*
 
+{% hint style="warning" %}
+**Deprecated**. Use `is_offline_access_code` instead.
+{% endhint %}
+
 ---
 
 
diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md
@@ -434,6 +434,10 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
 
 **`use_offline_access_code`** *Boolean*
 
+{% hint style="warning" %}
+**Deprecated**. Use `is_offline_access_code` instead.
+{% endhint %}
+
 ---
 
 
diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md
@@ -270,6 +270,10 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
 
 **`use_offline_access_code`** *Boolean*
 
+{% hint style="warning" %}
+**Deprecated**. Use `is_offline_access_code` instead.
+{% endhint %}
+
 ---
 
 
diff --git a/docs/api/access_grants/create.md b/docs/api/access_grants/create.md
@@ -537,6 +537,10 @@ Name of the location.
 
 **`location_ids`** *Array* *of UUIDs*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_ids`.
+{% endhint %}
+
 ---
 
 **`name`** *String*
diff --git a/docs/api/access_grants/list.md b/docs/api/access_grants/list.md
@@ -453,6 +453,10 @@ Customer key for which you want to list access grants.
 
 **`location_id`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_id`.
+{% endhint %}
+
 ---
 
 **`reservation_key`** *String*
diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md
@@ -292,6 +292,10 @@ Maximum number of records to return per page.
 
 **`location_id`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_id`.
+{% endhint %}
+
 ---
 
 **`page_cursor`** *String*
diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md
@@ -397,6 +397,10 @@ Array of access group IDs to indicate the access groups to which you want to add
 
 **`email`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. use email_address.
+{% endhint %}
+
 ---
 
 **`email_address`** *String*
diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md
@@ -231,6 +231,10 @@ ID of the access system user that you want to update. You can only provide acs_u
 
 **`email`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. use email_address.
+{% endhint %}
+
 ---
 
 **`email_address`** *String*
diff --git a/docs/api/client_sessions/create.md b/docs/api/client_sessions/create.md
@@ -294,6 +294,10 @@ ID of the [user identity](../../capability-guides/mobile-access/managing-mobile-
 
 IDs of the [user identities](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) that you want to associate with the client session.
 
+{% hint style="warning" %}
+**Deprecated**. Use `user_identity_id` instead.
+{% endhint %}
+
 ---
 
 
diff --git a/docs/api/client_sessions/get_or_create.md b/docs/api/client_sessions/get_or_create.md
@@ -272,6 +272,10 @@ ID of the [user identity](../../capability-guides/mobile-access/managing-mobile-
 
 IDs of the [user identities](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) that you want to associate with the client session.
 
+{% hint style="warning" %}
+**Deprecated**. Use `user_identity_id`.
+{% endhint %}
+
 ---
 
 
diff --git a/docs/api/client_sessions/grant_access.md b/docs/api/client_sessions/grant_access.md
@@ -197,6 +197,10 @@ ID of the [user identity](../../capability-guides/mobile-access/managing-mobile-
 
 IDs of the [user identities](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) that you want to associate with the client session.
 
+{% hint style="warning" %}
+**Deprecated**. Use `user_identity_id`.
+{% endhint %}
+
 ---
 
 
diff --git a/docs/api/devices/list.md b/docs/api/devices/list.md
@@ -1282,6 +1282,10 @@ ID of the space for which you want to list devices.
 
 **`unstable_location_id`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_id`.
+{% endhint %}
+
 ---
 
 **`user_identifier_key`** *String*
diff --git a/docs/api/devices/unmanaged/list.md b/docs/api/devices/unmanaged/list.md
@@ -548,6 +548,10 @@ ID of the space for which you want to list devices.
 
 **`unstable_location_id`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_id`.
+{% endhint %}
+
 ---
 
 **`user_identifier_key`** *String*
diff --git a/docs/api/locks/list.md b/docs/api/locks/list.md
@@ -1263,6 +1263,10 @@ ID of the space for which you want to list devices.
 
 **`unstable_location_id`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_id`.
+{% endhint %}
+
 ---
 
 **`user_identifier_key`** *String*
diff --git a/docs/api/noise_sensors/list.md b/docs/api/noise_sensors/list.md
@@ -687,6 +687,10 @@ ID of the space for which you want to list devices.
 
 **`unstable_location_id`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_id`.
+{% endhint %}
+
 ---
 
 **`user_identifier_key`** *String*
diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md
@@ -277,6 +277,10 @@ Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat
 
 Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
 
+{% hint style="warning" %}
+**Deprecated**. Use 'thermostat_schedule.is_override_allowed'
+{% endhint %}
+
 ---
 
 **`name`** *String*
diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md
@@ -1241,6 +1241,10 @@ ID of the space for which you want to list devices.
 
 **`unstable_location_id`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `space_id`.
+{% endhint %}
+
 ---
 
 **`user_identifier_key`** *String*
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
@@ -191,6 +191,10 @@ ID of the thermostat device for which you want to set the fan mode.
 
 **`fan_mode`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `fan_mode_setting` instead.
+{% endhint %}
+
 ---
 
 **`fan_mode_setting`** *String*
diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md
@@ -277,6 +277,10 @@ Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat
 
 Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
 
+{% hint style="warning" %}
+**Deprecated**. Use 'thermostat_schedule.is_override_allowed'
+{% endhint %}
+
 ---
 
 **`name`** *String*
diff --git a/docs/api/workspaces/create.md b/docs/api/workspaces/create.md
@@ -341,6 +341,10 @@ Company name for the new workspace.
 
 Connect partner name for the new workspace.
 
+{% hint style="warning" %}
+**Deprecated**. Use `company_name` instead.
+{% endhint %}
+
 ---
 
 **`connect_webview_customization`** *Object*
@@ -407,18 +411,34 @@ Indicates whether the new workspace is a [sandbox workspace](../../core-concepts
 
 **`webview_logo_shape`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `connect_webview_customization.webview_logo_shape` instead.
+{% endhint %}
+
 ---
 
 **`webview_primary_button_color`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `connect_webview_customization.webview_primary_button_color` instead.
+{% endhint %}
+
 ---
 
 **`webview_primary_button_text_color`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `connect_webview_customization.webview_primary_button_text_color` instead.
+{% endhint %}
+
 ---
 
 **`webview_success_message`** *String*
 
+{% hint style="warning" %}
+**Deprecated**. Use `connect_webview_customization.webview_success_message` instead.
+{% endhint %}
+
 ---
 
 
