ci: Generate docs

seambot · seambot · commit f1a0da927441 · 2025-05-28T00:04:58.000Z
diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json
diff --git a/docs/api/_report.md b/docs/api/_report.md
@@ -245,33 +245,8 @@ Items that are intentionally undocumented are not included in this section.
 - `client_session.user_identity_ids`
 - `client_session.workspace_id`
 - `connect_webview.accepted_devices`
-- `connect_webview.accepted_providers`
 - `connect_webview.any_device_allowed`
-- `connect_webview.any_provider_allowed`
-- `connect_webview.authorized_at`
-- `connect_webview.automatically_manage_new_devices`
-- `connect_webview.connect_webview_id`
-- `connect_webview.connected_account_id`
-- `connect_webview.created_at`
-- `connect_webview.custom_metadata`
-- `connect_webview.custom_redirect_failure_url`
-- `connect_webview.custom_redirect_url`
 - `connect_webview.device_selection_mode`
-- `connect_webview.login_successful`
-- `connect_webview.selected_provider`
-- `connect_webview.status`
-- `connect_webview.url`
-- `connect_webview.wait_for_device_creation`
-- `connect_webview.workspace_id`
-- `connected_account.account_type`
-- `connected_account.account_type_display_name`
-- `connected_account.automatically_manage_new_devices`
-- `connected_account.connected_account_id`
-- `connected_account.created_at`
-- `connected_account.custom_metadata`
-- `connected_account.errors`
-- `connected_account.user_identifier`
-- `connected_account.warnings`
 - `device.can_hvac_cool`
 - `device.can_hvac_heat`
 - `device.can_hvac_heat_cool`
@@ -283,7 +258,6 @@ Items that are intentionally undocumented are not included in this section.
 - `device.can_simulate_disconnection`
 - `device.can_simulate_removal`
 - `device.can_turn_off_hvac`
-- `device.custom_metadata`
 - `device_provider.can_hvac_cool`
 - `device_provider.can_hvac_heat`
 - `device_provider.can_hvac_heat_cool`
diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md
@@ -1635,25 +1635,30 @@ Credentials provided were invalid.
   **`is_bridge_error`** *Boolean*
   
   
+  Indicates whether the error is related to Seam Bridge.
+  
   
   ---
 
   **`is_connected_account_error`** *Boolean*
   
   
+  Indicates whether the error is related specifically to the connected account.
+  
   
   ---
 
   **`message`** *String*
   
   
+  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+  
   
 </details>
 <details>
 <summary><code>bridge_disconnected</code></summary>
 
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-  See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
 
   **`created_at`** *Datetime*
   
@@ -1679,18 +1684,24 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili
   **`is_bridge_error`** *Boolean*
   
   
+  Indicates whether the error is related to Seam Bridge.
+  
   
   ---
 
   **`is_connected_account_error`** *Boolean*
   
   
+  Indicates whether the error is related specifically to the connected account.
+  
   
   ---
 
   **`message`** *String*
   
   
+  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+  
   
 </details>
 
@@ -2482,8 +2493,7 @@ Credentials provided were invalid.
 
 **`bridge_disconnected`**
 
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-  See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
 
 ---
 
diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md
@@ -1621,25 +1621,30 @@ Credentials provided were invalid.
   **`is_bridge_error`** *Boolean*
   
   
+  Indicates whether the error is related to Seam Bridge.
+  
   
   ---
 
   **`is_connected_account_error`** *Boolean*
   
   
+  Indicates whether the error is related specifically to the connected account.
+  
   
   ---
 
   **`message`** *String*
   
   
+  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+  
   
 </details>
 <details>
 <summary><code>bridge_disconnected</code></summary>
 
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-  See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
 
   **`created_at`** *Datetime*
   
@@ -1665,18 +1670,24 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab
   **`is_bridge_error`** *Boolean*
   
   
+  Indicates whether the error is related to Seam Bridge.
+  
   
   ---
 
   **`is_connected_account_error`** *Boolean*
   
   
+  Indicates whether the error is related specifically to the connected account.
+  
   
   ---
 
   **`message`** *String*
   
   
+  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+  
   
 </details>
 
@@ -2392,8 +2403,7 @@ Credentials provided were invalid.
 
 **`bridge_disconnected`**
 
-Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-  See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
+Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
 
 ---
 
diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md
@@ -33,9 +33,15 @@ ID of the entrance to which you want to grant an access system user access.
 
 ---
 
-**`acs_user_id`** *String* (Required)
+**`acs_user_id`** *String*
 
-ID of the access system user to whom you want to grant access to an entrance.
+ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_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 access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
 
 ---
 
diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 ## Request Parameters
 
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
 
-ID of the access system user that you want to delete.
+ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
 
 ---
 
diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 ## Request Parameters
 
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
 
-ID of the access system user that you want to get.
+ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
 
 ---
 
diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md
@@ -28,9 +28,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 ## Request Parameters
 
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
 
-ID of the access system user for whom you want to list accessible entrances.
+ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
 
 ---
 
diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md
@@ -33,9 +33,15 @@ ID of the access group from which you want to remove an access system user.
 
 ---
 
-**`acs_user_id`** *String* (Required)
+**`acs_user_id`** *String*
 
-ID of the access system user that you want to remove from an access group.
+ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
 
 ---
 
diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 ## Request Parameters
 
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
 
-ID of the access system user for whom you want to revoke access.
+ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
 
 ---
 
diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 ## Request Parameters
 
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
 
-ID of the access system user that you want to suspend.
+ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
 
 ---
 
diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md
@@ -27,9 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 ## Request Parameters
 
-**`acs_user_id`** *String* (Required)
+**`acs_system_id`** *String*
 
-ID of the access system user that you want to unsuspend.
+ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+
+---
+
+**`user_identity_id`** *String*
+
+ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
 
 ---
 
diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md
@@ -27,15 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 ## Request Parameters
 
-**`acs_user_id`** *String* (Required)
+**`access_schedule`** *Object*
 
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+`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`** *Object*
+**`acs_system_id`** *String*
 
-`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`.
+ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
+
+---
+
+**`acs_user_id`** *String*
+
+ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
 
 ---
 
@@ -65,6 +71,12 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc
 
 ---
 
+**`user_identity_id`** *String*
+
+ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
+
+---
+
 
 ## Response
 
