diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index b91e95129..6c7ddb1dc 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -3,7 +3,6 @@
* [Seam Documentation](README.md)
* [🚲 Quick Start](quickstart.md)
* [🚀 Go Live!](go-live.md)
-* [Contact Us](contact-us.md)
## Core Concepts
@@ -16,24 +15,13 @@
* [Personal Access Tokens](core-concepts/authentication/personal-access-tokens.md)
* [Client Sessions and Client Session Tokens](core-concepts/authentication/client-session-tokens/README.md)
* [Implementing Client Sessions for Device Management in the Backend](core-concepts/authentication/client-session-tokens/implementing-client-sessions-for-device-management-in-the-backend.md)
-* [Connect Webviews](core-concepts/connect-webviews/README.md)
- * [Connect Webview Process](core-concepts/connect-webviews/connect-webview-process.md)
- * [Embedding a Connect Webview in Your App](core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app.md)
- * [Verifying Successful Account Connection](core-concepts/connect-webviews/verifying-successful-account-connection.md)
- * [Retrieving Devices or Access Control Systems Connected Through a Connect Webview](core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.md)
- * [Attaching Custom Metadata to the Connect Webview](core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md)
- * [Filtering Connect Webviews by Custom Metadata](core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md)
- * [Customizing Connect Webviews](core-concepts/connect-webviews/customizing-connect-webviews.md)
* [Devices](core-concepts/devices/README.md)
* [Displaying Device Health](core-concepts/devices/displaying-device-health.md)
* [Displaying Device Power Status](core-concepts/devices/displaying-device-power-status.md)
* [Managed and Unmanaged Devices](core-concepts/devices/managed-and-unmanaged-devices.md)
* [Adding Custom Metadata to a Device](core-concepts/devices/adding-custom-metadata-to-a-device.md)
* [Filtering Devices by Custom Metadata](core-concepts/devices/filtering-devices-by-custom-metadata.md)
- * [Handling Device Errors](core-concepts/devices/handling-device-errors.md)
* [Testing Your App Against Device Disconnection and Removal](core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md)
-* [Providers](core-concepts/providers/README.md)
- * [Provider Metadata](core-concepts/providers/device-provider-metadata.md)
* [Connected Accounts](core-concepts/connected-accounts/README.md)
* [Adding Custom Metadata to a Connected Account](core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md)
* [Filtering Connected Accounts by Custom Metadata](core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata.md)
@@ -46,8 +34,7 @@
* [🔒 Smart Locks](products/smart-locks/README.md)
* [Locking and Unlocking Smart Locks](products/smart-locks/lock-and-unlock.md)
* [Creating and Managing Smart Lock Access Codes](products/smart-locks/access-codes/README.md)
- * [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes/README.md)
- * [Understanding Code Constraints](capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md)
+ * [Creating Access Codes](products/smart-locks/access-codes/creating-access-codes.md)
* [Retrieving Access Codes](products/smart-locks/access-codes/retrieving-access-codes.md)
* [Modifying Access Codes](products/smart-locks/access-codes/modifying-access-codes.md)
* [Deleting Access Codes](products/smart-locks/access-codes/deleting-access-codes.md)
@@ -107,6 +94,14 @@
## 💻 UI Components
+* [🔌 Connect Webviews](core-concepts/connect-webviews/README.md)
+ * [Connect Webview Process](ui-components/connect-webviews/connect-webview-process.md)
+ * [Embedding a Connect Webview in Your App](core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app.md)
+ * [Verifying Successful Account Connection](ui-components/connect-webviews/verifying-successful-account-connection.md)
+ * [Retrieving Devices or Access Control Systems Connected Through a Connect Webview](ui-components/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.md)
+ * [Attaching Custom Metadata to the Connect Webview](core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md)
+ * [Filtering Connect Webviews by Custom Metadata](core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md)
+ * [Customizing Connect Webviews](core-concepts/connect-webviews/customizing-connect-webviews.md)
* [🧱 Seam Components](seam-components/overview/README.md)
* [Getting Started with Seam Components](seam-components/overview/getting-started-with-seam-components.md)
* [Get Started with React](seam-components/overview/get-started-with-react-components-and-client-session-tokens.md)
@@ -131,55 +126,24 @@
* [Overview](api-clients/overview.md)
* [Installation](api-clients/installation.md)
* [Authentication](api-clients/authentication.md)
-* [Workspaces](api-clients/workspaces/README.md)
- * [Get Workspace](api-clients/workspaces/get.md)
- * [Reset Workspace](api-clients/workspaces/reset_sandbox.md)
-* [Client Sessions](api-clients/client_sessions/README.md)
- * [Create a Client Session](api-clients/client_sessions/create.md)
- * [Get or Create a Client Session](api-clients/client_sessions/get_or_create.md)
- * [List Client Sessions](api-clients/client_sessions/list.md)
- * [Get a Client Session](api-clients/client_sessions/get.md)
- * [Grant Access to a Client Session](api-clients/client_sessions/grant_access.md)
- * [Delete a Client Session](api-clients/client_sessions/delete.md)
-* [Connect Webviews](api-clients/connect_webviews/README.md)
- * [Create a Connect Webview](api-clients/connect_webviews/create.md)
- * [List Connect Webviews](api-clients/connect_webviews/list.md)
- * [Get a Connect Webview](api-clients/connect_webviews/get.md)
- * [Delete a Connect Webview](api-clients/connect_webviews/delete.md)
-* [Connected Accounts](api-clients/connected_accounts/README.md)
- * [Get a Connected Account](api-clients/connected_accounts/get.md)
- * [List Connected Accounts](api-clients/connected_accounts/list.md)
- * [Update a Connected Account](api-clients/connected_accounts/update.md)
- * [Delete a Connected Account](api-clients/connected_accounts/delete.md)
-* [Devices](api-clients/devices/README.md)
- * [List Devices](api-clients/devices/list.md)
- * [List Device Providers](api-clients/devices/list_device_providers.md)
- * [Get a Device](api-clients/devices/get.md)
- * [Update a Device](api-clients/devices/update.md)
- * [Unmanaged Devices](api-clients/devices/unmanaged/README.md)
- * [Update an Unmanaged Device](api-clients/devices/unmanaged/update.md)
- * [List Unmanaged Devices](api-clients/devices/unmanaged/list.md)
- * [Get an Unmanaged Device](api-clients/devices/unmanaged/get.md)
-* [Access Codes](api-clients/access_codes/README.md)
- * [Create an Access Code](api-clients/access_codes/create.md)
- * [Create Multiple Linked Access Codes](api-clients/access_codes/create_multiple.md)
- * [List Access Codes](api-clients/access_codes/list.md)
- * [Get an Access Code](api-clients/access_codes/get.md)
- * [Update an Access Code](api-clients/access_codes/update.md)
- * [Update Multiple Linked Access Codes](api-clients/access_codes/update-multiple-linked-access-codes.md)
- * [Report Device Access Code Constraints](api-clients/access_codes/report-device-access-code-constraints.md)
- * [Delete an Access Code](api-clients/access_codes/delete.md)
- * [Pull Backup Access Code](api-clients/access_codes/pull_backup_access_code.md)
- * [Unmanaged Access Codes](api-clients/access_codes/unmanaged/README.md)
- * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md)
- * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md)
- * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md)
-* [Locks](api-clients/locks/README.md)
- * [Get Lock](api-clients/locks/get.md)
- * [Lock a Lock](api-clients/locks/lock_door.md)
- * [Unlock a Lock](api-clients/locks/unlock_door.md)
- * [List Locks](api-clients/locks/list.md)
-* [Access Control Systems](api/acs/README.md)
+* [Access Codes](api/access_codes/README.md)
+ * [Create an Access Code](api/access_codes/create.md)
+ * [Create Multiple Linked Access Codes](api/access_codes/create_multiple.md)
+ * [List Access Codes](api/access_codes/list.md)
+ * [Get an Access Code](api/access_codes/get.md)
+ * [Update an Access Code](api/access_codes/update.md)
+ * [Update Multiple Linked Access Codes](api/access_codes/update-multiple-linked-access-codes.md)
+ * [Delete an Access Code](api/access_codes/delete.md)
+ * [Pull a Backup Access Code](api/access_codes/pull_backup_access_code.md)
+ * [Unmanaged Access Codes](api/access_codes/unmanaged/README.md)
+ * [List Unmanaged Access Codes](api/access_codes/unmanaged/list.md)
+ * [Get an Unmanaged Access Code](api/access_codes/unmanaged/get.md)
+ * [Convert an Unmanaged Access Code](api/access_codes/unmanaged/convert_to_managed.md)
+ * [Update an Unmanaged Access Code](api/access_codes/unmanaged/update.md)
+ * [Delete an Unmanaged Access Code](api/access_codes/unmanaged/delete.md)
+ * [Access Code Simulations](api/access_codes/simulate/README.md)
+ * [Simulate Creating an Unmanaged Access Code](api/access_codes/simulate/create_unmanaged_access_code.md)
+* [Access Control Systems (ACS)](api/acs/README.md)
* [Systems](api/acs/systems/README.md)
* [List ACS Systems](api/acs/systems/list.md)
* [Get an ACS System](api/acs/systems/get.md)
@@ -215,7 +179,6 @@
* [List Accessible Entrances](api/acs/credentials/list_accessible_entrances.md)
* [Encoders](api/acs/encoders/README.md)
* [Encode a Credential](api/acs/encoders/encode_credential.md)
- * [Get an Encoder](api/acs/encoders/get.md)
* [List Encoders](api/acs/encoders/list.md)
* [Scan a Credential](api/acs/encoders/scan_credential.md)
* [Encoder Simulations](api/acs/encoders/simulate/README.md)
@@ -223,6 +186,43 @@
* [Simulate that the Next Credential Encoding Will Succeed](api/acs/encoders/simulate/next_credential_encode_will_succeed.md)
* [Simulate that the Next Credential Scan Will Fail](api/acs/encoders/simulate/next_credential_scan_will_fail.md)
* [Simulate that the Next Credential Scan Will Succeed](api/acs/encoders/simulate/next_credential_scan_will_succeed.md)
+* [Action Attempts](api-clients/action_attempts/README.md)
+ * [Get Action Attempt](api-clients/action_attempts/get.md)
+* [Client Sessions](api-clients/client_sessions/README.md)
+ * [Create a Client Session](api-clients/client_sessions/create.md)
+ * [Get or Create a Client Session](api-clients/client_sessions/get_or_create.md)
+ * [List Client Sessions](api-clients/client_sessions/list.md)
+ * [Get a Client Session](api-clients/client_sessions/get.md)
+ * [Grant Access to a Client Session](api-clients/client_sessions/grant_access.md)
+ * [Delete a Client Session](api-clients/client_sessions/delete.md)
+* [Connect Webviews](api-clients/connect_webviews/README.md)
+ * [Create a Connect Webview](api-clients/connect_webviews/create.md)
+ * [List Connect Webviews](api-clients/connect_webviews/list.md)
+ * [Get a Connect Webview](api-clients/connect_webviews/get.md)
+ * [Delete a Connect Webview](api-clients/connect_webviews/delete.md)
+* [Connected Accounts](api-clients/connected_accounts/README.md)
+ * [Get a Connected Account](api-clients/connected_accounts/get.md)
+ * [List Connected Accounts](api-clients/connected_accounts/list.md)
+ * [Update a Connected Account](api-clients/connected_accounts/update.md)
+ * [Delete a Connected Account](api-clients/connected_accounts/delete.md)
+* [Devices](api-clients/devices/README.md)
+ * [List Devices](api-clients/devices/list.md)
+ * [List Device Providers](api-clients/devices/list_device_providers.md)
+ * [Device Provider Metadata](reference/device-provider-metadata.md)
+ * [Get a Device](api-clients/devices/get.md)
+ * [Update a Device](api-clients/devices/update.md)
+ * [Unmanaged Devices](api-clients/devices/unmanaged/README.md)
+ * [Update an Unmanaged Device](api-clients/devices/unmanaged/update.md)
+ * [List Unmanaged Devices](api-clients/devices/unmanaged/list.md)
+ * [Get an Unmanaged Device](api-clients/devices/unmanaged/get.md)
+* [Events](api-clients/events/README.md)
+ * [List Events](api-clients/events/list.md)
+ * [Get an Event](api-clients/events/get.md)
+* [Locks](api-clients/locks/README.md)
+ * [Get Lock](api-clients/locks/get.md)
+ * [Lock a Lock](api-clients/locks/lock_door.md)
+ * [Unlock a Lock](api-clients/locks/unlock_door.md)
+ * [List Locks](api-clients/locks/list.md)
* [Noise Sensors](api-clients/noise_sensors/README.md)
* [Noise Thresholds](api-clients/noise_sensors/noise_thresholds/README.md)
* [Create Noise Thresholds](api-clients/noise_sensors/noise_thresholds/create.md)
@@ -276,11 +276,9 @@
* [List Enrollment Automations](api/user_identities/enrollment_automations/list.md)
* [Get an Enrollment Automation](api/user_identities/enrollment_automations/get.md)
* [Delete an Enrollment Automation](api/user_identities/enrollment_automations/delete.md)
-* [Action Attempts](api-clients/action_attempts/README.md)
- * [Get Action Attempt](api-clients/action_attempts/get.md)
-* [Events](api-clients/events/README.md)
- * [List Events](api-clients/events/list.md)
- * [Get an Event](api-clients/events/get.md)
+* [Workspaces](api-clients/workspaces/README.md)
+ * [Get Workspace](api-clients/workspaces/get.md)
+ * [Reset Workspace](api-clients/workspaces/reset_sandbox.md)
## 🛠️ Developer Tools
@@ -316,7 +314,6 @@
* [Sandbox Salto Space Access System](developer-tools/sandbox-and-sample-data/sandbox-salto-space-access-control-system.md)
* [Sandbox Schlage Encode Locks](device-guides/sandbox-and-sample-data/schlage-encode-sample-data.md)
* [Sandbox Seam Bridge](device-guides/sandbox-and-sample-data/seam-bridge-sample-data.md)
- * [Sandbox Sensi Thermostats](developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md)
* [Sandbox SmartThings Hub](device-guides/sandbox-and-sample-data/smartthings-sample-data.md)
* [Sandbox Tedee Locks](developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.md)
* [Sandbox TTLock Locks](device-guides/sandbox-and-sample-data/ttlock-sample-data.md)
@@ -338,65 +335,65 @@
* [Get started with 4SUITES locks](device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md)
* [Akiles Locks](device-and-system-integration-guides/akiles-locks/README.md)
* [Get started with Akiles locks](device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md)
-* [ASSA ABLOY Credential Services](device-and-system-integration-guides/assa-abloy-credential-services-credential-manager.md)
-* [ASSA ABLOY Visionline Access Control System](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md)
- * [Visionline ACS Setup Instructions](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md)
- * [Developing and Launching Your Visionline Plastic Card Encoding App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md)
- * [Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md)
- * [Step 1: Install Your Visionline Application](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md)
- * [Step 2: Unblock Required Ports](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md)
- * [Step 3: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md)
- * [Step 4: Install a Visionline Card Encoder](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md)
- * [Step 5: Set up Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md)
- * [Step 6: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md)
- * [Step 7: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md)
+* [ASSA ABLOY Credential Services](device-guides/assa-abloy-credential-services-credential-manager-in-development.md)
+* [ASSA ABLOY Visionline Access Control System](device-guides/assa-abloy-visionline-access-control-system-in-development/README.md)
+ * [Visionline ACS Setup Instructions](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/README.md)
+ * [Developing and Launching Your Visionline Plastic Card Encoding App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md)
+ * [Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md)
+ * [Step 1: Install Your Visionline Application](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md)
+ * [Step 2: Unblock Required Ports](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md)
+ * [Step 3: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md)
+ * [Step 4: Install a Visionline Card Encoder](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md)
+ * [Step 5: Set up Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md)
+ * [Step 6: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md)
+ * [Step 7: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md)
* [Step 8: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md)
- * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md)
- * [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md)
- * [Step 1: Create a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md)
- * [Step 2: Connect the Virtual Visionline ACS to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md)
- * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md)
- * [Launching Your Visionline Plastic Card Encoding App to a Live Site](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md)
- * [Step 1: Confirm That Your Visionline Site Meets the Requirements](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md)
- * [Step 2: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md)
- * [Step 3: Purchase and Import the Callback Option from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md)
- * [Step 4: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md)
+ * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md)
+ * [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md)
+ * [Step 1: Create a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md)
+ * [Step 2: Connect the Virtual Visionline ACS to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md)
+ * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md)
+ * [Launching Your Visionline Plastic Card Encoding App to a Live Site](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md)
+ * [Step 1: Confirm That Your Visionline Site Meets the Requirements](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md)
+ * [Step 2: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md)
+ * [Step 3: Purchase and Import the Callback Option from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md)
+ * [Step 4: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md)
* [Step 5: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md)
- * [Developing and Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md)
- * [Developing Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md)
- * [Step 1: Complete the ASSA ABLOY Mobile Development Course](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md)
- * [Step 2: Install Your Visionline Application](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md)
- * [Step 3: Unblock Required Ports](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md)
- * [Step 4: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md)
- * [Step 5: Set up Your Credential Services Account in Visionline](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md)
- * [Step 6: Configure the Mobile Access UUID in Visionline](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md)
- * [Step 7: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md)
- * [Step 8: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md)
- * [Step 9: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md)
+ * [Developing and Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md)
+ * [Developing Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md)
+ * [Step 1: Complete the ASSA ABLOY Mobile Development Course](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md)
+ * [Step 2: Install Your Visionline Application](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md)
+ * [Step 3: Unblock Required Ports](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md)
+ * [Step 4: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md)
+ * [Step 5: Set up Your Credential Services Account in Visionline](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md)
+ * [Step 6: Configure the Mobile Access UUID in Visionline](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md)
+ * [Step 7: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md)
+ * [Step 8: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md)
+ * [Step 9: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md)
* [Step 10: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md)
- * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md)
- * [Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md)
- * [Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md)
- * [Step 2: Confirm That Your Visionline Site Meets the Requirements](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md)
- * [Step 3: Confirm BLE Module on All Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md)
- * [Step 4: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md)
- * [Step 5: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md)
- * [Step 6: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md)
- * [Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md)
- * [Step 8: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md)
+ * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md)
+ * [Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md)
+ * [Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md)
+ * [Step 2: Confirm That Your Visionline Site Meets the Requirements](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md)
+ * [Step 3: Confirm BLE Module on All Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md)
+ * [Step 4: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md)
+ * [Step 5: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md)
+ * [Step 6: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md)
+ * [Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md)
+ * [Step 8: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md)
* [Step 9: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md)
- * [Configuring Visionline Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/README.md)
- * [Issuing Various Types of Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-mobile-credentials.md)
- * [Issuing Various Types of Guest Joiner Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md)
- * [Retrieving Guest and Common Entrances](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/retrieving-guest-and-common-entrances.md)
- * [Checking if a User Identity Has a Phone That Is Set up for a Credential Manager](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md)
- * [Updating Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/updating-guest-mobile-credentials.md)
- * [Revoking Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/revoking-mobile-credentials.md)
- * [Mobile Credential-Related Properties](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md)
- * [Common Use Cases](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md)
+ * [Configuring Visionline Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/README.md)
+ * [Issuing Various Types of Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/issuing-various-types-of-guest-mobile-credentials.md)
+ * [Issuing Various Types of Guest Joiner Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md)
+ * [Retrieving Guest and Common Entrances](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/retrieving-guest-and-common-entrances.md)
+ * [Checking if a User Identity Has a Phone That Is Set up for a Credential Manager](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md)
+ * [Updating Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/updating-guest-mobile-credentials.md)
+ * [Revoking Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/credential-types/revoking-mobile-credentials.md)
+ * [Mobile Credential-Related Properties](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/mobile-credential-related-properties.md)
+ * [Common Use Cases](device-guides/assa-abloy-visionline-access-control-system-in-development/common-use-cases.md)
* [Special Requirements for Android Mobile Access SDK Development](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md)
* [Special Requirements for iOS Mobile Access SDK Development](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md)
- * [Creating Visionline Card-based Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md)
+ * [Creating Visionline Card-based Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/creating-visionline-card-based-credentials.md)
* [August Locks](device-guides/august-locks.md)
* [Get started with August locks](device-guides/get-started-with-august-locks.md)
* [Avigilon Alta Access System](device-guides/avigilon-alta-access-system.md)
@@ -444,10 +441,7 @@
* [Schlage Locks](device-and-system-integration-guides/schlage-locks/README.md)
* [Schlage Locks Setup Instructions](device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.md)
* [Get started with Schlage Locks](device-guides/get-started-with-schlage-locks.md)
-* [Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/README.md)
- * [Get Started with Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md)
-* [SmartThings Hubs + Smart Locks](device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md)
- * [Get started with SmartThings Hubs + Smart Locks](device-guides/get-started-with-smartthings-hubs-+-smart-locks.md)
+* [Get started with SmartThings Hubs + Smart Locks](device-guides/get-started-with-smartthings-hubs-+-smart-locks.md)
* [Tedee Locks](device-and-system-integration-guides/tedee-locks/README.md)
* [Get Started with Tedee Locks](device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md)
* [TTLock Locks](device-guides/ttlock-locks.md)
diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json
index 8de87044e..88751ad9f 100644
--- a/docs/api/_blueprint.json
+++ b/docs/api/_blueprint.json
@@ -6944,6 +6944,180 @@
{
"title": "Create a new ACS user",
"description": "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
+ "request": {
+ "path": "/acs/users/create",
+ "parameters": {
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+ }
+ },
+ "response": {
+ "body": {
+ "acs_user": {
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+ }
+ }
+ },
+ "code": {
+ "javascript": {
+ "title": "JavaScript",
+ "request": "await seam.acs.users.create({\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n});",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "javascript",
+ "response_syntax": "json"
+ },
+ "python": {
+ "title": "Python",
+ "request": "seam.acs.users.create(\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n)",
+ "response": "AcsUser(\n acs_user_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n workspace_id=\"123e4567-e89b-12d3-a456-426614174000\",\n created_at=\"2024-04-05T07:57:05.323Z\",\n display_name=\"Jane Doe\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n)",
+ "request_syntax": "python",
+ "response_syntax": "python"
+ },
+ "ruby": {
+ "title": "Ruby",
+ "request": "seam.acs.users.create(\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n)",
+ "response": "{\n \"acs_user_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n}",
+ "request_syntax": "ruby",
+ "response_syntax": "ruby"
+ },
+ "php": {
+ "title": "PHP",
+ "request": "acs->users->create(\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\"\n);",
+ "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n];",
+ "request_syntax": "php",
+ "response_syntax": "php"
+ },
+ "seam_cli": {
+ "title": "Seam CLI",
+ "request": "seam acs users create --acs_system_id \"123e4567-e89b-12d3-a456-426614174000\" --full_name \"Jane Doe\" --email_address \"jane@example.com\" --phone_number \"+15555550100\"",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "bash",
+ "response_syntax": "json"
+ },
+ "go": {
+ "title": "Go",
+ "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Create(\n\t\tcontext.Background(),\n\t\tusers.UsersCreateRequest{\n\t\t\tAcsSystemId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tFullName: api.String(\"Jane Doe\"),\n\t\t\tEmailAddress: api.String(\"jane@example.com\"),\n\t\t\tPhoneNumber: api.String(\"+15555550100\"),\n\t\t},\n\t)\n}",
+ "response": "api.AcsUser{AcsUserId: \"123e4567-e89b-12d3-a456-426614174000\", AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", WorkspaceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\", DisplayName: \"Jane Doe\", FullName: \"Jane Doe\", EmailAddress: \"jane@example.com\", PhoneNumber: \"+15555550100\"}",
+ "request_syntax": "go",
+ "response_syntax": "go"
+ },
+ "java": {
+ "title": "Java",
+ "request": "seam.acs().users().create(UsersCreateRequest.builder().acsSystemId(\"123e4567-e89b-12d3-a456-426614174000\")\n.fullName(\"Jane Doe\")\n.emailAddress(\"jane@example.com\")\n.phoneNumber(\"+15555550100\").build());",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "java",
+ "response_syntax": "json"
+ },
+ "csharp": {
+ "title": "C#",
+ "request": "seam.Acs.Users.Create(acsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", fullName: \"Jane Doe\", emailAddress: \"jane@example.com\", phoneNumber: \"+15555550100\")",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "csharp",
+ "response_syntax": "json"
+ }
+ }
+ },
+ {
+ "title": "Create a new ACS user",
+ "description": "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule.",
+ "request": {
+ "path": "/acs/users/create",
+ "parameters": {
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100",
+ "access_schedule": {
+ "starts_at": "2024-11-01T15:00:00.000Z",
+ "ends_at": "2024-11-04T11:00:00.000Z"
+ }
+ }
+ },
+ "response": {
+ "body": {
+ "acs_user": {
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+ }
+ }
+ },
+ "code": {
+ "javascript": {
+ "title": "JavaScript",
+ "request": "await seam.acs.users.create({\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n access_schedule: {\n starts_at: \"2024-11-01T15:00:00.000Z\",\n ends_at: \"2024-11-04T11:00:00.000Z\",\n },\n});",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "javascript",
+ "response_syntax": "json"
+ },
+ "python": {
+ "title": "Python",
+ "request": "seam.acs.users.create(\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n access_schedule={\n \"starts_at\": \"2024-11-01T15:00:00.000Z\",\n \"ends_at\": \"2024-11-04T11:00:00.000Z\",\n },\n)",
+ "response": "AcsUser(\n acs_user_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n workspace_id=\"123e4567-e89b-12d3-a456-426614174000\",\n created_at=\"2024-04-05T07:57:05.323Z\",\n display_name=\"Jane Doe\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n)",
+ "request_syntax": "python",
+ "response_syntax": "python"
+ },
+ "ruby": {
+ "title": "Ruby",
+ "request": "seam.acs.users.create(\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n access_schedule: {\n starts_at: \"2024-11-01T15:00:00.000Z\",\n ends_at: \"2024-11-04T11:00:00.000Z\",\n },\n)",
+ "response": "{\n \"acs_user_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n}",
+ "request_syntax": "ruby",
+ "response_syntax": "ruby"
+ },
+ "php": {
+ "title": "PHP",
+ "request": "acs->users->create(\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n access_schedule: [\n \"starts_at\" => \"2024-11-01T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-04T11:00:00.000Z\",\n ]\n);",
+ "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n];",
+ "request_syntax": "php",
+ "response_syntax": "php"
+ },
+ "seam_cli": {
+ "title": "Seam CLI",
+ "request": "seam acs users create --acs_system_id \"123e4567-e89b-12d3-a456-426614174000\" --full_name \"Jane Doe\" --email_address \"jane@example.com\" --phone_number \"+15555550100\" --access_schedule {\"starts_at\":\"2024-11-01T15:00:00.000Z\",\"ends_at\":\"2024-11-04T11:00:00.000Z\"}",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "bash",
+ "response_syntax": "json"
+ },
+ "go": {
+ "title": "Go",
+ "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Create(\n\t\tcontext.Background(),\n\t\tusers.UsersCreateRequest{\n\t\t\tAcsSystemId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tFullName: api.String(\"Jane Doe\"),\n\t\t\tEmailAddress: api.String(\"jane@example.com\"),\n\t\t\tPhoneNumber: api.String(\"+15555550100\"),\n\t\t\tAccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String(\"2024-11-01T15:00:00.000Z\"), EndsAt: api.String(\"2024-11-04T11:00:00.000Z\")},\n\t\t},\n\t)\n}",
+ "response": "api.AcsUser{AcsUserId: \"123e4567-e89b-12d3-a456-426614174000\", AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", WorkspaceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\", DisplayName: \"Jane Doe\", FullName: \"Jane Doe\", EmailAddress: \"jane@example.com\", PhoneNumber: \"+15555550100\"}",
+ "request_syntax": "go",
+ "response_syntax": "go"
+ },
+ "java": {
+ "title": "Java",
+ "request": "seam.acs().users().create(UsersCreateRequest.builder().acsSystemId(\"123e4567-e89b-12d3-a456-426614174000\")\n.fullName(\"Jane Doe\")\n.emailAddress(\"jane@example.com\")\n.phoneNumber(\"+15555550100\")\n.accessSchedule(Map.of(\"starts_at\", \"2024-11-01T15:00:00.000Z\", \"ends_at\", \"2024-11-04T11:00:00.000Z\")).build());",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "java",
+ "response_syntax": "json"
+ },
+ "csharp": {
+ "title": "C#",
+ "request": "seam.Acs.Users.Create(acsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", fullName: \"Jane Doe\", emailAddress: \"jane@example.com\", phoneNumber: \"+15555550100\", accessSchedule: new { startsAt = \"2024-11-01T15:00:00.000Z\", endsAt = \"2024-11-04T11:00:00.000Z\" })",
+ "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}",
+ "request_syntax": "csharp",
+ "response_syntax": "json"
+ }
+ }
+ },
+ {
+ "title": "Create a new ACS user in an access group",
+ "description": "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md).",
"request": {
"path": "/acs/users/create",
"parameters": {
diff --git a/docs/api/_report.md b/docs/api/_report.md
index 327adc94d..752e7ea79 100644
--- a/docs/api/_report.md
+++ b/docs/api/_report.md
@@ -4,9 +4,6 @@
### Routes
-- `/access_codes`
-- `/access_codes/simulate`
-- `/access_codes/unmanaged`
- `/action_attempts`
- `/bridges`
- `/client_sessions`
diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md
new file mode 100644
index 000000000..3bf5b6b8e
--- /dev/null
+++ b/docs/api/access_codes/README.md
@@ -0,0 +1,3290 @@
+# Access Codes
+
+## The access_code Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
+
+Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+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`.
+
+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.
+
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ access_code_id: [example value],
+ code: [example value],
+ common_code_key: [example value],
+ created_at: [example value],
+ device_id: [example value],
+ ends_at: [example value],
+ errors: [example value],
+ is_backup: [example value],
+ is_backup_access_code_available: [example value],
+ is_external_modification_allowed: [example value],
+ is_managed: [example value],
+ is_offline_access_code: [example value],
+ is_one_time_use: [example value],
+ is_scheduled_on_device: [example value],
+ is_waiting_for_code_assignment: [example value],
+ name: [example value],
+ pulled_backup_access_code_id: [example value],
+ starts_at: [example value],
+ status: [example value],
+ type: [example value],
+ warnings: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
+
+**`access_code_id`** *UUID*
+
+Unique identifier for the access code.
+
+
+
+
+---
+
+**`code`** *String*
+
+Code used for access. Typically, a numeric or alphanumeric string.
+
+
+
+
+---
+
+**`common_code_key`** *String*
+
+Unique identifier for a group of access codes that share the same code.
+
+
+
+
+---
+
+**`created_at`** *Datetime*
+
+Date and time at which the access code was created.
+
+
+
+
+---
+
+**`device_id`** *UUID*
+
+Unique identifier for the device associated with the access code.
+
+
+
+
+---
+
+**`ends_at`** *Datetime*
+
+Date and time after which the time-bound access code becomes inactive.
+
+
+
+
+---
+
+[**`errors`**](./#errors) *List* *of Objects*
+
+Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+
+The specific structure of each object in this list depends on the value of its `error_code` field.
+
+Variants:
+
+smartthings_failed_to_set_access_code
+
+Failed to set code on SmartThings device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_failed_to_set_access_code
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+smartthings_failed_to_set_after_multiple_retries
+
+Failed to set code after multiple retries.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_failed_to_set_after_multiple_retries
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+smartthings_no_free_slots_available
+
+No free slots available on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_no_free_slots_available
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+failed_to_set_on_device
+
+Failed to set code on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - failed_to_set_on_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+failed_to_remove_from_device
+
+Failed to remove code from device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - failed_to_remove_from_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+duplicate_code_on_device
+
+Duplicate access code detected on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - duplicate_code_on_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+duplicate_code_attempt_prevented
+
+An attempt to modify this access code was prevented.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - duplicate_code_attempt_prevented
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+no_space_for_access_code_on_device
+
+No space for access code on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - no_space_for_access_code_on_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+igloohome_bridge_too_many_pending_jobs
+
+Igloohome bridge has too many pending jobs in the queue.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloohome_bridge_too_many_pending_jobs
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+igloohome_bridge_offline
+
+Igloohome bridge is offline.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloohome_bridge_offline
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+igloohome_offline_access_code_no_variance_available
+
+Lock has reached maximum amount of codes.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloohome_offline_access_code_no_variance_available
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+kwikset_unable_to_confirm_code
+
+Unable to confirm that the access code is set on Kwikset device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - kwikset_unable_to_confirm_code
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+kwikset_unable_to_confirm_deletion
+
+Unable to confirm the deletion of the access code on Kwikset device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - kwikset_unable_to_confirm_deletion
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+code_modified_external_to_seam
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - code_modified_external_to_seam
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_lock_invalid_code_length
+
+Invalid code length for August lock.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_invalid_code_length
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_device_programming_delay
+
+Access code has not yet been fully moved to the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_device_programming_delay
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_device_slots_full
+
+All access code slots on the device are full.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_device_slots_full
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_lock_missing_keypad
+
+August lock is missing a keypad.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_missing_keypad
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_lock_temporarily_offline
+
+August lock is temporarily offline.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_temporarily_offline
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+salto_ks_user_not_subscribed
+
+Salto site user is not subscribed.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - salto_ks_user_not_subscribed
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+hubitat_device_programming_delay
+
+Access code has not yet been fully moved to the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - hubitat_device_programming_delay
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+hubitat_no_free_positions_available
+
+No free positions available on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - hubitat_no_free_positions_available
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+wyze_duplicate_code_name
+
+Duplicate access code name detected.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - wyze_duplicate_code_name
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+wyze_potential_duplicate_code
+
+Potential duplicate access code detected.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - wyze_potential_duplicate_code
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+dormakaba_oracode_no_valid_user_level
+
+No valid user level for Oracode.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - dormakaba_oracode_no_valid_user_level
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+account_disconnected
+
+Account is disconnected
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - account_disconnected
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+salto_ks_subscription_limit_exceeded
+
+Salto site user limit reached.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - salto_ks_subscription_limit_exceeded
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+device_offline
+
+Device is offline
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - device_offline
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+device_removed
+
+Device has been removed
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - device_removed
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+hub_disconnected
+
+Hub is disconnected
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - hub_disconnected
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+device_disconnected
+
+Device is disconnected
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - device_disconnected
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+empty_backup_access_code_pool
+
+The backup access code pool is empty.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - empty_backup_access_code_pool
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+august_lock_not_authorized
+
+User is not authorized to use the August Lock.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_not_authorized
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+august_lock_missing_bridge
+
+Lock is not connected to the Seam Bridge.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_missing_bridge
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+ttlock_lock_not_paired_to_gateway
+
+Lock is not paired with a Gateway.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - ttlock_lock_not_paired_to_gateway
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+missing_device_credentials
+
+Missing device credentials.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - missing_device_credentials
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+auxiliary_heat_running
+
+The auxiliary heat is running.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - auxiliary_heat_running
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+subscription_required
+
+Subscription required to connect.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - subscription_required
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+invalid_credentials
+
+Credentials provided were invalid.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - invalid_credentials
+
+
+
+ ---
+
+ **`is_bridge_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+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`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - bridge_disconnected
+
+
+
+ ---
+
+ **`is_bridge_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+---
+
+**`is_backup`** *Boolean*
+
+Indicates whether the access code is a backup code.
+
+
+
+
+---
+
+**`is_backup_access_code_available`** *Boolean*
+
+Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
+
+
+
+
+---
+
+**`is_external_modification_allowed`** *Boolean*
+
+Indicates whether changes to the access code from external sources are permitted.
+
+
+
+
+---
+
+**`is_managed`** *Boolean*
+
+Indicates whether Seam manages the access code.
+
+
+
+
+---
+
+**`is_offline_access_code`** *Boolean*
+
+Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.
+
+
+
+
+---
+
+**`is_one_time_use`** *Boolean*
+
+Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.
+
+
+
+
+---
+
+**`is_scheduled_on_device`** *Boolean*
+
+Indicates whether the code is set on the device according to a preconfigured schedule.
+
+
+
+
+---
+
+**`is_waiting_for_code_assignment`** *Boolean*
+
+Indicates whether the access code is waiting for a code assignment.
+
+
+
+
+---
+
+**`name`** *String*
+
+Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+
+
+
+
+---
+
+**`pulled_backup_access_code_id`** *UUID*
+
+Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
+
+
+
+
+---
+
+**`starts_at`** *Datetime*
+
+Date and time at which the time-bound access code becomes active.
+
+
+
+
+---
+
+**`status`** *Enum*
+
+Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+
+
+
+Enum values
+
+- setting
+- set
+- unset
+- removing
+- unknown
+
+
+
+---
+
+**`type`** *Enum*
+
+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.
+
+
+
+Enum values
+
+- time_bound
+- ongoing
+
+
+
+---
+
+[**`warnings`**](./#warnings) *List* *of Objects*
+
+Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+
+The specific structure of each object in this list depends on the value of its `warning_code` field.
+
+Variants:
+
+smartthings_failed_to_set_access_code
+
+Failed to set code on SmartThings device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_failed_to_set_access_code
+
+
+
+
+
+schlage_detected_duplicate
+
+Duplicate access code detected.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - schlage_detected_duplicate
+
+
+
+
+
+schlage_creation_outage
+
+Received an error when attempting to create this code.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - schlage_creation_outage
+
+
+
+
+
+code_modified_external_to_seam
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - code_modified_external_to_seam
+
+
+
+
+
+delay_in_setting_on_device
+
+Delay in setting code on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - delay_in_setting_on_device
+
+
+
+
+
+delay_in_removing_from_device
+
+Delay in removing code from device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - delay_in_removing_from_device
+
+
+
+
+
+third_party_integration_detected
+
+Third-party integration detected that may cause access codes to fail.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - third_party_integration_detected
+
+
+
+
+
+august_device_programming_delay
+
+Access code has not yet been fully moved to the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_device_programming_delay
+
+
+
+
+
+august_lock_temporarily_offline
+
+August lock is temporarily offline.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_temporarily_offline
+
+
+
+
+
+igloo_algopin_must_be_used_within_24_hours
+
+Algopins must be used within 24 hours.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloo_algopin_must_be_used_within_24_hours
+
+
+
+
+
+management_transferred
+
+Management was transferred to another workspace.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - management_transferred
+
+
+
+
+
+kwikset_unable_to_confirm_code
+
+Unable to confirm that the access code is set on Kwikset device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - kwikset_unable_to_confirm_code
+
+
+
+
+
+---
+
+
+## Errors
+
+**`smartthings_failed_to_set_access_code`**
+
+Failed to set code on SmartThings device.
+
+---
+
+**`smartthings_failed_to_set_after_multiple_retries`**
+
+Failed to set code after multiple retries.
+
+---
+
+**`smartthings_no_free_slots_available`**
+
+No free slots available on the device.
+
+---
+
+**`failed_to_set_on_device`**
+
+Failed to set code on device.
+
+---
+
+**`failed_to_remove_from_device`**
+
+Failed to remove code from device.
+
+---
+
+**`duplicate_code_on_device`**
+
+Duplicate access code detected on device.
+
+---
+
+**`duplicate_code_attempt_prevented`**
+
+An attempt to modify this access code was prevented.
+
+---
+
+**`no_space_for_access_code_on_device`**
+
+No space for access code on device.
+
+---
+
+**`igloohome_bridge_too_many_pending_jobs`**
+
+Igloohome bridge has too many pending jobs in the queue.
+
+---
+
+**`igloohome_bridge_offline`**
+
+Igloohome bridge is offline.
+
+---
+
+**`igloohome_offline_access_code_no_variance_available`**
+
+Lock has reached maximum amount of codes.
+
+---
+
+**`kwikset_unable_to_confirm_code`**
+
+Unable to confirm that the access code is set on Kwikset device.
+
+---
+
+**`kwikset_unable_to_confirm_deletion`**
+
+Unable to confirm the deletion of the access code on Kwikset device.
+
+---
+
+**`code_modified_external_to_seam`**
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+---
+
+**`august_lock_invalid_code_length`**
+
+Invalid code length for August lock.
+
+---
+
+**`august_device_programming_delay`**
+
+Access code has not yet been fully moved to the device.
+
+---
+
+**`august_device_slots_full`**
+
+All access code slots on the device are full.
+
+---
+
+**`august_lock_missing_keypad`**
+
+August lock is missing a keypad.
+
+---
+
+**`august_lock_temporarily_offline`**
+
+August lock is temporarily offline.
+
+---
+
+**`salto_ks_user_not_subscribed`**
+
+Salto site user is not subscribed.
+
+---
+
+**`hubitat_device_programming_delay`**
+
+Access code has not yet been fully moved to the device.
+
+---
+
+**`hubitat_no_free_positions_available`**
+
+No free positions available on the device.
+
+---
+
+**`wyze_duplicate_code_name`**
+
+Duplicate access code name detected.
+
+---
+
+**`wyze_potential_duplicate_code`**
+
+Potential duplicate access code detected.
+
+---
+
+**`dormakaba_oracode_no_valid_user_level`**
+
+No valid user level for Oracode.
+
+---
+
+**`account_disconnected`**
+
+Account is disconnected
+
+---
+
+**`salto_ks_subscription_limit_exceeded`**
+
+Salto site user limit reached.
+
+---
+
+**`device_offline`**
+
+Device is offline
+
+---
+
+**`device_removed`**
+
+Device has been removed
+
+---
+
+**`hub_disconnected`**
+
+Hub is disconnected
+
+---
+
+**`device_disconnected`**
+
+Device is disconnected
+
+---
+
+**`empty_backup_access_code_pool`**
+
+The backup access code pool is empty.
+
+---
+
+**`august_lock_not_authorized`**
+
+User is not authorized to use the August Lock.
+
+---
+
+**`august_lock_missing_bridge`**
+
+Lock is not connected to the Seam Bridge.
+
+---
+
+**`ttlock_lock_not_paired_to_gateway`**
+
+Lock is not paired with a Gateway.
+
+---
+
+**`missing_device_credentials`**
+
+Missing device credentials.
+
+---
+
+**`auxiliary_heat_running`**
+
+The auxiliary heat is running.
+
+---
+
+**`subscription_required`**
+
+Subscription required to connect.
+
+---
+
+**`invalid_credentials`**
+
+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).
+
+---
+
+
+## Warnings
+
+**`smartthings_failed_to_set_access_code`**
+
+Failed to set code on SmartThings device.
+
+---
+
+**`schlage_detected_duplicate`**
+
+Duplicate access code detected.
+
+---
+
+**`schlage_creation_outage`**
+
+Received an error when attempting to create this code.
+
+---
+
+**`code_modified_external_to_seam`**
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+---
+
+**`delay_in_setting_on_device`**
+
+Delay in setting code on device.
+
+---
+
+**`delay_in_removing_from_device`**
+
+Delay in removing code from device.
+
+---
+
+**`third_party_integration_detected`**
+
+Third-party integration detected that may cause access codes to fail.
+
+---
+
+**`august_device_programming_delay`**
+
+Access code has not yet been fully moved to the device.
+
+---
+
+**`august_lock_temporarily_offline`**
+
+August lock is temporarily offline.
+
+---
+
+**`igloo_algopin_must_be_used_within_24_hours`**
+
+Algopins must be used within 24 hours.
+
+---
+
+**`management_transferred`**
+
+Management was transferred to another workspace.
+
+---
+
+**`kwikset_unable_to_confirm_code`**
+
+Unable to confirm that the access code is set on Kwikset device.
+
+---
+
+
+## Events
+
+**`access_code.created`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.created`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.changed`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.changed`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.scheduled_on_device`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- code String
+
+ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.scheduled_on_device`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.set_on_device`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- code String
+
+ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.set_on_device`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.removed_from_device`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.removed_from_device`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.delay_in_setting_on_device`**
+
+There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.delay_in_setting_on_device`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.failed_to_set_on_device`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.failed_to_set_on_device`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.deleted`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- code String
+
+ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.deleted`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.delay_in_removing_from_device`**
+
+There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.delay_in_removing_from_device`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.failed_to_remove_from_device`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.failed_to_remove_from_device`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.modified_external_to_seam`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.modified_external_to_seam`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.deleted_external_to_seam`**
+
+An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.deleted_external_to_seam`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.backup_access_code_pulled`**
+
+A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- backup_access_code_id String
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.backup_access_code_pulled`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+## Endpoints
+
+
+[**`/access_codes/create`**](./create.md)
+
+Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+[**`/access_codes/create_multiple`**](./create_multiple.md)
+
+Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
+
+
+[**`/access_codes/delete`**](./delete.md)
+
+Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+[**`/access_codes/get`**](./get.md)
+
+Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+[**`/access_codes/list`**](./list.md)
+
+Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+[**`/access_codes/pull_backup_access_code`**](./pull_backup_access_code.md)
+
+Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).
+
+
+[**`/access_codes/report_device_constraints`**](./report_device_constraints.md)
+
+Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
+
+
+[**`/access_codes/update`**](./update.md)
+
+Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+[**`/access_codes/update_multiple`**](./update_multiple.md)
+
+Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
+
+
diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md
new file mode 100644
index 000000000..038cabefb
--- /dev/null
+++ b/docs/api/access_codes/create.md
@@ -0,0 +1,141 @@
+# Create an Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/create ⇒ { access_code }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the device for which to create the new access code.
+
+---
+
+**`allow_external_modification`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+
+---
+
+**`attempt_for_offline_device`**
+
+---
+
+**`code`**
+
+Code to be used for access.
+
+---
+
+**`common_code_key`**
+
+Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).
+
+---
+
+**`ends_at`**
+
+Date and time at which the validity of the new access code 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 `starts_at`.
+
+---
+
+**`is_external_modification_allowed`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+
+---
+
+**`is_offline_access_code`**
+
+Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
+
+---
+
+**`is_one_time_use`**
+
+Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+
+---
+
+**`max_time_rounding`**
+
+Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+
+---
+
+**`name`**
+
+Name of the new access code.
+
+---
+
+**`prefer_native_scheduling`**
+
+Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+
+---
+
+**`preferred_code_length`**
+
+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.
+
+---
+
+**`starts_at`**
+
+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.
+
+---
+
+**`use_backup_access_code_pool`**
+
+Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md).
+
+---
+
+**`use_offline_access_code`**
+
+---
+
+
+## Response
+
+[access\_code](./)
+
+**`CREATE_ACCESS_CODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md
new file mode 100644
index 000000000..237687ca7
--- /dev/null
+++ b/docs/api/access_codes/create_multiple.md
@@ -0,0 +1,143 @@
+# Create Multiple Linked Access Codes
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
+
+Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
+
+If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.
+
+If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
+
+See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_ids`** *of UUIDs* (Required)
+
+IDs of the devices for which to create the new access codes.
+
+---
+
+**`allow_external_modification`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+
+---
+
+**`attempt_for_offline_device`**
+
+---
+
+**`behavior_when_code_cannot_be_shared`**
+
+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.
+
+---
+
+**`code`**
+
+Code to be used for access.
+
+---
+
+**`ends_at`**
+
+Date and time at which the validity of the new access code 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 `starts_at`.
+
+---
+
+**`is_external_modification_allowed`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+
+---
+
+**`is_offline_access_code`**
+
+Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
+
+---
+
+**`is_one_time_use`**
+
+Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+
+---
+
+**`max_time_rounding`**
+
+Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+
+---
+
+**`name`**
+
+Name of the new access code.
+
+---
+
+**`prefer_native_scheduling`**
+
+Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+
+---
+
+**`preferred_code_length`**
+
+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.
+
+---
+
+**`starts_at`**
+
+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.
+
+---
+
+**`use_backup_access_code_pool`**
+
+Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md).
+
+---
+
+**`use_offline_access_code`**
+
+---
+
+
+## Response
+
+Array of [access\_codes](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md
new file mode 100644
index 000000000..1292fb058
--- /dev/null
+++ b/docs/api/access_codes/delete.md
@@ -0,0 +1,46 @@
+# Delete an Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/delete ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`** (Required)
+
+ID of the access code to delete.
+
+---
+
+**`device_id`**
+
+ID of the device for which to delete the access code.
+
+---
+
+
+## Response
+
+void
diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md
new file mode 100644
index 000000000..819f0c606
--- /dev/null
+++ b/docs/api/access_codes/get.md
@@ -0,0 +1,61 @@
+# Get an Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+You must specify either `access_code_id` or both `device_id` and `code`.
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/get ⇒ { access_code }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`**
+
+ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+
+---
+
+**`code`**
+
+Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+
+---
+
+**`device_id`**
+
+ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+
+---
+
+
+## Response
+
+[access\_code](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md
new file mode 100644
index 000000000..c6b599210
--- /dev/null
+++ b/docs/api/access_codes/list.md
@@ -0,0 +1,75 @@
+# List Access Codes
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+Specify either `device_id` or `access_code_ids`.
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/list ⇒ { access_codes: [access_code, …] }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_ids`** *of UUIDs*
+
+IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.
+
+---
+
+**`device_id`**
+
+ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.
+
+---
+
+**`limit`**
+
+Numerical limit on the number of access codes to return.
+
+---
+
+**`page_cursor`**
+
+Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+
+---
+
+**`user_identifier_key`**
+
+Your user ID for the user by which to filter access codes.
+
+---
+
+
+## Response
+
+Array of [access\_codes](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md
new file mode 100644
index 000000000..7cf759208
--- /dev/null
+++ b/docs/api/access_codes/pull_backup_access_code.md
@@ -0,0 +1,57 @@
+# Pull a Backup Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).
+
+A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.
+
+If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
+
+You can only pull backup access codes for time-bound access codes.
+
+Before pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/pull_backup_access_code ⇒ { access_code }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`** (Required)
+
+ID of the access code for which you want to pull a backup access code.
+
+---
+
+
+## Response
+
+[access\_code](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/report_device_constraints.md b/docs/api/access_codes/report_device_constraints.md
new file mode 100644
index 000000000..85e9fa6f8
--- /dev/null
+++ b/docs/api/access_codes/report_device_constraints.md
@@ -0,0 +1,58 @@
+# Report Device Access Code Constraints
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/report_device_constraints ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the device for which to report constraints.
+
+---
+
+**`max_code_length`**
+
+Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
+
+---
+
+**`min_code_length`**
+
+Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
+
+---
+
+**`supported_code_lengths`** *of Numbers*
+
+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`.
+
+---
+
+
+## Response
+
+void
diff --git a/docs/api/access_codes/simulate/README.md b/docs/api/access_codes/simulate/README.md
new file mode 100644
index 000000000..02bd1d359
--- /dev/null
+++ b/docs/api/access_codes/simulate/README.md
@@ -0,0 +1,10 @@
+# Access Code Simulations
+
+## Endpoints
+
+
+[**`/access_codes/simulate/create_unmanaged_access_code`**](./create_unmanaged_access_code.md)
+
+Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
+
diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md
new file mode 100644
index 000000000..e86e44d1f
--- /dev/null
+++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md
@@ -0,0 +1,61 @@
+# Simulate Creating an Unmanaged Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`code`** (Required)
+
+Code of the simulated unmanaged access code.
+
+---
+
+**`device_id`** (Required)
+
+ID of the device for which you want to simulate the creation of an unmanaged access code.
+
+---
+
+**`name`** (Required)
+
+Name of the simulated unmanaged access code.
+
+---
+
+
+## Response
+
+[unmanaged\_access\_code](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of unmanaged_access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md
new file mode 100644
index 000000000..c79f090ac
--- /dev/null
+++ b/docs/api/access_codes/unmanaged/README.md
@@ -0,0 +1,2699 @@
+# Unmanaged Access Code
+
+## The unmanaged_access_code Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
+
+Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+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.
+
+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.
+
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ access_code_id: [example value],
+ code: [example value],
+ created_at: [example value],
+ device_id: [example value],
+ ends_at: [example value],
+ errors: [example value],
+ is_managed: [example value],
+ name: [example value],
+ starts_at: [example value],
+ status: [example value],
+ type: [example value],
+ warnings: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
+
+**`access_code_id`** *UUID*
+
+Unique identifier for the access code.
+
+
+
+
+---
+
+**`code`** *String*
+
+Code used for access. Typically, a numeric or alphanumeric string.
+
+
+
+
+---
+
+**`created_at`** *Datetime*
+
+Date and time at which the access code was created.
+
+
+
+
+---
+
+**`device_id`** *UUID*
+
+Unique identifier for the device associated with the access code.
+
+
+
+
+---
+
+**`ends_at`** *Datetime*
+
+Date and time after which the time-bound access code becomes inactive.
+
+
+
+
+---
+
+[**`errors`**](./#errors) *List* *of Objects*
+
+Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+
+The specific structure of each object in this list depends on the value of its `error_code` field.
+
+Variants:
+
+smartthings_failed_to_set_access_code
+
+Failed to set code on SmartThings device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_failed_to_set_access_code
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+smartthings_failed_to_set_after_multiple_retries
+
+Failed to set code after multiple retries.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_failed_to_set_after_multiple_retries
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+smartthings_no_free_slots_available
+
+No free slots available on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_no_free_slots_available
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+failed_to_set_on_device
+
+Failed to set code on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - failed_to_set_on_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+failed_to_remove_from_device
+
+Failed to remove code from device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - failed_to_remove_from_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+duplicate_code_on_device
+
+Duplicate access code detected on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - duplicate_code_on_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+duplicate_code_attempt_prevented
+
+An attempt to modify this access code was prevented.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - duplicate_code_attempt_prevented
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+no_space_for_access_code_on_device
+
+No space for access code on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - no_space_for_access_code_on_device
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+igloohome_bridge_too_many_pending_jobs
+
+Igloohome bridge has too many pending jobs in the queue.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloohome_bridge_too_many_pending_jobs
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+igloohome_bridge_offline
+
+Igloohome bridge is offline.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloohome_bridge_offline
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+igloohome_offline_access_code_no_variance_available
+
+Lock has reached maximum amount of codes.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloohome_offline_access_code_no_variance_available
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+kwikset_unable_to_confirm_code
+
+Unable to confirm that the access code is set on Kwikset device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - kwikset_unable_to_confirm_code
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+kwikset_unable_to_confirm_deletion
+
+Unable to confirm the deletion of the access code on Kwikset device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - kwikset_unable_to_confirm_deletion
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+code_modified_external_to_seam
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - code_modified_external_to_seam
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_lock_invalid_code_length
+
+Invalid code length for August lock.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_invalid_code_length
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_device_programming_delay
+
+Access code has not yet been fully moved to the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_device_programming_delay
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_device_slots_full
+
+All access code slots on the device are full.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_device_slots_full
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_lock_missing_keypad
+
+August lock is missing a keypad.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_missing_keypad
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+august_lock_temporarily_offline
+
+August lock is temporarily offline.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_temporarily_offline
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+salto_ks_user_not_subscribed
+
+Salto site user is not subscribed.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - salto_ks_user_not_subscribed
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+hubitat_device_programming_delay
+
+Access code has not yet been fully moved to the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - hubitat_device_programming_delay
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+hubitat_no_free_positions_available
+
+No free positions available on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - hubitat_no_free_positions_available
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+wyze_duplicate_code_name
+
+Duplicate access code name detected.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - wyze_duplicate_code_name
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+wyze_potential_duplicate_code
+
+Potential duplicate access code detected.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - wyze_potential_duplicate_code
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+dormakaba_oracode_no_valid_user_level
+
+No valid user level for Oracode.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - dormakaba_oracode_no_valid_user_level
+
+
+
+ ---
+
+ **`is_access_code_error`** Format: `Boolean`
+
+
+ Indicates that this is an access code error.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+account_disconnected
+
+Account is disconnected
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - account_disconnected
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+salto_ks_subscription_limit_exceeded
+
+Salto site user limit reached.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - salto_ks_subscription_limit_exceeded
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+device_offline
+
+Device is offline
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - device_offline
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+device_removed
+
+Device has been removed
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - device_removed
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+hub_disconnected
+
+Hub is disconnected
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - hub_disconnected
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+device_disconnected
+
+Device is disconnected
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - device_disconnected
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+empty_backup_access_code_pool
+
+The backup access code pool is empty.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - empty_backup_access_code_pool
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+august_lock_not_authorized
+
+User is not authorized to use the August Lock.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_not_authorized
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+august_lock_missing_bridge
+
+Lock is not connected to the Seam Bridge.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_missing_bridge
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+ttlock_lock_not_paired_to_gateway
+
+Lock is not paired with a Gateway.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - ttlock_lock_not_paired_to_gateway
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+missing_device_credentials
+
+Missing device credentials.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - missing_device_credentials
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+auxiliary_heat_running
+
+The auxiliary heat is running.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - auxiliary_heat_running
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+subscription_required
+
+Subscription required to connect.
+
+ **`created_at`** Format: `Datetime`
+
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - subscription_required
+
+
+
+ ---
+
+ **`is_device_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+invalid_credentials
+
+Credentials provided were invalid.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - invalid_credentials
+
+
+
+ ---
+
+ **`is_bridge_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+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`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - bridge_disconnected
+
+
+
+ ---
+
+ **`is_bridge_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`is_connected_account_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+
+
+
+---
+
+**`is_managed`** *Boolean*
+
+Indicates that Seam does not manage the access code.
+
+
+
+
+---
+
+**`name`** *String*
+
+Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+
+
+
+
+---
+
+**`starts_at`** *Datetime*
+
+Date and time at which the time-bound access code becomes active.
+
+
+
+
+---
+
+**`status`** *Enum*
+
+Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.
+
+
+
+Enum values
+
+- set
+
+
+
+---
+
+**`type`** *Enum*
+
+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.
+
+
+
+Enum values
+
+- time_bound
+- ongoing
+
+
+
+---
+
+[**`warnings`**](./#warnings) *List* *of Objects*
+
+Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+
+
+The specific structure of each object in this list depends on the value of its `warning_code` field.
+
+Variants:
+
+smartthings_failed_to_set_access_code
+
+Failed to set code on SmartThings device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - smartthings_failed_to_set_access_code
+
+
+
+
+
+schlage_detected_duplicate
+
+Duplicate access code detected.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - schlage_detected_duplicate
+
+
+
+
+
+schlage_creation_outage
+
+Received an error when attempting to create this code.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - schlage_creation_outage
+
+
+
+
+
+code_modified_external_to_seam
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - code_modified_external_to_seam
+
+
+
+
+
+delay_in_setting_on_device
+
+Delay in setting code on device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - delay_in_setting_on_device
+
+
+
+
+
+delay_in_removing_from_device
+
+Delay in removing code from device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - delay_in_removing_from_device
+
+
+
+
+
+third_party_integration_detected
+
+Third-party integration detected that may cause access codes to fail.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - third_party_integration_detected
+
+
+
+
+
+august_device_programming_delay
+
+Access code has not yet been fully moved to the device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_device_programming_delay
+
+
+
+
+
+august_lock_temporarily_offline
+
+August lock is temporarily offline.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - august_lock_temporarily_offline
+
+
+
+
+
+igloo_algopin_must_be_used_within_24_hours
+
+Algopins must be used within 24 hours.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - igloo_algopin_must_be_used_within_24_hours
+
+
+
+
+
+management_transferred
+
+Management was transferred to another workspace.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - management_transferred
+
+
+
+
+
+kwikset_unable_to_confirm_code
+
+Unable to confirm that the access code is set on Kwikset device.
+
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - kwikset_unable_to_confirm_code
+
+
+
+
+
+---
+
+
+## Errors
+
+**`smartthings_failed_to_set_access_code`**
+
+Failed to set code on SmartThings device.
+
+---
+
+**`smartthings_failed_to_set_after_multiple_retries`**
+
+Failed to set code after multiple retries.
+
+---
+
+**`smartthings_no_free_slots_available`**
+
+No free slots available on the device.
+
+---
+
+**`failed_to_set_on_device`**
+
+Failed to set code on device.
+
+---
+
+**`failed_to_remove_from_device`**
+
+Failed to remove code from device.
+
+---
+
+**`duplicate_code_on_device`**
+
+Duplicate access code detected on device.
+
+---
+
+**`duplicate_code_attempt_prevented`**
+
+An attempt to modify this access code was prevented.
+
+---
+
+**`no_space_for_access_code_on_device`**
+
+No space for access code on device.
+
+---
+
+**`igloohome_bridge_too_many_pending_jobs`**
+
+Igloohome bridge has too many pending jobs in the queue.
+
+---
+
+**`igloohome_bridge_offline`**
+
+Igloohome bridge is offline.
+
+---
+
+**`igloohome_offline_access_code_no_variance_available`**
+
+Lock has reached maximum amount of codes.
+
+---
+
+**`kwikset_unable_to_confirm_code`**
+
+Unable to confirm that the access code is set on Kwikset device.
+
+---
+
+**`kwikset_unable_to_confirm_deletion`**
+
+Unable to confirm the deletion of the access code on Kwikset device.
+
+---
+
+**`code_modified_external_to_seam`**
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+---
+
+**`august_lock_invalid_code_length`**
+
+Invalid code length for August lock.
+
+---
+
+**`august_device_programming_delay`**
+
+Access code has not yet been fully moved to the device.
+
+---
+
+**`august_device_slots_full`**
+
+All access code slots on the device are full.
+
+---
+
+**`august_lock_missing_keypad`**
+
+August lock is missing a keypad.
+
+---
+
+**`august_lock_temporarily_offline`**
+
+August lock is temporarily offline.
+
+---
+
+**`salto_ks_user_not_subscribed`**
+
+Salto site user is not subscribed.
+
+---
+
+**`hubitat_device_programming_delay`**
+
+Access code has not yet been fully moved to the device.
+
+---
+
+**`hubitat_no_free_positions_available`**
+
+No free positions available on the device.
+
+---
+
+**`wyze_duplicate_code_name`**
+
+Duplicate access code name detected.
+
+---
+
+**`wyze_potential_duplicate_code`**
+
+Potential duplicate access code detected.
+
+---
+
+**`dormakaba_oracode_no_valid_user_level`**
+
+No valid user level for Oracode.
+
+---
+
+**`account_disconnected`**
+
+Account is disconnected
+
+---
+
+**`salto_ks_subscription_limit_exceeded`**
+
+Salto site user limit reached.
+
+---
+
+**`device_offline`**
+
+Device is offline
+
+---
+
+**`device_removed`**
+
+Device has been removed
+
+---
+
+**`hub_disconnected`**
+
+Hub is disconnected
+
+---
+
+**`device_disconnected`**
+
+Device is disconnected
+
+---
+
+**`empty_backup_access_code_pool`**
+
+The backup access code pool is empty.
+
+---
+
+**`august_lock_not_authorized`**
+
+User is not authorized to use the August Lock.
+
+---
+
+**`august_lock_missing_bridge`**
+
+Lock is not connected to the Seam Bridge.
+
+---
+
+**`ttlock_lock_not_paired_to_gateway`**
+
+Lock is not paired with a Gateway.
+
+---
+
+**`missing_device_credentials`**
+
+Missing device credentials.
+
+---
+
+**`auxiliary_heat_running`**
+
+The auxiliary heat is running.
+
+---
+
+**`subscription_required`**
+
+Subscription required to connect.
+
+---
+
+**`invalid_credentials`**
+
+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).
+
+---
+
+
+## Warnings
+
+**`smartthings_failed_to_set_access_code`**
+
+Failed to set code on SmartThings device.
+
+---
+
+**`schlage_detected_duplicate`**
+
+Duplicate access code detected.
+
+---
+
+**`schlage_creation_outage`**
+
+Received an error when attempting to create this code.
+
+---
+
+**`code_modified_external_to_seam`**
+
+Code was modified or removed externally after Seam successfully set it on the device.
+
+---
+
+**`delay_in_setting_on_device`**
+
+Delay in setting code on device.
+
+---
+
+**`delay_in_removing_from_device`**
+
+Delay in removing code from device.
+
+---
+
+**`third_party_integration_detected`**
+
+Third-party integration detected that may cause access codes to fail.
+
+---
+
+**`august_device_programming_delay`**
+
+Access code has not yet been fully moved to the device.
+
+---
+
+**`august_lock_temporarily_offline`**
+
+August lock is temporarily offline.
+
+---
+
+**`igloo_algopin_must_be_used_within_24_hours`**
+
+Algopins must be used within 24 hours.
+
+---
+
+**`management_transferred`**
+
+Management was transferred to another workspace.
+
+---
+
+**`kwikset_unable_to_confirm_code`**
+
+Unable to confirm that the access code is set on Kwikset device.
+
+---
+
+
+## Events
+
+**`access_code.unmanaged.converted_to_managed`**
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.unmanaged.converted_to_managed`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.unmanaged.failed_to_convert_to_managed`**
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.unmanaged.failed_to_convert_to_managed`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.unmanaged.created`**
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.unmanaged.created`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+**`access_code.unmanaged.removed`**
+
+An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.
+
+
+
+Properties
+
+- access_code_id UUID
+
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+- connected_account_id UUID
+
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
+
+- created_at Datetime
+
+ Date and time at which the event was created.
+
+
+- device_id UUID
+
+ ID of the [device](../../../core-concepts/devices/README.md).
+
+
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `access_code.unmanaged.removed`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
+
+
+---
+
+## Endpoints
+
+
+[**`/access_codes/unmanaged/convert_to_managed`**](./convert_to_managed.md)
+
+Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+
+[**`/access_codes/unmanaged/delete`**](./delete.md)
+
+Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+
+[**`/access_codes/unmanaged/get`**](./get.md)
+
+Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+
+[**`/access_codes/unmanaged/list`**](./list.md)
+
+Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+
+[**`/access_codes/unmanaged/update`**](./update.md)
+
+Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+
diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md
new file mode 100644
index 000000000..2314f72ea
--- /dev/null
+++ b/docs/api/access_codes/unmanaged/convert_to_managed.md
@@ -0,0 +1,62 @@
+# Convert an Unmanaged Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
+
+Note that not all device providers support converting an unmanaged access code to a managed access code.
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+PATCH /access_codes/unmanaged/convert_to_managed ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`** (Required)
+
+ID of the unmanaged access code that you want to convert to a managed access code.
+
+---
+
+**`allow_external_modification`**
+
+Indicates whether external modification of the access code is allowed.
+
+---
+
+**`force`**
+
+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`.
+
+---
+
+**`is_external_modification_allowed`**
+
+Indicates whether external modification of the access code is allowed.
+
+---
+
+
+## Response
+
+void
diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md
new file mode 100644
index 000000000..a638874c7
--- /dev/null
+++ b/docs/api/access_codes/unmanaged/delete.md
@@ -0,0 +1,40 @@
+# Delete an Unmanaged Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/unmanaged/delete ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`** (Required)
+
+ID of the unmanaged access code to delete.
+
+---
+
+
+## Response
+
+void
diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md
new file mode 100644
index 000000000..a5dcf9cec
--- /dev/null
+++ b/docs/api/access_codes/unmanaged/get.md
@@ -0,0 +1,63 @@
+# Get an Unmanaged Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+You must specify either `access_code_id` or both `device_id` and `code`.
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/unmanaged/get ⇒ { access_code }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`**
+
+ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+
+---
+
+**`code`**
+
+Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+
+---
+
+**`device_id`**
+
+ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+
+---
+
+
+## Response
+
+[unmanaged\_access\_code](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of unmanaged_access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md
new file mode 100644
index 000000000..f8c505965
--- /dev/null
+++ b/docs/api/access_codes/unmanaged/list.md
@@ -0,0 +1,55 @@
+# List Unmanaged Access Codes
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code, …] }
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the device for which you want to list unmanaged access codes.
+
+---
+
+**`user_identifier_key`**
+
+Your user ID for the user by which to filter unmanaged access codes.
+
+---
+
+
+## Response
+
+Array of [unmanaged\_access\_codes](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of unmanaged_access_code
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md
new file mode 100644
index 000000000..bc624f0de
--- /dev/null
+++ b/docs/api/access_codes/unmanaged/update.md
@@ -0,0 +1,62 @@
+# Update an Unmanaged Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+PATCH /access_codes/unmanaged/update ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`** (Required)
+
+ID of the unmanaged access code that you want to update.
+
+---
+
+**`is_managed`** (Required)
+
+---
+
+**`allow_external_modification`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.
+
+---
+
+**`force`**
+
+Indicates whether to force the unmanaged access code update.
+
+---
+
+**`is_external_modification_allowed`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.
+
+---
+
+
+## Response
+
+void
diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md
new file mode 100644
index 000000000..e6fe40a91
--- /dev/null
+++ b/docs/api/access_codes/update.md
@@ -0,0 +1,140 @@
+# Update an Access Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
+See also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+PUT /access_codes/update ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_code_id`** (Required)
+
+ID of the access code that you want to update.
+
+---
+
+**`allow_external_modification`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+
+---
+
+**`attempt_for_offline_device`**
+
+---
+
+**`code`**
+
+Code to be used for access.
+
+---
+
+**`device_id`**
+
+ID of the device containing the access code that you want to update.
+
+---
+
+**`ends_at`**
+
+Date and time at which the validity of the new access code 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 `starts_at`.
+
+---
+
+**`is_external_modification_allowed`**
+
+Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
+
+---
+
+**`is_managed`**
+
+Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.
+
+---
+
+**`is_offline_access_code`**
+
+Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
+
+---
+
+**`is_one_time_use`**
+
+Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+
+---
+
+**`max_time_rounding`**
+
+Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+
+---
+
+**`name`**
+
+Name of the new access code.
+
+---
+
+**`prefer_native_scheduling`**
+
+Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+
+---
+
+**`preferred_code_length`**
+
+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.
+
+---
+
+**`starts_at`**
+
+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.
+
+---
+
+**`type`**
+
+Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
+
+---
+
+**`use_backup_access_code_pool`**
+
+Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md).
+
+---
+
+**`use_offline_access_code`**
+
+---
+
+
+## Response
+
+void
diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md
new file mode 100644
index 000000000..1f4f7fabc
--- /dev/null
+++ b/docs/api/access_codes/update_multiple.md
@@ -0,0 +1,62 @@
+# Update Multiple Linked Access Codes
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
+
+Specify the `common_code_key` to identify the set of access codes that you want to update.
+
+See also [Update Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md#update-linked-access-codes).
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+PATCH /access_codes/update_multiple ⇒ void
+```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`common_code_key`** (Required)
+
+Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.
+
+---
+
+**`ends_at`**
+
+Date and time at which the validity of the new access code 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 `starts_at`.
+
+---
+
+**`name`**
+
+Name of the new access code.
+
+---
+
+**`starts_at`**
+
+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.
+
+---
+
+
+## Response
+
+void
diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md
index da76448fa..f7f0c9bc9 100644
--- a/docs/api/acs/README.md
+++ b/docs/api/acs/README.md
@@ -2,7 +2,7 @@
description: Systems for managing and monitoring access to physical spaces
---
-# Access Control Systems
+# Access Control Systems (ACS)
Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements:
@@ -21,6 +21,8 @@ To grant access using the Seam access control system API, use the following basi
## Resources
+The Access Control Systems (ACS) namespace contains the following resources:
+
### [`acs_system`](./systems/README.md#acs_system)
Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -28,6 +30,7 @@ Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs
For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).
+---
### [`acs_user`](./users/README.md#acs_user)
Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -35,11 +38,13 @@ An `acs_user` typically refers to an individual who requires access, like an emp
For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems).
+---
### [`acs_entrance`](./entrances/README.md#acs_entrance)
Represents an [entrance](../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
+---
### [`acs_access_group`](./access_groups/README.md#acs_access_group)
Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
@@ -47,6 +52,7 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab
To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems).
+---
### [`acs_credential`](./credentials/README.md#acs_credential)
Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -54,6 +60,7 @@ An access control system generally uses digital means of access to authorize a u
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
+---
### [`acs_encoder`](./encoders/README.md#acs_encoder)
Represents a hardware device that encodes [credential](../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -70,3 +77,4 @@ Separately, the Seam API also supports card scanning, which enables you to scan
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems).
+---
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
index 7431bca8c..b6ca6cb2e 100644
--- a/docs/api/acs/access_groups/README.md
+++ b/docs/api/acs/access_groups/README.md
@@ -1,6 +1,13 @@
# Access Groups
-## `acs_access_group`
+## The acs_access_group Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
@@ -8,218 +15,259 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab
To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems).
-### `access_group_type`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ access_group_type: [example value],
+ access_group_type_display_name: [example value],
+ acs_access_group_id: [example value],
+ acs_system_id: [example value],
+ created_at: [example value],
+ display_name: [example value],
+ external_type: [example value],
+ external_type_display_name: [example value],
+ is_managed: [example value],
+ name: [example value],
+ warnings: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
+
+**`access_group_type`** *Enum*
+
{% hint style="warning" %}
**Deprecated**. Use `external_type`.
{% endhint %}
-Format: `Enum`
+
+Enum values
+
+- pti_unit
+- pti_access_level
+- salto_ks_access_group
+- brivo_group
+- salto_space_group
+- dormakaba_community_access_group
+
-Possible enum values:
-- `pti_unit`
-- `pti_access_level`
-- `salto_ks_access_group`
-- `brivo_group`
-- `salto_space_group`
-- `dormakaba_community_access_group`
---
-### `access_group_type_display_name`
+**`access_group_type_display_name`** *String*
+
{% hint style="warning" %}
**Deprecated**. Use `external_type_display_name`.
{% endhint %}
-Format: `String`
----
-### `acs_access_group_id`
+---
-Format: `UUID`
+**`acs_access_group_id`** *UUID*
ID of the access group.
----
-### `acs_system_id`
-Format: `UUID`
+
+---
+
+**`acs_system_id`** *UUID*
ID of the access control system that contains the access group.
----
-### `created_at`
-Format: `Datetime`
+
+---
+
+**`created_at`** *Datetime*
Date and time at which the access group was created.
----
-### `display_name`
-Format: `String`
---
-### `external_type`
+**`display_name`** *String*
+
-Format: `Enum`
-Brand-specific terminology for the access group type.
-Possible enum values:
-- `pti_unit`
-- `pti_access_level`
-- `salto_ks_access_group`
-- `brivo_group`
-- `salto_space_group`
-- `dormakaba_community_access_group`
---
-### `external_type_display_name`
+**`external_type`** *Enum*
-Format: `String`
+Brand-specific terminology for the access group type.
+
+
+
+Enum values
+
+- pti_unit
+- pti_access_level
+- salto_ks_access_group
+- brivo_group
+- salto_space_group
+- dormakaba_community_access_group
+
-Display name that corresponds to the brand-specific terminology for the access group type.
---
-### `is_managed`
+**`external_type_display_name`** *String*
+
+Display name that corresponds to the brand-specific terminology for the access group type.
+
+
-Format: `Boolean`
---
-### `name`
+**`is_managed`** *Boolean*
+
+
-Format: `String`
-Name of the access group.
---
-### `warnings`
+**`name`** *String*
+
+Name of the access group.
+
+
+
-Format: `List`
+---
-Item format: `Object`
+**`warnings`** *List* *of Objects*
Warnings associated with the `acs_access_group`.
-
-created_at Format: Datetime
-Date and time at which Seam created the warning.
+
+ Child Object Properties
+ created_at Datetime
+
+ Date and time at which Seam created the warning.
+ message String
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+ warning_code Enum
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - unknown_issue_with_acs_access_group`
+
-
+---
-message Format: String
+**`workspace_id`** *UUID*
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group.
+
+
+
+
+---
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
+
+## Events
+
+**`acs_access_group.deleted`**
+
+An ACS access group was deleted.
-warning_code Format: Enum
+Properties
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+- acs_access_group_id UUID
-Possible enum values:
-- `unknown_issue_with_acs_access_group`
-
----
+- acs_system_id UUID
-### `workspace_id`
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-Format: `UUID`
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group.
+- connected_account_id UUID
----
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-## Endpoints
-### [`/acs/access_groups/add_user`](./add_user.md)
+- created_at Datetime
-Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/access_groups/get`](./get.md)
+ Date and time at which the event was created.
-Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/access_groups/list`](./list.md)
-Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/access_groups/list_accessible_entrances`](./list_accessible_entrances.md)
+- event_id UUID
-Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/access_groups/list_users`](./list_users.md)
+ ID of the event.
-Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/access_groups/remove_user`](./remove_user.md)
-Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+- event_type Enum
----
+ Value: `acs_access_group.deleted`
-## Events
-### `acs_access_group.deleted`
+- occurred_at Datetime
-An ACS access group was deleted.
+ Date and time at which the event occurred.
-
-acs_access_group_id Format: UUID
-
-
+- workspace_id UUID
-acs_system_id Format: UUID
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-connected_account_id Format: UUID
+---
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+## Endpoints
-created_at Format: Datetime
-Date and time at which the event was created.
-
-
+[**`/acs/access_groups/add_user`**](./add_user.md)
-event_id Format: UUID
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-ID of the event.
-
-
-event_type Format: Enum
+[**`/acs/access_groups/get`**](./get.md)
-Value: `acs_access_group.deleted`
-
-
+Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-occurred_at Format: Datetime
-Date and time at which the event occurred.
-
-
+[**`/acs/access_groups/list`**](./list.md)
-workspace_id Format: UUID
+Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+[**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md)
+
+Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+[**`/acs/access_groups/list_users`**](./list_users.md)
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+[**`/acs/access_groups/remove_user`**](./remove_user.md)
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md
index 501c51d48..a66854f77 100644
--- a/docs/api/acs/access_groups/add_user.md
+++ b/docs/api/acs/access_groups/add_user.md
@@ -1,14 +1,60 @@
# Add an ACS User to an Access Group
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PUT /acs/access_groups/add_user ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_access_group_id`** (Required)
+
+ID of the desired access group.
+
+---
+
+**`acs_user_id`** (Required)
+
+ID of the desired user.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Add an ACS user to an access group
+
+Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.accessGroups.addUser({
@@ -17,7 +63,7 @@ await seam.acs.accessGroups.addUser({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.acs.accessGroups.addUser({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.access_groups.add_user(
@@ -34,7 +80,7 @@ seam.acs.access_groups.add_user(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.access_groups.add_user(
@@ -51,7 +97,7 @@ seam.acs.access_groups.add_user(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->access_groups->add_user(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-4
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +156,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,32 +165,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_access_group_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired access group.
-
-***
-
-### `acs_user_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md
index 7e21c8a88..f5c347664 100644
--- a/docs/api/acs/access_groups/get.md
+++ b/docs/api/acs/access_groups/get.md
@@ -1,14 +1,63 @@
# Get an Access Group
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/access_groups/get ⇒ { acs_access_group }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_access_group_id`** (Required)
+
+ID of the desired access group.
+
+---
+
+
+## Response
+
+[acs\_access\_group](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_access_group
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get a specific access group
+
+Specify the `acs_access_group_id` of the access group that you want to retrieve.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.accessGroups.get({
@@ -16,7 +65,7 @@ await seam.acs.accessGroups.get({
});
```
-#### Response
+#### Output
```javascript
{
@@ -35,13 +84,13 @@ await seam.acs.accessGroups.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444")
```
-#### Response
+#### Output
```python
AcsAccessGroup(
@@ -60,13 +109,13 @@ AcsAccessGroup(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444")
```
-#### Response
+#### Output
```ruby
{
@@ -85,7 +134,7 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->access_groups->get(
);
```
-#### Response
+#### Output
```php
acs->access_groups->get(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444"
```
-#### Response
+#### Output
```seam_cli
{
@@ -139,7 +188,7 @@ seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -157,7 +206,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}
@@ -166,23 +215,4 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_access_group_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired access group.
-
-***
-
-## Return Type
-
-[acs\_access\_group](./)
diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md
index e87851e0b..ab7ac84c5 100644
--- a/docs/api/acs/access_groups/list.md
+++ b/docs/api/acs/access_groups/list.md
@@ -1,14 +1,69 @@
# List Access Groups
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_system_id`**
+
+ID of the access control system for which you want to retrieve all access groups.
+
+---
+
+**`acs_user_id`**
+
+ID of the user for which you want to retrieve all access groups.
+
+---
+
+
+## Response
+
+Array of [acs\_access\_groups](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_access_group
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List access groups
+
+To filter the list of access groups, include an `acs_system_id` or `acs_user_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.accessGroups.list({
@@ -17,7 +72,7 @@ await seam.acs.accessGroups.list({
});
```
-#### Response
+#### Output
```javascript
[
@@ -38,7 +93,7 @@ await seam.acs.accessGroups.list({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.access_groups.list(
@@ -47,7 +102,7 @@ seam.acs.access_groups.list(
)
```
-#### Response
+#### Output
```python
[
@@ -68,7 +123,7 @@ seam.acs.access_groups.list(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.access_groups.list(
@@ -77,7 +132,7 @@ seam.acs.access_groups.list(
)
```
-#### Response
+#### Output
```ruby
[
@@ -98,7 +153,7 @@ seam.acs.access_groups.list(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->access_groups->list(
);
```
-#### Response
+#### Output
```php
acs->access_groups->list(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333"
```
-#### Response
+#### Output
```seam_cli
[
@@ -157,7 +212,7 @@ seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-11111111111
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -176,7 +231,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}}
@@ -185,32 +240,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_system_id`
-
-Format: `UUID`
-Required: No
-
-ID of the access control system for which you want to retrieve all access groups.
-
-***
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: No
-
-ID of the user for which you want to retrieve all access groups.
-
-***
-
-## Return Type
-Array<[acs\_access\_group](./)>
diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md
index 6dd2272fc..0270ad214 100644
--- a/docs/api/acs/access_groups/list_accessible_entrances.md
+++ b/docs/api/acs/access_groups/list_accessible_entrances.md
@@ -1,14 +1,63 @@
# List Entrances Accessible to an Access Group
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_access_group_id`** (Required)
+
+ID of the access group for which you want to retrieve all accessible entrances.
+
+---
+
+
+## Response
+
+Array of [acs\_entrances](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_entrance
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List accessible entrances for an access group
+
+Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.accessGroups.listAccessibleEntrances({
@@ -16,7 +65,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({
});
```
-#### Response
+#### Output
```javascript
[
@@ -33,7 +82,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.access_groups.list_accessible_entrances(
@@ -41,7 +90,7 @@ seam.acs.access_groups.list_accessible_entrances(
)
```
-#### Response
+#### Output
```python
[
@@ -58,7 +107,7 @@ seam.acs.access_groups.list_accessible_entrances(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.access_groups.list_accessible_entrances(
@@ -66,7 +115,7 @@ seam.acs.access_groups.list_accessible_entrances(
)
```
-#### Response
+#### Output
```ruby
[
@@ -83,7 +132,7 @@ seam.acs.access_groups.list_accessible_entrances(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->access_groups->list_accessible_entrances(
);
```
-#### Response
+#### Output
```php
acs->access_groups->list_accessible_entrances(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444"
```
-#### Response
+#### Output
```seam_cli
[
@@ -133,7 +182,7 @@ seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -151,7 +200,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}}
@@ -160,23 +209,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_access_group_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the access group for which you want to retrieve all accessible entrances.
-
-***
-
-## Return Type
-Array<[acs\_entrance](./)>
diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md
index bbe8bc286..3dbeadb42 100644
--- a/docs/api/acs/access_groups/list_users.md
+++ b/docs/api/acs/access_groups/list_users.md
@@ -1,14 +1,63 @@
# List ACS Users in an Access Group
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_access_group_id`** (Required)
+
+ID of the access group for which you want to retrieve all users.
+
+---
+
+
+## Response
+
+Array of [acs\_users](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_user
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List ACS users in an access group
+
+Specify the `acs_access_group_id` to retrieve all ACS users in an access group.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.accessGroups.listUsers({
@@ -16,7 +65,7 @@ await seam.acs.accessGroups.listUsers({
});
```
-#### Response
+#### Output
```javascript
[
@@ -45,7 +94,7 @@ await seam.acs.accessGroups.listUsers({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.access_groups.list_users(
@@ -53,7 +102,7 @@ seam.acs.access_groups.list_users(
)
```
-#### Response
+#### Output
```python
[
@@ -82,13 +131,13 @@ seam.acs.access_groups.list_users(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444")
```
-#### Response
+#### Output
```ruby
[
@@ -117,7 +166,7 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->access_groups->list_users(
);
```
-#### Response
+#### Output
```php
acs->access_groups->list_users(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444"
```
-#### Response
+#### Output
```seam_cli
[
@@ -191,7 +240,7 @@ seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -209,7 +258,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}}
@@ -218,23 +267,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_access_group_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the access group for which you want to retrieve all users.
-
-***
-
-## Return Type
-Array<[acs\_user](./)>
diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md
index 1d9e19bb7..bbc51a3e9 100644
--- a/docs/api/acs/access_groups/remove_user.md
+++ b/docs/api/acs/access_groups/remove_user.md
@@ -1,14 +1,60 @@
# Remove an ACS User from an Access Group
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/access_groups/remove_user ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_access_group_id`** (Required)
+
+ID of the desired access group.
+
+---
+
+**`acs_user_id`** (Required)
+
+ID of the desired user.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Remove an ACS user from an access group
+
+Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.accessGroups.removeUser({
@@ -17,7 +63,7 @@ await seam.acs.accessGroups.removeUser({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.acs.accessGroups.removeUser({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.access_groups.remove_user(
@@ -34,7 +80,7 @@ seam.acs.access_groups.remove_user(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.access_groups.remove_user(
@@ -51,7 +97,7 @@ seam.acs.access_groups.remove_user(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->access_groups->remove_user(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-444
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +156,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,32 +165,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_access_group_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired access group.
-
-***
-
-### `acs_user_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
index 250685b03..c230fd6de 100644
--- a/docs/api/acs/credentials/README.md
+++ b/docs/api/acs/credentials/README.md
@@ -1,6 +1,13 @@
# Credentials
-## `acs_credential`
+## The acs_credential Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -8,302 +15,330 @@ An access control system generally uses digital means of access to authorize a u
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
-### `access_method`
-
-Format: `Enum`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ access_method: [example value],
+ acs_credential_id: [example value],
+ acs_credential_pool_id: [example value],
+ acs_system_id: [example value],
+ acs_user_id: [example value],
+ assa_abloy_vostio_metadata: [example value],
+ card_number: [example value],
+ code: [example value],
+ created_at: [example value],
+ display_name: [example value],
+ ends_at: [example value],
+ errors: [example value],
+ external_type: [example value],
+ external_type_display_name: [example value],
+ is_issued: [example value],
+ is_latest_desired_state_synced_with_provider: [example value],
+ is_managed: [example value],
+ is_multi_phone_sync_credential: [example value],
+ is_one_time_use: [example value],
+ issued_at: [example value],
+ latest_desired_state_synced_with_provider_at: [example value],
+ parent_acs_credential_id: [example value],
+ starts_at: [example value],
+ visionline_metadata: [example value],
+ warnings: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
+
+**`access_method`** *Enum*
Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
----
+
+Enum values
+
+- code
+- card
+- mobile_key
+
-### `acs_credential_id`
-Format: `UUID`
+---
+
+**`acs_credential_id`** *UUID*
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-### `acs_credential_pool_id`
-Format: `UUID`
---
-### `acs_system_id`
+**`acs_credential_pool_id`** *UUID*
+
+
-Format: `UUID`
-ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
---
-### `acs_user_id`
+**`acs_system_id`** *UUID*
+
+ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
-Format: `UUID`
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
---
-### `assa_abloy_vostio_metadata`
+**`acs_user_id`** *UUID*
-Format: `Object`
+ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-auto_join Format: Boolean
-
-
+---
-door_names Format: List Item format: String
-
+**`assa_abloy_vostio_metadata`** *Object*
+
+Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-endpoint_id Format: String
-
+ Child Properties
-key_id Format: String
-
+ - auto_join Boolean
-
+ - door_names List of Strings
-key_issuing_request_id Format: String
-
+ - endpoint_id String
-
+ - key_id String
+
+ - key_issuing_request_id String
+
+ - override_guest_acs_entrance_ids List of Strings
-override_guest_acs_entrance_ids Format: List Item format: String
---
-### `card_number`
-
-Format: `String`
+**`card_number`** *String*
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-### `code`
-Format: `String`
+
+---
+
+**`code`** *String*
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
----
-### `created_at`
-Format: `Datetime`
+
+---
+
+**`created_at`** *Datetime*
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
----
-### `display_name`
-Format: `String`
+
+---
+
+**`display_name`** *String*
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
----
-### `ends_at`
-Format: `String`
+
+---
+
+**`ends_at`** *String*
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity 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 `starts_at`.
----
-### `errors`
-Format: `List`
-Item format: `Object`
+---
+
+**`errors`** *List* *of Objects*
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-error_code Format: String
-
-
-message Format: String
+ Child Object Properties
+ error_code String
+ message String
---
-### `external_type`
-
-Format: `Enum`
+**`external_type`** *Enum*
Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
-Possible enum values:
-- `pti_card`
-- `brivo_credential`
-- `hid_credential`
-- `visionline_card`
-- `salto_ks_credential`
-- `assa_abloy_vostio_key`
-- `salto_space_key`
-- `latch_access`
----
+
+Enum values
-### `external_type_display_name`
+- pti_card
+- brivo_credential
+- hid_credential
+- visionline_card
+- salto_ks_credential
+- assa_abloy_vostio_key
+- salto_space_key
+- latch_access
+
-Format: `String`
+
+---
+
+**`external_type_display_name`** *String*
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
----
-### `is_issued`
-Format: `Boolean`
+
+---
+
+**`is_issued`** *Boolean*
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
----
-### `is_latest_desired_state_synced_with_provider`
-Format: `Boolean`
+
+---
+
+**`is_latest_desired_state_synced_with_provider`** *Boolean*
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
----
-### `is_managed`
-Format: `Boolean`
---
-### `is_multi_phone_sync_credential`
+**`is_managed`** *Boolean*
+
+
-Format: `Boolean`
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
---
-### `is_one_time_use`
+**`is_multi_phone_sync_credential`** *Boolean*
+
+Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
-Format: `Boolean`
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
---
-### `issued_at`
+**`is_one_time_use`** *Boolean*
+
+Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
+
-Format: `Datetime`
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
---
-### `latest_desired_state_synced_with_provider_at`
+**`issued_at`** *Datetime*
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
+
-Format: `Datetime`
-Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
---
-### `parent_acs_credential_id`
+**`latest_desired_state_synced_with_provider_at`** *Datetime*
+
+Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
+
-Format: `UUID`
-ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
---
-### `starts_at`
+**`parent_acs_credential_id`** *UUID*
+
+ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
-Format: `String`
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
---
-### `visionline_metadata`
+**`starts_at`** *String*
-Format: `Object`
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-auto_join Format: Boolean
-
-
+---
-card_function_type Format: Enum
+**`visionline_metadata`** *Object*
-Possible enum values:
-- `guest`
-- `staff`
-
+Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-card_id Format: String
-
+ Child Properties
-common_acs_entrance_ids Format: List Item format: UUID
-
+ - auto_join Boolean
+ - card_function_type Enum
+ Enum values:
-credential_id Format: String
+ - guest`
+ - staff`
-
+ - card_id String
-guest_acs_entrance_ids Format: List Item format: UUID
-
+ - common_acs_entrance_ids List of UUIDs
-
+ - credential_id String
-is_valid Format: Boolean
-
+ - guest_acs_entrance_ids List of UUIDs
-
+ - is_valid Boolean
+
+ - joiner_acs_credential_ids List of UUIDs
-joiner_acs_credential_ids Format: List Item format: UUID
---
-### [`warnings`](./#warnings-1)
+[**`warnings`**](./#warnings) *List* *of Objects*
+
+Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-Format: `List`
-Item format: `Object`
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
The specific structure of each object in this list depends on the value of its `warning_code` field.
@@ -313,472 +348,489 @@ Variants:
Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the warning.
-
----
-
-**`message`**
-Format: `String`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - waiting_to_be_issued
+
+
+
+
+
+schedule_externally_modified
+Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - schedule_externally_modified
+
+
+
+
+
+schedule_modified
----
+Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past.
-**`warning_code`**
-Format: `Enum`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - schedule_modified
+
+
+
+
+
+being_deleted
+Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - being_deleted
+
+
+
+
+
+unknown_issue_with_acs_credential
-Possible enum values:
-- `waiting_to_be_issued`
+An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - unknown_issue_with_acs_credential
+
+
+
-schedule_externally_modified
+needs_to_be_reissued
-Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
+Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential.
-**`created_at`**
-Format: `Datetime`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
-Date and time at which Seam created the warning.
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - needs_to_be_reissued
+
+
+
+
---
-**`message`**
-Format: `String`
-
-
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+**`workspace_id`** *UUID*
----
-
-**`warning_code`**
-Format: `Enum`
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `schedule_externally_modified`
-
-
-schedule_modified
+---
-Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past.
-**`created_at`**
-Format: `Datetime`
+## Warnings
+**`waiting_to_be_issued`**
-Date and time at which Seam created the warning.
+Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
---
-**`message`**
-Format: `String`
-
+**`schedule_externally_modified`**
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
---
-**`warning_code`**
-Format: `Enum`
+**`schedule_modified`**
+Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past.
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
-Possible enum values:
-- `schedule_modified`
+---
-
-
-being_deleted
+**`being_deleted`**
Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.
-**`created_at`**
-Format: `Datetime`
+---
+**`unknown_issue_with_acs_credential`**
-Date and time at which Seam created the warning.
+An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential.
---
-**`message`**
-Format: `String`
-
+**`needs_to_be_reissued`**
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential.
---
-**`warning_code`**
-Format: `Enum`
+## Events
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+**`acs_credential.deleted`**
-Possible enum values:
-- `being_deleted`
+An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted.
-
-unknown_issue_with_acs_credential
-An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential.
+Properties
-**`created_at`**
-Format: `Datetime`
+- acs_credential_id UUID
-Date and time at which Seam created the warning.
+- acs_system_id UUID
----
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-**`message`**
-Format: `String`
+- connected_account_id UUID
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
----
-**`warning_code`**
-Format: `Enum`
+- created_at Datetime
+ Date and time at which the event was created.
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `unknown_issue_with_acs_credential`
+- event_id UUID
-
-
-needs_to_be_reissued
+ ID of the event.
-Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential.
-**`created_at`**
-Format: `Datetime`
+- event_type Enum
+ Value: `acs_credential.deleted`
-Date and time at which Seam created the warning.
----
+- occurred_at Datetime
-**`message`**
-Format: `String`
+ Date and time at which the event occurred.
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+- workspace_id UUID
----
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-**`warning_code`**
-Format: `Enum`
+
+---
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+**`acs_credential.issued`**
-Possible enum values:
-- `needs_to_be_reissued`
+An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was issued.
-
+
----
+Properties
-### `workspace_id`
+- acs_credential_id UUID
-Format: `UUID`
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+- acs_system_id UUID
----
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-## Warnings
-### `waiting_to_be_issued`
+- connected_account_id UUID
-Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
----
-### `schedule_externally_modified`
+- created_at Datetime
-Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
+ Date and time at which the event was created.
----
-### `schedule_modified`
+- event_id UUID
-Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past.
+ ID of the event.
----
-### `being_deleted`
+- event_type Enum
-Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.
+ Value: `acs_credential.issued`
----
-### `unknown_issue_with_acs_credential`
+- occurred_at Datetime
-An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential.
+ Date and time at which the event occurred.
----
-### `needs_to_be_reissued`
+- workspace_id UUID
-Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential.
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
+
---
-## Endpoints
+**`acs_credential.reissued`**
-### [`/acs/credentials/assign`](./assign.md)
+An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was reissued.
-Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### [`/acs/credentials/create`](./create.md)
+
-Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### [`/acs/credentials/delete`](./delete.md)
+Properties
-Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
-### [`/acs/credentials/get`](./get.md)
+- acs_credential_id UUID
-Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
-### [`/acs/credentials/list`](./list.md)
-Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md).
-### [`/acs/credentials/list_accessible_entrances`](./list_accessible_entrances.md)
+- acs_system_id UUID
-Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.
-### [`/acs/credentials/unassign`](./unassign.md)
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### [`/acs/credentials/update`](./update.md)
-Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+- connected_account_id UUID
----
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-## Events
-### `acs_credential.deleted`
+- created_at Datetime
-An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted.
+ Date and time at which the event was created.
-
-acs_credential_id Format: UUID
-
-
+- event_id UUID
-acs_system_id Format: UUID
+ ID of the event.
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
-connected_account_id Format: UUID
+- event_type Enum
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+ Value: `acs_credential.reissued`
-created_at Format: Datetime
-Date and time at which the event was created.
-
-
+- occurred_at Datetime
-event_id Format: UUID
+ Date and time at which the event occurred.
-ID of the event.
-
-
-event_type Format: Enum
-
-Value: `acs_credential.deleted`
-
-
+- workspace_id UUID
-occurred_at Format: Datetime
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-Date and time at which the event occurred.
-
-
-workspace_id Format: UUID
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
-### `acs_credential.issued`
+**`acs_credential.invalidated`**
-An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was issued.
+An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was invalidated. That is, the credential cannot be used anymore.
-acs_credential_id Format: UUID
-
-
+Properties
-acs_system_id Format: UUID
+- acs_credential_id UUID
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
-connected_account_id Format: UUID
+- acs_system_id UUID
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-created_at Format: Datetime
-Date and time at which the event was created.
-
-
+- connected_account_id UUID
-event_id Format: UUID
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-ID of the event.
-
-
-event_type Format: Enum
+- created_at Datetime
-Value: `acs_credential.issued`
-
-
+ Date and time at which the event was created.
-occurred_at Format: Datetime
-Date and time at which the event occurred.
-
-
-
-workspace_id Format: UUID
+- event_id UUID
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
+ ID of the event.
-### `acs_credential.reissued`
-An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was reissued.
+- event_type Enum
-
+ Value: `acs_credential.invalidated`
-acs_credential_id Format: UUID
-
-
-acs_system_id Format: UUID
+- occurred_at Datetime
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+ Date and time at which the event occurred.
-connected_account_id Format: UUID
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+- workspace_id UUID
-created_at Format: Datetime
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-Date and time at which the event was created.
-
-event_id Format: UUID
+---
-ID of the event.
-
-
+## Endpoints
-event_type Format: Enum
-Value: `acs_credential.reissued`
-
-
+[**`/acs/credentials/assign`**](./assign.md)
-occurred_at Format: Datetime
+Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Date and time at which the event occurred.
-
-
-workspace_id Format: UUID
+[**`/acs/credentials/create`**](./create.md)
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
+Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### `acs_credential.invalidated`
-An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was invalidated. That is, the credential cannot be used anymore.
+[**`/acs/credentials/delete`**](./delete.md)
-
+Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
-acs_credential_id Format: UUID
-
-
-acs_system_id Format: UUID
+[**`/acs/credentials/get`**](./get.md)
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
-connected_account_id Format: UUID
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+[**`/acs/credentials/list`**](./list.md)
-created_at Format: Datetime
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md).
-Date and time at which the event was created.
-
-
-event_id Format: UUID
+[**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md)
-ID of the event.
-
-
+Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.
-event_type Format: Enum
-Value: `acs_credential.invalidated`
-
-
+[**`/acs/credentials/unassign`**](./unassign.md)
-occurred_at Format: Datetime
+Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Date and time at which the event occurred.
-
-
-workspace_id Format: UUID
+[**`/acs/credentials/update`**](./update.md)
+
+Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md
index 2c1f370b0..247cb2829 100644
--- a/docs/api/acs/credentials/assign.md
+++ b/docs/api/acs/credentials/assign.md
@@ -1,14 +1,60 @@
# Assign a Credential to an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /acs/credentials/assign ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_credential_id`** (Required)
+
+ID of the desired credential.
+
+---
+
+**`acs_user_id`** (Required)
+
+ID of the desired user.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Assign a credential to an ACS user
+
+Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.assign({
@@ -17,7 +63,7 @@ await seam.acs.credentials.assign({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.acs.credentials.assign({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.assign(
@@ -34,7 +80,7 @@ seam.acs.credentials.assign(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.assign(
@@ -51,7 +97,7 @@ seam.acs.credentials.assign(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->assign(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +156,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,32 +165,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired credential.
-
-***
-
-### `acs_user_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md
index 989f3af8c..5ca7e7b2f 100644
--- a/docs/api/acs/credentials/create.md
+++ b/docs/api/acs/credentials/create.md
@@ -1,14 +1,123 @@
# Create a Credential for an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/credentials/create ⇒ { acs_credential }
```
+{% endtab %}
+{% endtabs %}
-Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`access_method`** (Required)
+
+Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.
+
+---
+
+**`acs_user_id`** (Required)
+
+ID of the ACS user to whom the new credential belongs.
+
+---
+
+**`allowed_acs_entrance_ids`** *of UUIDs*
+
+Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access.
+
+---
+
+**`assa_abloy_vostio_metadata`**
+
+Vostio-specific metadata for the new credential.
+
+---
+
+**`code`**
+
+Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md).
+
+---
+
+**`credential_manager_acs_system_id`**
+
+ACS system ID of the credential manager for the new credential.
+
+---
+
+**`ends_at`**
+
+Date and time at which the validity of the new 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 `starts_at`.
+
+---
+
+**`is_multi_phone_sync_credential`**
+
+Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
+---
+
+**`salto_space_metadata`**
+
+Salto Space-specific metadata for the new credential.
+
+---
+
+**`starts_at`**
+
+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.
+
+---
+
+**`visionline_metadata`**
+
+Visionline-specific metadata for the new credential.
+
+---
+
+
+## Response
+
+[acs\_credential](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_credential
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Create a credential for an ACS user
+
+Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.create({
@@ -25,7 +134,7 @@ await seam.acs.credentials.create({
});
```
-#### Response
+#### Output
```javascript
{
@@ -43,7 +152,7 @@ await seam.acs.credentials.create({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.create(
@@ -60,7 +169,7 @@ seam.acs.credentials.create(
)
```
-#### Response
+#### Output
```python
AcsCredential(
@@ -78,7 +187,7 @@ AcsCredential(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.create(
@@ -95,7 +204,7 @@ seam.acs.credentials.create(
)
```
-#### Response
+#### Output
```ruby
{
@@ -113,7 +222,7 @@ seam.acs.credentials.create(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->create(
);
```
-#### Response
+#### Output
```php
acs->credentials->create(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z"
```
-#### Response
+#### Output
```seam_cli
{
@@ -174,7 +283,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -198,7 +307,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}
@@ -207,200 +316,4 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `access_method`
-
-Format: `Enum`
-Required: Yes
-
-Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.
-
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
-
-***
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the ACS user to whom the new credential belongs.
-
-***
-
-### `allowed_acs_entrance_ids`
-
-Format: `List`
-Item format: `UUID`
-Required: No
-
-Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access.
-
-***
-
-### `assa_abloy_vostio_metadata`
-Format: `Object`
-Required: No
-
-Vostio-specific metadata for the new credential.
-
-
-
-auto_join Format: Boolean
-
-
-
-
-join_all_guest_acs_entrances Format: Boolean
-
-
-
-
-override_all_guest_acs_entrances Format: Boolean
-
-
-
-
-override_guest_acs_entrance_ids Format: List
-
-
-***
-
-### `code`
-
-Format: `String`
-Required: No
-
-Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md).
-
-***
-
-### `credential_manager_acs_system_id`
-
-Format: `UUID`
-Required: No
-
-ACS system ID of the credential manager for the new credential.
-
-***
-
-### `ends_at`
-
-Format: `Datetime`
-Required: No
-
-Date and time at which the validity of the new 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 `starts_at`.
-
-***
-
-### `is_multi_phone_sync_credential`
-
-Format: `Boolean`
-Required: No
-
-Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-***
-
-### `salto_space_metadata`
-
-Format: `Object`
-Required: No
-
-Salto Space-specific metadata for the new credential.
-
-
-
-assign_new_key Format: Boolean
-
-
-
-
-update_current_key Format: Boolean
-
-
-***
-
-### `starts_at`
-
-Format: `Datetime`
-Required: No
-
-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.
-
-***
-
-### `visionline_metadata`
-
-Format: `Object`
-Required: No
-
-Visionline-specific metadata for the new credential.
-
-
-
-assa_abloy_credential_service_mobile_endpoint_id Format: UUID
-
-{% hint style="warning" %}
-**Deprecated**. Read-only endpoint references moved to `endpoint`.
-{% endhint %}
-
-
-
-
-auto_join Format: Boolean
-
-
-
-
-card_format Format: Enum
-
-Possible enum values:
-- `TLCode`
-- `rfid48`
-
-
-
-
-card_function_type Format: Enum
-
-Possible enum values:
-- `guest`
-- `staff`
-
-
-
-
-is_override_key Format: Boolean
-
-{% hint style="warning" %}
-**Deprecated**. Use `override` instead.
-{% endhint %}
-
-
-
-
-joiner_acs_credential_ids Format: List
-
-
-
-
-override Format: Boolean
-
-
-***
-
-## Return Type
-
-[acs\_credential](./)
diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md
index 86551ab82..8397bf407 100644
--- a/docs/api/acs/credentials/delete.md
+++ b/docs/api/acs/credentials/delete.md
@@ -1,14 +1,54 @@
# Delete a Credential
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/credentials/delete ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_credential_id`** (Required)
+
+ID of the desired credential.
+
+---
-Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Delete a credential
+
+Specify the desired `acs_credential_id` to delete the specified credential.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.delete({
@@ -16,7 +56,7 @@ await seam.acs.credentials.delete({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -24,13 +64,13 @@ await seam.acs.credentials.delete({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666")
```
-#### Response
+#### Output
```python
None
@@ -38,13 +78,13 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666")
```
-#### Response
+#### Output
```ruby
nil
@@ -52,7 +92,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->delete(
);
```
-#### Response
+#### Output
```php
null
@@ -69,13 +109,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -83,7 +123,7 @@ seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-6666666
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -101,7 +141,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -110,23 +150,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `UUID`
-Required: Yes
-ID of the desired credential.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md
index 6cfa1ffe6..3ee0924b0 100644
--- a/docs/api/acs/credentials/get.md
+++ b/docs/api/acs/credentials/get.md
@@ -1,14 +1,63 @@
# Get a Credential
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/credentials/get ⇒ { acs_credential }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_credential_id`** (Required)
+
+ID of the desired credential.
+
+---
+
+
+## Response
+
+[acs\_credential](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_credential
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get a credential
+
+Specify the `acs_credential_id` of the credential that you want to retrieve.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.get({
@@ -16,7 +65,7 @@ await seam.acs.credentials.get({
});
```
-#### Response
+#### Output
```javascript
{
@@ -34,13 +83,13 @@ await seam.acs.credentials.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666")
```
-#### Response
+#### Output
```python
AcsCredential(
@@ -58,13 +107,13 @@ AcsCredential(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666")
```
-#### Response
+#### Output
```ruby
{
@@ -82,7 +131,7 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->get(
);
```
-#### Response
+#### Output
```php
acs->credentials->get(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666"
```
-#### Response
+#### Output
```seam_cli
{
@@ -134,7 +183,7 @@ seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-6666666666
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -152,7 +201,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}
@@ -161,23 +210,4 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired credential.
-
-***
-
-## Return Type
-
-[acs\_credential](./)
diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md
index 51494deb5..e83062764 100644
--- a/docs/api/acs/credentials/list.md
+++ b/docs/api/acs/credentials/list.md
@@ -1,14 +1,94 @@
# List Credentials
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_system_id`**
+
+ID of the access control system for which you want to retrieve all credentials.
+
+---
+
+**`acs_user_id`**
+
+ID of the ACS user for which you want to retrieve all credentials.
+
+---
+
+**`created_before`**
+
+Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
+
+---
+
+**`is_multi_phone_sync_credential`**
+
+Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
+
+---
+
+**`limit`**
+
+Number of credentials to return.
+
+---
+
+**`user_identity_id`**
+
+ID of the user identity for which you want to retrieve all credentials.
+
+---
+
+
+## Response
+
+Array of [acs\_credentials](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_credential
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List credentials
+
+Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.list({
@@ -19,7 +99,7 @@ await seam.acs.credentials.list({
});
```
-#### Response
+#### Output
```javascript
[
@@ -39,7 +119,7 @@ await seam.acs.credentials.list({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.list(
@@ -50,7 +130,7 @@ seam.acs.credentials.list(
)
```
-#### Response
+#### Output
```python
[
@@ -70,7 +150,7 @@ seam.acs.credentials.list(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.list(
@@ -81,7 +161,7 @@ seam.acs.credentials.list(
)
```
-#### Response
+#### Output
```ruby
[
@@ -101,7 +181,7 @@ seam.acs.credentials.list(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->list(
);
```
-#### Response
+#### Output
```php
acs->credentials->list(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true
```
-#### Response
+#### Output
```seam_cli
[
@@ -160,7 +240,7 @@ seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" -
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -181,7 +261,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}}
@@ -190,69 +270,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_system_id`
-
-Format: `UUID`
-Required: No
-
-ID of the access control system for which you want to retrieve all credentials.
-
-***
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: No
-
-ID of the ACS user for which you want to retrieve all credentials.
-
-***
-
-### `created_before`
-
-Format: `Datetime`
-Required: No
-
-Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
-
-***
-
-### `is_multi_phone_sync_credential`
-
-Format: `Boolean`
-Required: No
-
-Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
-
-***
-
-### `limit`
-
-Format: `Number`
-Required: No
-
-Number of credentials to return.
-
-***
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: No
-
-ID of the user identity for which you want to retrieve all credentials.
-
-***
-
-## Return Type
-Array<[acs\_credential](./)>
diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md
index 16383fe3e..ba0bccc4d 100644
--- a/docs/api/acs/credentials/list_accessible_entrances.md
+++ b/docs/api/acs/credentials/list_accessible_entrances.md
@@ -1,14 +1,63 @@
# List Accessible Entrances
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_credential_id`** (Required)
+
+ID of the credential for which you want to retrieve all entrances to which this credential grants access.
+
+---
+
+
+## Response
+
+Array of [acs\_entrances](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_entrance
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List accessible entrances
+
+Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.listAccessibleEntrances({
@@ -16,7 +65,7 @@ await seam.acs.credentials.listAccessibleEntrances({
});
```
-#### Response
+#### Output
```javascript
[
@@ -43,7 +92,7 @@ await seam.acs.credentials.listAccessibleEntrances({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.list_accessible_entrances(
@@ -51,7 +100,7 @@ seam.acs.credentials.list_accessible_entrances(
)
```
-#### Response
+#### Output
```python
[
@@ -78,7 +127,7 @@ seam.acs.credentials.list_accessible_entrances(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.list_accessible_entrances(
@@ -86,7 +135,7 @@ seam.acs.credentials.list_accessible_entrances(
)
```
-#### Response
+#### Output
```ruby
[
@@ -108,7 +157,7 @@ seam.acs.credentials.list_accessible_entrances(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->list_accessible_entrances(
);
```
-#### Response
+#### Output
```php
acs->credentials->list_accessible_entrances(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666"
```
-#### Response
+#### Output
```seam_cli
[
@@ -178,7 +227,7 @@ seam acs credentials list-accessible-entrances --acs_credential_id "66666666-666
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -196,7 +245,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}}
@@ -205,23 +254,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the credential for which you want to retrieve all entrances to which this credential grants access.
-
-***
-
-## Return Type
-Array<[acs\_entrance](./)>
diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md
index 1a9f469d1..75403a0cd 100644
--- a/docs/api/acs/credentials/unassign.md
+++ b/docs/api/acs/credentials/unassign.md
@@ -1,14 +1,60 @@
# Unassign a Credential from an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /acs/credentials/unassign ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_credential_id`** (Required)
+
+ID of the desired credential.
+
+---
+
+**`acs_user_id`** (Required)
+
+ID of the desired user.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Unassign a credential from an ACS user
+
+Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.unassign({
@@ -17,7 +63,7 @@ await seam.acs.credentials.unassign({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.acs.credentials.unassign({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.unassign(
@@ -34,7 +80,7 @@ seam.acs.credentials.unassign(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.unassign(
@@ -51,7 +97,7 @@ seam.acs.credentials.unassign(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->unassign(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-33333333333
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +156,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,32 +165,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired credential.
-
-***
-
-### `acs_user_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md
index 82ebc6d1a..172411a3e 100644
--- a/docs/api/acs/credentials/update.md
+++ b/docs/api/acs/credentials/update.md
@@ -1,14 +1,66 @@
# Update a Credential
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /acs/credentials/update ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_credential_id`** (Required)
+
+ID of the desired credential.
+
+---
+
+**`code`**
+
+Replacement access (PIN) code for the credential.
+
+---
+
+**`ends_at`**
+
+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.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Update a credential
+
+Specify the desired `acs_credential_id` and updated `code` to update the credential.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.credentials.update({
@@ -17,7 +69,7 @@ await seam.acs.credentials.update({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +77,7 @@ await seam.acs.credentials.update({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.credentials.update(
@@ -33,7 +85,7 @@ seam.acs.credentials.update(
)
```
-#### Response
+#### Output
```python
None
@@ -41,13 +93,13 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890")
```
-#### Response
+#### Output
```ruby
nil
@@ -55,7 +107,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->credentials->update(
);
```
-#### Response
+#### Output
```php
null
@@ -73,13 +125,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -87,7 +139,7 @@ seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-6666666
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -106,7 +158,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -115,41 +167,4 @@ nil
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `String`
-Required: Yes
-
-ID of the desired credential.
-
-***
-
-### `code`
-
-Format: `String`
-Required: No
-
-Replacement access (PIN) code for the credential.
-
-***
-
-### `ends_at`
-
-Format: `Datetime`
-Required: No
-
-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.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md
index e33ce1e9f..2de3bb472 100644
--- a/docs/api/acs/encoders/README.md
+++ b/docs/api/acs/encoders/README.md
@@ -1,6 +1,13 @@
# Encoders
-## `acs_encoder`
+## The acs_encoder Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -17,207 +24,225 @@ Separately, the Seam API also supports card scanning, which enables you to scan
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems).
-### `acs_encoder_id`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ acs_encoder_id: [example value],
+ acs_system_id: [example value],
+ created_at: [example value],
+ display_name: [example value],
+ errors: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
-Format: `UUID`
+**`acs_encoder_id`** *UUID*
ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.
----
-### `acs_system_id`
-Format: `UUID`
+
+---
+
+**`acs_system_id`** *UUID*
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
----
-### `created_at`
-Format: `Datetime`
+
+---
+
+**`created_at`** *Datetime*
Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created.
----
-### `display_name`
-Format: `String`
+
+---
+
+**`display_name`** *String*
Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
----
-### `errors`
-Format: `List`
-Item format: `Object`
+---
+
+**`errors`** *List* *of Objects*
Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
-created_at Format: Datetime
-Date and time at which Seam created the error.
+
+ Child Object Properties
+ created_at Datetime
+
+ Date and time at which Seam created the error.
+ error_code Enum
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - acs_encoder_removed`
+
+ message String
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
+---
-error_code Format: Enum
+**`workspace_id`** *UUID*
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-Possible enum values:
-- `acs_encoder_removed`
-
-
-message Format: String
-
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
-### `workspace_id`
-Format: `UUID`
+## Events
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+**`acs_encoder.added`**
----
+An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was added.
-## Endpoints
+
-### [`/acs/encoders/encode_access_method`](./encode_access_method.md)
+Properties
-Encodes an existing access method onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-### [`/acs/encoders/encode_credential`](./encode_credential.md)
+- acs_encoder_id UUID
-Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-### [`/acs/encoders/get`](./get.md)
+ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-Returns a specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-### [`/acs/encoders/list`](./list.md)
-Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-### [`/acs/encoders/scan_credential`](./scan_credential.md)
+- acs_system_id UUID
-Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-## Events
+- connected_account_id UUID
-### `acs_encoder.added`
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was added.
-
+- created_at Datetime
-acs_encoder_id Format: UUID
+ Date and time at which the event was created.
-ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
-
-acs_system_id Format: UUID
+- event_id UUID
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+ ID of the event.
-connected_account_id Format: UUID
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+- event_type Enum
-created_at Format: Datetime
+ Value: `acs_encoder.added`
-Date and time at which the event was created.
-
-
-event_id Format: UUID
+- occurred_at Datetime
-ID of the event.
-
-
+ Date and time at which the event occurred.
-event_type Format: Enum
-Value: `acs_encoder.added`
-
-
+- workspace_id UUID
-occurred_at Format: Datetime
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-Date and time at which the event occurred.
-
-
-workspace_id Format: UUID
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
-### `acs_encoder.removed`
+**`acs_encoder.removed`**
An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was removed.
-acs_encoder_id Format: UUID
+Properties
-ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
-
+- acs_encoder_id UUID
-acs_system_id Format: UUID
+ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
-connected_account_id Format: UUID
+- acs_system_id UUID
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-created_at Format: Datetime
-Date and time at which the event was created.
-
-
+- connected_account_id UUID
-event_id Format: UUID
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-ID of the event.
-
-
-event_type Format: Enum
+- created_at Datetime
-Value: `acs_encoder.removed`
-
-
+ Date and time at which the event was created.
-occurred_at Format: Datetime
-Date and time at which the event occurred.
-
-
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `acs_encoder.removed`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
-workspace_id Format: UUID
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
+
---
+## Endpoints
+
+
+[**`/acs/encoders/encode_access_method`**](./encode_access_method.md)
+
+Encodes an existing access method onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+
+[**`/acs/encoders/encode_credential`**](./encode_credential.md)
+
+Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+
+[**`/acs/encoders/get`**](./get.md)
+
+Returns a specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+
+[**`/acs/encoders/list`**](./list.md)
+
+Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+
+[**`/acs/encoders/scan_credential`**](./scan_credential.md)
+
+Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+
diff --git a/docs/api/acs/encoders/encode_access_method.md b/docs/api/acs/encoders/encode_access_method.md
index f9ee6d64f..aac1fcdad 100644
--- a/docs/api/acs/encoders/encode_access_method.md
+++ b/docs/api/acs/encoders/encode_access_method.md
@@ -1,163 +1,60 @@
# Encode an Access Method
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Encodes an existing access method onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/encode_access_method ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Encodes an existing access method onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
-
-### `access_method_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the `access_method` to encode onto a card.
-
-***
-
-### `acs_encoder_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the `acs_encoder` to use to encode the `access_method`.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `ENCODE_ACCESS_METHOD`
-
-Action attempt to track encoding credential data from the physical encoder onto a card.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Type of action that the action attempt tracks.
-
-Value: `ENCODE_ACCESS_METHOD`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
-
+## Request Parameters
-type Format: Enum
+**`access_method_id`** (Required)
-Possible enum values:
-- `uncategorized_error`
-- `action_attempt_expired`
-- `no_credential_on_encoder`
-- `incompatible_card_format`
-- `credential_cannot_be_reissued`
-
+ID of the `access_method` to encode onto a card.
---
-#### `result`
-
-Format: `Object`
-
-If an encoding attempt was successful, includes the `access_method` data that was encoded onto the card.
-
-
-
-access_method_id Format: UUID
-
-ID of the access method.
-
-
-
-
-created_at Format: Datetime
-
-Date and time at which the access method was created.
-
-
-
-
-display_name Format: String
-
-Display name of the access method.
-
-
-
-
-instant_key_url Format: String
-
-URL of instant key for mobile key access methods.
-
-
-
-
-is_card_encoding_required Format: Boolean
+**`acs_encoder_id`** (Required)
-Whether card encoding is required for plastic card access methods.
-
-
-
-
-issued_at Format: Datetime
-
-Date and time at which the access method was issued.
-
-
-
-
-mode Format: Enum
-
-Access method mode. Supported values: `code`, `card`, `mobile_key`.
-
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
-
-
-
-
-workspace_id Format: UUID
-
-Unique identifier for the Seam workspace associated with the access grant.
-
+ID of the `acs_encoder` to use to encode the `access_method`.
---
-#### `status`
-
-Format: `Enum`
-Possible enum values:
-- `success`
-- `pending`
-- `error`
+## Response
----
+[action\_attempt](./)
+**`ENCODE_ACCESS_METHOD`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index c23371b6d..7647dde82 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -1,398 +1,60 @@
# Encode a Credential
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/encode_credential ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the `acs_credential` to encode onto a card.
-
-***
-
-### `acs_encoder_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the `acs_encoder` to use to encode the `acs_credential`.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `ENCODE_CREDENTIAL`
-
-Action attempt to track encoding credential data from the physical encoder onto a card.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Type of action that the action attempt tracks.
-
-Value: `ENCODE_CREDENTIAL`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
-
+## Request Parameters
-type Format: Enum
+**`acs_credential_id`** (Required)
-Possible enum values:
-- `uncategorized_error`
-- `action_attempt_expired`
-- `no_credential_on_encoder`
-- `incompatible_card_format`
-- `credential_cannot_be_reissued`
-
+ID of the `acs_credential` to encode onto a card.
---
-#### `result`
-
-Format: `Object`
-
-If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card.
-
-
-
-access_method Format: Enum
-
-Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
-
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
-
-
-
-
-acs_credential_id Format: UUID
-
-ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_pool_id Format: UUID
-
-
-
-
-acs_system_id Format: UUID
-
-ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_user_id Format: UUID
-
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
-
-
-
-assa_abloy_vostio_metadata Format: Object
-
-Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-assa_abloy_vostio_metadata.auto_join Format: Boolean
-
-
-
-
-assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
-
-
-
-assa_abloy_vostio_metadata.endpoint_id Format: String
-
-
-
-
-assa_abloy_vostio_metadata.key_id Format: String
-
-
-
-
-assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
-
-
-
-assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
-
-
-
-card_number Format: String
-
-Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-code Format: String
-
-Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-created_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-
-display_name Format: String
-
-Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-
-ends_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity 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 `starts_at`.
-
-
-
-
-errors Format: List Item format: Object
-
-Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- error_code Format: String
-
-
-- message Format: String
-
-
-
-
-
-external_type Format: Enum
-
-Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
-
-Possible enum values:
-- `pti_card`
-- `brivo_credential`
-- `hid_credential`
-- `visionline_card`
-- `salto_ks_credential`
-- `assa_abloy_vostio_key`
-- `salto_space_key`
-- `latch_access`
-
-
-
-
-external_type_display_name Format: String
-
-Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-
-is_issued Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
-
-
-
-is_latest_desired_state_synced_with_provider Format: Boolean
-
-Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
-
-
-
-is_managed Format: Boolean
-
-
-
-
-is_multi_phone_sync_credential Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-
-
-
-is_one_time_use Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
-
-
-
-issued_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
-
-
-
-latest_desired_state_synced_with_provider_at Format: Datetime
-
-Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
-
-
-
-parent_acs_credential_id Format: UUID
-
-ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-starts_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-
-
-
-visionline_metadata Format: Object
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-visionline_metadata.auto_join Format: Boolean
-
-
-
-
-visionline_metadata.card_function_type Format: Enum
-
-Possible enum values:
-- `guest`
-- `staff`
-
-
-
-
-visionline_metadata.card_id Format: String
-
-
-
-
-visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-
-
-
-visionline_metadata.credential_id Format: String
-
-
-
-
-visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-
-
-
-visionline_metadata.is_valid Format: Boolean
-
-
-
-
-visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
-
-
-
-warnings Format: List Item format: Object
-
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- created_at Format: Datetime
-
- Date and time at which Seam created the warning.
-
-
-- message Format: String
-
- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+**`acs_encoder_id`** (Required)
-
-- warning_code Format: Enum
-
- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
- Possible enum values:
- - `waiting_to_be_issued`
- - `schedule_externally_modified`
- - `schedule_modified`
- - `being_deleted`
- - `unknown_issue_with_acs_credential`
- - `needs_to_be_reissued`
-
-
-
-
-
-workspace_id Format: UUID
-
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
+ID of the `acs_encoder` to use to encode the `acs_credential`.
---
-#### `status`
-
-Format: `Enum`
-Possible enum values:
-- `success`
-- `pending`
-- `error`
+## Response
----
+[action\_attempt](./)
+**`ENCODE_CREDENTIAL`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/acs/encoders/get.md b/docs/api/acs/encoders/get.md
index a59ae5f62..0c56ef974 100644
--- a/docs/api/acs/encoders/get.md
+++ b/docs/api/acs/encoders/get.md
@@ -1,28 +1,48 @@
# Get an Encoder
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/get ⇒ { acs_encoder }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_encoder_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_encoder_id`** (Required)
ID of the desired encoder.
-***
+---
-## Return Type
+
+## Response
[acs\_encoder](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_encoder
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md
index ae1988018..0e683071c 100644
--- a/docs/api/acs/encoders/list.md
+++ b/docs/api/acs/encoders/list.md
@@ -1,57 +1,66 @@
# List Encoders
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_encoder_ids`
+## Request Parameters
-Format: `List`
-Item format: `UUID`
-Required: No
+**`acs_encoder_ids`** *of UUIDs*
IDs of the `acs_encoder`s that you want to retrieve.
-***
+---
-### `acs_system_id`
-
-Format: `UUID`
-Required: No
+**`acs_system_id`**
ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.
-***
-
-### `acs_system_ids`
+---
-Format: `List`
-Item format: `UUID`
-Required: No
+**`acs_system_ids`** *of UUIDs*
IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.
-***
-
-### `limit`
+---
-Format: `Number`
-Required: No
+**`limit`**
Number of `acs_encoders` to return.
-***
+---
-## Return Type
-Array<[acs\_encoder](./)>
+## Response
+
+Array of [acs\_encoders](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_encoder
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index c2e3546fb..81a676f88 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -1,540 +1,54 @@
# Scan a Credential
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/scan_credential ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
-
-### `acs_encoder_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the `acs_encoder` to use for the scan.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `SCAN_CREDENTIAL`
-
-Reading credential data from physical encoder.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `SCAN_CREDENTIAL`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: Enum
-
-Possible enum values:
-- `uncategorized_error`
-- `action_attempt_expired`
-- `no_credential_on_encoder`
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-
-
-acs_credential_on_encoder Format: Object
-
-Snapshot of credential data read from physical encoder.
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
-
-
-acs_credential_on_encoder.card_number Format: String
-
-A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_encoder.created_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-
-acs_credential_on_encoder.ends_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
-
-
-
-acs_credential_on_encoder.is_issued Format: Boolean
-
-
-
-
-acs_credential_on_encoder.starts_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
-
-
-
-acs_credential_on_encoder.visionline_metadata Format: Object
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
-
-Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-Possible enum values:
-- `TLCode`
-- `rfid48`
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_holder Format: String
-
-Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_id Format: String
-
-Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
-
-Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
-
-
-
-acs_credential_on_seam Format: Object
-
-Matching acs_credential currently encoded on this card.
-
-
-
-
-acs_credential_on_seam.access_method Format: Enum
-
-Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
-
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
-
-
-
-
-acs_credential_on_seam.acs_credential_id Format: UUID
-
-ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_seam.acs_credential_pool_id Format: UUID
-
-
-
-
-acs_credential_on_seam.acs_system_id Format: UUID
-
-ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_seam.acs_user_id Format: UUID
-
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata Format: Object
-
-Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.auto_join Format: Boolean
-
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.endpoint_id Format: String
-
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.key_id Format: String
-
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
-
-
-
-acs_credential_on_seam.card_number Format: String
-
-Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_seam.code Format: String
-
-Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_seam.created_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-
-acs_credential_on_seam.display_name Format: String
-
-Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-
-acs_credential_on_seam.ends_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity 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 `starts_at`.
-
-
-
-
-acs_credential_on_seam.errors Format: List Item format: Object
-
-Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- error_code Format: String
-
-
-- message Format: String
-
-
-
-
-
-acs_credential_on_seam.external_type Format: Enum
-
-Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
-
-Possible enum values:
-- `pti_card`
-- `brivo_credential`
-- `hid_credential`
-- `visionline_card`
-- `salto_ks_credential`
-- `assa_abloy_vostio_key`
-- `salto_space_key`
-- `latch_access`
-
-
-
-
-acs_credential_on_seam.external_type_display_name Format: String
-
-Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-
-acs_credential_on_seam.is_issued Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
-
-
-
-acs_credential_on_seam.is_latest_desired_state_synced_with_provider Format: Boolean
-
-Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
-
-
-
-acs_credential_on_seam.is_managed Format: Boolean
-
-
-
-
-acs_credential_on_seam.is_multi_phone_sync_credential Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-
-
-
-acs_credential_on_seam.is_one_time_use Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
-
-
-
-acs_credential_on_seam.issued_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
-
-
-
-acs_credential_on_seam.latest_desired_state_synced_with_provider_at Format: Datetime
-
-Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
-
-
-
-acs_credential_on_seam.parent_acs_credential_id Format: UUID
-
-ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_seam.starts_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-
-
-
-acs_credential_on_seam.visionline_metadata Format: Object
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-acs_credential_on_seam.visionline_metadata.auto_join Format: Boolean
-
-
-
-
-acs_credential_on_seam.visionline_metadata.card_function_type Format: Enum
-
-Possible enum values:
-- `guest`
-- `staff`
-
-
-
-
-acs_credential_on_seam.visionline_metadata.card_id Format: String
-
-
-
-
-acs_credential_on_seam.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-
-
-
-acs_credential_on_seam.visionline_metadata.credential_id Format: String
-
-
-
-
-acs_credential_on_seam.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-
-
-
-acs_credential_on_seam.visionline_metadata.is_valid Format: Boolean
-
-
-
-
-acs_credential_on_seam.visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
-
-
-
-acs_credential_on_seam.warnings Format: List Item format: Object
-
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- created_at Format: Datetime
-
- Date and time at which Seam created the warning.
-
-
-- message Format: String
-
- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
-- warning_code Format: Enum
-
- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
- Possible enum values:
- - `waiting_to_be_issued`
- - `schedule_externally_modified`
- - `schedule_modified`
- - `being_deleted`
- - `unknown_issue_with_acs_credential`
- - `needs_to_be_reissued`
-
-
-
-
-
-acs_credential_on_seam.workspace_id Format: UUID
-
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-warnings Format: List Item format: Object
-
-- warning_code Format: Enum
-
- Possible enum values:
- - `acs_credential_on_encoder_out_of_sync`
- - `acs_credential_on_seam_not_found`
-
+## Request Parameters
-- warning_message Format: String
+**`acs_encoder_id`** (Required)
-
+ID of the `acs_encoder` to use for the scan.
---
-#### `status`
-
-Format: `Enum`
-Possible enum values:
-- `success`
-- `pending`
-- `error`
+## Response
----
+[action\_attempt](./)
+**`SCAN_CREDENTIAL`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md
index adf033739..91ad7fa2c 100644
--- a/docs/api/acs/encoders/simulate/README.md
+++ b/docs/api/acs/encoders/simulate/README.md
@@ -2,15 +2,24 @@
## Endpoints
-### [`/acs/encoders/simulate/next_credential_encode_will_fail`](./next_credential_encode_will_fail.md)
+
+[**`/acs/encoders/simulate/next_credential_encode_will_fail`**](./next_credential_encode_will_fail.md)
Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
-### [`/acs/encoders/simulate/next_credential_encode_will_succeed`](./next_credential_encode_will_succeed.md)
+
+
+[**`/acs/encoders/simulate/next_credential_encode_will_succeed`**](./next_credential_encode_will_succeed.md)
Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
-### [`/acs/encoders/simulate/next_credential_scan_will_fail`](./next_credential_scan_will_fail.md)
+
+
+[**`/acs/encoders/simulate/next_credential_scan_will_fail`**](./next_credential_scan_will_fail.md)
Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
-### [`/acs/encoders/simulate/next_credential_scan_will_succeed`](./next_credential_scan_will_succeed.md)
+
+
+[**`/acs/encoders/simulate/next_credential_scan_will_succeed`**](./next_credential_scan_will_succeed.md)
Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
+
diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md
index 7c36fdefb..bee0557f6 100644
--- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md
+++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md
@@ -1,51 +1,51 @@
# Simulate that the Next Credential Encoding Will Fail
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_encoder_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_encoder_id`** (Required)
ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
-***
+---
-### `acs_credential_id`
-
-Format: `UUID`
-Required: No
+**`acs_credential_id`**
ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
-***
-
-### `error_code`
+---
-Format: `Enum`
-Required: No
+**`error_code`**
Code of the error to simulate.
-Possible enum values:
-- `no_credential_on_encoder`
-- `uncategorized_error`
-- `action_attempt_expired`
+---
-***
-## Return Type
+## Response
void
diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md
index 2e34e0fdb..8591ccc6f 100644
--- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md
+++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md
@@ -1,40 +1,45 @@
# Simulate that the Next Credential Encoding Will Succeed
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_encoder_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_encoder_id`** (Required)
ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
-***
-
-### `scenario`
+---
-Format: `Enum`
-Required: No
+**`scenario`**
Scenario to simulate.
-Possible enum values:
-- `credential_is_issued`
+---
-***
-## Return Type
+## Response
void
diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md
index e5c8865bf..9e0a64da5 100644
--- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md
+++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md
@@ -1,47 +1,47 @@
# Simulate that the Next Credential Scan Will Fail
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_encoder_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_encoder_id`** (Required)
ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
-***
-
-### `acs_credential_id_on_seam`
-
-Format: `UUID`
-Required: No
+---
-***
+**`acs_credential_id_on_seam`**
-### `error_code`
+---
-Format: `Enum`
-Required: No
+**`error_code`**
-Possible enum values:
-- `no_credential_on_encoder`
-- `uncategorized_error`
-- `action_attempt_expired`
+---
-***
-## Return Type
+## Response
void
diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md
index 625da5b77..678a57eba 100644
--- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md
+++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md
@@ -1,52 +1,51 @@
# Simulate that the Next Credential Scan Will Succeed
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_encoder_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_encoder_id`** (Required)
ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.
-***
+---
-### `acs_credential_id_on_seam`
-
-Format: `UUID`
-Required: No
+**`acs_credential_id_on_seam`**
ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.
-***
-
-### `scenario`
+---
-Format: `Enum`
-Required: No
+**`scenario`**
Scenario to simulate.
-Possible enum values:
-- `credential_exists_on_seam`
-- `credential_on_encoder_needs_update`
-- `credential_does_not_exist_on_seam`
-- `credential_on_encoder_is_empty`
+---
-***
-## Return Type
+## Response
void
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index 1cd4118c7..41bbb6c1f 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -1,379 +1,372 @@
# Entrances
-## `acs_entrance`
+## The acs_entrance Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
-### `acs_entrance_id`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ acs_entrance_id: [example value],
+ acs_system_id: [example value],
+ assa_abloy_vostio_metadata: [example value],
+ created_at: [example value],
+ display_name: [example value],
+ dormakaba_community_metadata: [example value],
+ errors: [example value],
+ latch_metadata: [example value],
+ salto_ks_metadata: [example value],
+ salto_space_metadata: [example value],
+ visionline_metadata: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
-Format: `UUID`
+---
+## Properties
+
+**`acs_entrance_id`** *UUID*
ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
----
-### `acs_system_id`
-Format: `UUID`
+
+---
+
+**`acs_system_id`** *UUID*
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
----
-### `assa_abloy_vostio_metadata`
-Format: `Object`
-ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+---
-
+**`assa_abloy_vostio_metadata`** *Object*
-door_name Format: String
-
+ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-
-door_number Format: Number
-
+ Child Properties
-door_type Format: Enum
+ - door_name String
-Possible enum values:
-- `CommonDoor`
-- `EntranceDoor`
-- `GuestDoor`
-- `Elevator`
-
+ - door_number Number
+ - door_type Enum
+ Enum values:
-pms_id Format: String
+ - CommonDoor`
+ - EntranceDoor`
+ - GuestDoor`
+ - Elevator`
-
+ - pms_id String
+
+ - stand_open Boolean
-stand_open Format: Boolean
---
-### `created_at`
-
-Format: `Datetime`
+**`created_at`** *Datetime*
Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created.
----
-### `display_name`
-Format: `String`
-
-Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
---
-### `dormakaba_community_metadata`
+**`display_name`** *String*
-Format: `Object`
+Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-
-access_point_name Format: String
-
---
-### `errors`
+**`dormakaba_community_metadata`** *Object*
-Format: `List`
+dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-Item format: `Object`
-Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+ Child Properties
-error_code Format: String
+ - access_point_name String
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
+---
-message Format: String
+**`errors`** *List* *of Objects*
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+
+
+
+ Child Object Properties
+ error_code String
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+ message String
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
---
-### `latch_metadata`
-
-Format: `Object`
+**`latch_metadata`** *Object*
Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-
-accessibility_type Format: String
-
+ Child Properties
-door_name Format: String
-
+ - accessibility_type String
-
+ - door_name String
-door_type Format: String
-
+ - door_type String
-
+ - is_connected Boolean
-is_connected Format: Boolean
---
-### `salto_ks_metadata`
-
-Format: `Object`
+**`salto_ks_metadata`** *Object*
Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-
-battery_level Format: String
-
+ Child Properties
-door_name Format: String
-
+ - battery_level String
-
+ - door_name String
-intrusion_alarm Format: Boolean
-
+ - intrusion_alarm Boolean
-
+ - left_open_alarm Boolean
-left_open_alarm Format: Boolean
-
+ - lock_type String
-
+ - locked_state String
-lock_type Format: String
-
+ - online Boolean
-
+ - privacy_mode Boolean
-locked_state Format: String
-
+---
+
+**`salto_space_metadata`** *Object*
+
+Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
-online Format: Boolean
-
+ Child Properties
+
+ - door_description String
+
+ - door_name String
+
+ - ext_door_id String
-privacy_mode Format: Boolean
---
-### `salto_space_metadata`
+**`visionline_metadata`** *Object*
+
+Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-Format: `Object`
-Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+ Child Properties
-door_description Format: String
+ - door_category Enum
+
+ Enum values:
+
+ - entrance`
+ - guest`
+ - elevator reader`
+ - common`
+ - common (PMS)`
+ - door_name String
+
+ - profiles List of Objects
+
+- visionline_door_profile_id String
+
+
+- visionline_door_profile_type Enum
+ Enum values:
-door_name Format: String
+ - BLE`
+ - commonDoor`
+ - touch`
-
-ext_door_id Format: String
---
-### `visionline_metadata`
-Format: `Object`
+## Events
-Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+**`acs_entrance.added`**
-
+An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
-door_category Format: Enum
+
-Possible enum values:
-- `entrance`
-- `guest`
-- `elevator reader`
-- `common`
-- `common (PMS)`
-
+Properties
-
+- acs_entrance_id UUID
-door_name Format: String
-
-
+- acs_system_id UUID
-profiles Format: List Item format: Object
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-- visionline_door_profile_id Format: String
+- connected_account_id UUID
-- visionline_door_profile_type Format: Enum
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
- Possible enum values:
- - `BLE`
- - `commonDoor`
- - `touch`
-
+- created_at Datetime
----
+ Date and time at which the event was created.
-## Endpoints
-### [`/acs/entrances/get`](./get.md)
+- event_id UUID
-Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-### [`/acs/entrances/grant_access`](./grant_access.md)
+ ID of the event.
-### [`/acs/entrances/list`](./list.md)
+- event_type Enum
-Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-### [`/acs/entrances/list_credentials_with_access`](./list_credentials_with_access.md)
+ Value: `acs_entrance.added`
-Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
----
+- occurred_at Datetime
-## Events
+ Date and time at which the event occurred.
-### `acs_entrance.added`
-An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
+- workspace_id UUID
-
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-acs_entrance_id Format: UUID
-
-acs_system_id Format: UUID
+---
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+**`acs_entrance.removed`**
-connected_account_id Format: UUID
+An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-created_at Format: Datetime
+Properties
-Date and time at which the event was created.
-
-
+- acs_entrance_id UUID
-event_id Format: UUID
-ID of the event.
-
-
+- acs_system_id UUID
-event_type Format: Enum
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-Value: `acs_entrance.added`
-
-
-occurred_at Format: Datetime
+- connected_account_id UUID
-Date and time at which the event occurred.
-
-
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-workspace_id Format: UUID
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
+- created_at Datetime
-### `acs_entrance.removed`
+ Date and time at which the event was created.
-An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
-
+- event_id UUID
-acs_entrance_id Format: UUID
-
-
+ ID of the event.
-acs_system_id Format: UUID
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+- event_type Enum
-connected_account_id Format: UUID
+ Value: `acs_entrance.removed`
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
-created_at Format: Datetime
+- occurred_at Datetime
-Date and time at which the event was created.
-
-
+ Date and time at which the event occurred.
-event_id Format: UUID
-ID of the event.
-
-
+- workspace_id UUID
-event_type Format: Enum
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-Value: `acs_entrance.removed`
-
-occurred_at Format: Datetime
+---
-Date and time at which the event occurred.
-
-
+## Endpoints
-workspace_id Format: UUID
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
+[**`/acs/entrances/get`**](./get.md)
+
+Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+
+[**`/acs/entrances/grant_access`**](./grant_access.md)
+
+
+
+
+[**`/acs/entrances/list`**](./list.md)
+
+Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+
+[**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md)
+
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md
index f4e789016..2d71fe551 100644
--- a/docs/api/acs/entrances/get.md
+++ b/docs/api/acs/entrances/get.md
@@ -1,14 +1,60 @@
# Get an Entrance
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/entrances/get ⇒ { acs_entrance }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_entrance_id`** (Required)
+
+---
+
+
+## Response
+
+[acs\_entrance](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_entrance
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get an entrance
+
+Specify the `acs_entrance_id` of the entrance that you want to retrieve.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.entrances.get({
@@ -16,7 +62,7 @@ await seam.acs.entrances.get({
});
```
-#### Response
+#### Output
```javascript
{
@@ -29,13 +75,13 @@ await seam.acs.entrances.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```python
AcsEntrance(
@@ -48,13 +94,13 @@ AcsEntrance(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```ruby
{
@@ -67,7 +113,7 @@ seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000")
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->entrances->get(
);
```
-#### Response
+#### Output
```php
acs->entrances->get(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000"
```
-#### Response
+#### Output
```seam_cli
{
@@ -109,7 +155,7 @@ seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -127,7 +173,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}
@@ -136,20 +182,4 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance
{% endtabs %}
-## Authentication Methods
-- API key
-- Client session token
-
-## Request Parameters
-
-### `acs_entrance_id`
-
-Format: `UUID`
-Required: Yes
-
-***
-
-## Return Type
-
-[acs\_entrance](./)
diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md
index b03e71b95..a3dfab766 100644
--- a/docs/api/acs/entrances/grant_access.md
+++ b/docs/api/acs/entrances/grant_access.md
@@ -1,33 +1,41 @@
# Grant an ACS User Access to an Entrance
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/entrances/grant_access ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
-
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_entrance_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_entrance_id`** (Required)
-***
+---
-### `acs_user_id`
+**`acs_user_id`** (Required)
-Format: `UUID`
-Required: Yes
+---
-***
-## Return Type
+## Response
void
diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md
index 4a5fec5bb..df1b08d58 100644
--- a/docs/api/acs/entrances/list.md
+++ b/docs/api/acs/entrances/list.md
@@ -1,20 +1,72 @@
# List Entrances
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_credential_id`**
+
+---
+
+**`acs_system_id`**
+
+---
+
+
+## Response
+
+Array of [acs\_entrances](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_entrance
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List entrances
+
+To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.entrances.list();
```
-#### Response
+#### Output
```javascript
[
@@ -29,13 +81,13 @@ await seam.acs.entrances.list();
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.entrances.list()
```
-#### Response
+#### Output
```python
[
@@ -50,13 +102,13 @@ seam.acs.entrances.list()
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.entrances.list()
```
-#### Response
+#### Output
```ruby
[
@@ -71,14 +123,14 @@ seam.acs.entrances.list()
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->entrances->list();
```
-#### Response
+#### Output
```php
acs->entrances->list();
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs entrances list
```
-#### Response
+#### Output
```seam_cli
[
@@ -115,7 +167,7 @@ seam acs entrances list
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -125,7 +177,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}}
@@ -134,29 +186,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_credential_id`
-
-Format: `UUID`
-Required: No
-
-***
-
-### `acs_system_id`
-
-Format: `UUID`
-Required: No
-
-***
-
-## Return Type
-Array<[acs\_entrance](./)>
diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md
index ac1f2e008..2bbf9a386 100644
--- a/docs/api/acs/entrances/list_credentials_with_access.md
+++ b/docs/api/acs/entrances/list_credentials_with_access.md
@@ -1,14 +1,73 @@
# List Credentials with Access to an Entrance
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_entrance_id`** (Required)
+
+---
+
+**`include_if`** *of Enums*
+
+
+Enum values
+
+Possible enum values:
+- visionline_metadata.is_valid
+
+
+---
+
+
+## Response
+
+Array of [acs\_credentials](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_credential
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List credentials with access to an entrance
+
+Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.entrances.listCredentialsWithAccess({
@@ -16,7 +75,7 @@ await seam.acs.entrances.listCredentialsWithAccess({
});
```
-#### Response
+#### Output
```javascript
[
@@ -47,7 +106,7 @@ await seam.acs.entrances.listCredentialsWithAccess({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.entrances.list_credentials_with_access(
@@ -55,7 +114,7 @@ seam.acs.entrances.list_credentials_with_access(
)
```
-#### Response
+#### Output
```python
[
@@ -86,7 +145,7 @@ seam.acs.entrances.list_credentials_with_access(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.entrances.list_credentials_with_access(
@@ -94,7 +153,7 @@ seam.acs.entrances.list_credentials_with_access(
)
```
-#### Response
+#### Output
```ruby
[
@@ -125,7 +184,7 @@ seam.acs.entrances.list_credentials_with_access(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->entrances->list_credentials_with_access(
);
```
-#### Response
+#### Output
```php
acs->entrances->list_credentials_with_access(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000"
```
-#### Response
+#### Output
```seam_cli
[
@@ -204,7 +263,7 @@ seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -222,7 +281,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}}
@@ -231,33 +290,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_entrance_id`
-
-Format: `UUID`
-Required: Yes
-
-***
-
-### `include_if`
-
-Format: `List`
-Item format: `Enum`
-Required: No
-
-Possible enum values:
-- `visionline_metadata.is_valid`
-
-***
-
-## Return Type
-Array<[acs\_credential](./)>
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index c69a16da1..815f1d49a 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -1,6 +1,13 @@
# Systems
-## `acs_system`
+## The acs_system Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -29,519 +36,607 @@ For details about the resources associated with an access control system, see th
{% endtab %}
{% endtabs %}
-### `acs_access_group_count`
-
-Format: `Number`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ acs_access_group_count: [example value],
+ acs_system_id: [example value],
+ acs_user_count: [example value],
+ can_add_acs_users_to_acs_access_groups: [example value],
+ can_automate_enrollment: [example value],
+ can_create_acs_access_groups: [example value],
+ can_create_user: [example value],
+ can_delete_user: [example value],
+ can_remove_acs_users_from_acs_access_groups: [example value],
+ can_update_user_group_membership: [example value],
+ can_update_user_information: [example value],
+ can_update_user_schedule: [example value],
+ can_update_user_supension_state: [example value],
+ connected_account_id: [example value],
+ connected_account_ids: [example value],
+ created_at: [example value],
+ default_credential_manager_acs_system_id: [example value],
+ errors: [example value],
+ external_type: [example value],
+ external_type_display_name: [example value],
+ image_alt_text: [example value],
+ image_url: [example value],
+ is_credential_manager: [example value],
+ location: [example value],
+ name: [example value],
+ system_type: [example value],
+ system_type_display_name: [example value],
+ visionline_metadata: [example value],
+ warnings: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
---
+## Properties
-### `acs_system_id`
+**`acs_access_group_count`** *Number*
-Format: `UUID`
-ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `acs_user_count`
-
-Format: `Number`
---
-### `can_add_acs_users_to_acs_access_groups`
+**`acs_system_id`** *UUID*
-Format: `Boolean`
+ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
----
-### `can_automate_enrollment`
-Format: `Boolean`
+---
-Indicates whether it is possible to [launch enrollment automations](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+**`acs_user_count`** *Number*
----
-### `can_create_acs_access_groups`
-Format: `Boolean`
-Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
---
-### `can_create_user`
+**`can_add_acs_users_to_acs_access_groups`** *Boolean*
-Format: `Boolean`
+Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
----
-### `can_delete_user`
-Format: `Boolean`
---
-### `can_remove_acs_users_from_acs_access_groups`
+**`can_automate_enrollment`** *Boolean*
-Format: `Boolean`
-
-Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
+Indicates whether it is possible to [launch enrollment automations](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `can_update_user_group_membership`
-Format: `Boolean`
---
-### `can_update_user_information`
+**`can_create_acs_access_groups`** *Boolean*
-Format: `Boolean`
+Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
----
-### `can_update_user_schedule`
-Format: `Boolean`
---
-### `can_update_user_supension_state`
+**`can_create_user`** *Boolean*
-Format: `Boolean`
----
-### `connected_account_id`
-Format: `UUID`
-
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
---
-### `connected_account_ids`
+**`can_delete_user`** *Boolean*
-{% hint style="warning" %}
-**Deprecated**. Use `connected_account_id`.
-{% endhint %}
-Format: `List`
-Item format: `UUID`
-IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
---
-### `created_at`
-
-Format: `Datetime`
-
-Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.
+**`can_remove_acs_users_from_acs_access_groups`** *Boolean*
----
+Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
-### `default_credential_manager_acs_system_id`
-Format: `UUID`
-ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
---
-### [`errors`](./#errors-1)
+**`can_update_user_group_membership`** *Boolean*
-Format: `List`
-Item format: `Object`
-
-Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-The specific structure of each object in this list depends on the value of its `error_code` field.
-Variants:
-
-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.
- This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md).
- 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`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the error.
---
-**`error_code`**
-Format: `Enum`
-
+**`can_update_user_information`** *Boolean*
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `seam_bridge_disconnected`
-
----
-**`message`**
-Format: `String`
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+---
-
-
-bridge_disconnected
+**`can_update_user_schedule`** *Boolean*
-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`**
-Format: `Datetime`
-Date and time at which Seam created the error.
---
-**`error_code`**
-Format: `Enum`
+**`can_update_user_supension_state`** *Boolean*
+
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `bridge_disconnected`
---
-**`is_bridge_error`**
-Format: `Boolean`
+**`connected_account_id`** *UUID*
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-**`message`**
-Format: `String`
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+---
-
-
-visionline_instance_unreachable
+**`connected_account_ids`** *List* *of UUIDs*
-Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](../../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md).
- For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md).
- See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).
+IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-**`created_at`**
-Format: `Datetime`
+{% hint style="warning" %}
+**Deprecated**. Use `connected_account_id`.
+{% endhint %}
-Date and time at which Seam created the error.
---
-**`error_code`**
-Format: `Enum`
-
-
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+**`created_at`** *Datetime*
-Possible enum values:
-- `visionline_instance_unreachable`
+Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.
----
-**`message`**
-Format: `String`
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+---
-
-
-salto_ks_subscription_limit_exceeded
+**`default_credential_manager_acs_system_id`** *UUID*
-Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
+ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-**`created_at`**
-Format: `Datetime`
-Date and time at which Seam created the error.
---
-**`error_code`**
-Format: `Enum`
+[**`errors`**](./#errors) *List* *of Objects*
+Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `salto_ks_subscription_limit_exceeded`
----
-**`message`**
-Format: `String`
+The specific structure of each object in this list depends on the value of its `error_code` field.
+Variants:
+
+seam_bridge_disconnected
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+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.
+ This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md).
+ 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`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - seam_bridge_disconnected
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
-acs_system_disconnected
-
-Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue.
-
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the error.
-
----
-
-**`error_code`**
-Format: `Enum`
+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).
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - bridge_disconnected
+
+
+
+ ---
+
+ **`is_bridge_error`** Format: `Boolean`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+visionline_instance_unreachable
-Possible enum values:
-- `acs_system_disconnected`
+Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](../../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md).
+ For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md).
+ See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).
----
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - visionline_instance_unreachable
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+salto_ks_subscription_limit_exceeded
-**`message`**
-Format: `String`
+Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - salto_ks_subscription_limit_exceeded
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+acs_system_disconnected
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - acs_system_disconnected
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
account_disconnected
Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the error.
-
----
-
-**`error_code`**
-Format: `Enum`
-
-
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
-Possible enum values:
-- `account_disconnected`
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - account_disconnected
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
salto_ks_certification_expired
Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
-**`created_at`**
-Format: `Datetime`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+ **`error_code`** Format: `Enum`
+
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - salto_ks_certification_expired
+
+
+
+ ---
-Date and time at which Seam created the error.
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
---
-**`error_code`**
-Format: `Enum`
+**`external_type`** *Enum*
+Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `salto_ks_certification_expired`
+
+Enum values
----
+- pti_site
+- alta_org
+- salto_ks_site
+- salto_space_system
+- brivo_account
+- hid_credential_manager_organization
+- visionline_system
+- assa_abloy_credential_service
+- latch_building
+- dormakaba_community_site
+- legic_connect_credential_service
+- assa_abloy_vostio
+- assa_abloy_vostio_credential_service
+
-**`message`**
-Format: `String`
+---
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+**`external_type_display_name`** *String*
-
+Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
----
-### `external_type`
-Format: `Enum`
-Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
+---
-Possible enum values:
-- `pti_site`
-- `alta_org`
-- `salto_ks_site`
-- `salto_space_system`
-- `brivo_account`
-- `hid_credential_manager_organization`
-- `visionline_system`
-- `assa_abloy_credential_service`
-- `latch_building`
-- `dormakaba_community_site`
-- `legic_connect_credential_service`
-- `assa_abloy_vostio`
-- `assa_abloy_vostio_credential_service`
+**`image_alt_text`** *String*
----
+Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.
-### `external_type_display_name`
-Format: `String`
-Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
---
-### `image_alt_text`
+**`image_url`** *String*
+
+URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-Format: `String`
-Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.
---
-### `image_url`
+**`is_credential_manager`** *Boolean*
-Format: `String`
+Indicates whether the `acs_system` is a credential manager.
-URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
----
-### `is_credential_manager`
-Format: `Boolean`
+---
-Indicates whether the `acs_system` is a credential manager.
+**`location`** *Object*
----
-### `location`
-Format: `Object`
+ Child Properties
+
+ - time_zone String
-time_zone Format: String
+ Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
-Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
---
-### `name`
-
-Format: `String`
+**`name`** *String*
Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+
+
---
-### `system_type`
+**`system_type`** *Enum*
+
{% hint style="warning" %}
**Deprecated**. Use `external_type`.
{% endhint %}
-Format: `Enum`
+
+Enum values
+
+- pti_site
+- alta_org
+- salto_ks_site
+- salto_space_system
+- brivo_account
+- hid_credential_manager_organization
+- visionline_system
+- assa_abloy_credential_service
+- latch_building
+- dormakaba_community_site
+- legic_connect_credential_service
+- assa_abloy_vostio
+- assa_abloy_vostio_credential_service
+
-Possible enum values:
-- `pti_site`
-- `alta_org`
-- `salto_ks_site`
-- `salto_space_system`
-- `brivo_account`
-- `hid_credential_manager_organization`
-- `visionline_system`
-- `assa_abloy_credential_service`
-- `latch_building`
-- `dormakaba_community_site`
-- `legic_connect_credential_service`
-- `assa_abloy_vostio`
-- `assa_abloy_vostio_credential_service`
---
-### `system_type_display_name`
+**`system_type_display_name`** *String*
+
{% hint style="warning" %}
**Deprecated**. Use `external_type_display_name`.
{% endhint %}
-Format: `String`
----
-### `visionline_metadata`
+---
-Format: `Object`
+**`visionline_metadata`** *Object*
-
-lan_address Format: String
-IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-
+ Child Properties
-mobile_access_uuid Format: String
+ - lan_address String
-Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-
+ IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-
+ - mobile_access_uuid String
-system_id Format: String
+ Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
+
+ - system_id String
+
+ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
-Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
---
-### [`warnings`](./#warnings-1)
+[**`warnings`**](./#warnings) *List* *of Objects*
+
+Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-Format: `List`
-Item format: `Object`
-Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
The specific structure of each object in this list depends on the value of its `warning_code` field.
@@ -551,87 +646,93 @@ Variants:
Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the warning.
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
----
-
-**`warning_code`**
-Format: `Enum`
-
-
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
-Possible enum values:
-- `salto_ks_subscription_limit_almost_reached`
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - salto_ks_subscription_limit_almost_reached
+
+
+
time_zone_does_not_match_location
Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the warning.
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
----
-
-**`misconfigured_acs_entrance_ids`**
-Format: `List`, Item format: `UUID`
-
-
-{% hint style="warning" %}
-**Deprecated**. this field is deprecated.
-{% endhint %}
-
----
-
-**`warning_code`**
-Format: `Enum`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`misconfigured_acs_entrance_ids`** Format: `List`, Item format: `UUID`
+
+
+ {% hint style="warning" %}
+ **Deprecated**. this field is deprecated.
+ {% endhint %}
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
+ Enum values:
+
+ - time_zone_does_not_match_location
+
+
+
+
+
+---
+
+**`workspace_id`** *UUID*
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `time_zone_does_not_match_location`
-
---
-### `workspace_id`
-
-Format: `UUID`
-
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-
----
## Errors
-### `seam_bridge_disconnected`
+**`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.
This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md).
@@ -639,14 +740,14 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab
---
-### `bridge_disconnected`
+**`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).
---
-### `visionline_instance_unreachable`
+**`visionline_instance_unreachable`**
Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](../../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md).
For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md).
@@ -654,201 +755,201 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct
---
-### `salto_ks_subscription_limit_exceeded`
+**`salto_ks_subscription_limit_exceeded`**
Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
---
-### `acs_system_disconnected`
+**`acs_system_disconnected`**
Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue.
---
-### `account_disconnected`
+**`account_disconnected`**
Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.
---
-### `salto_ks_certification_expired`
+**`salto_ks_certification_expired`**
Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
---
+
## Warnings
-### `salto_ks_subscription_limit_almost_reached`
+**`salto_ks_subscription_limit_almost_reached`**
Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.
---
-### `time_zone_does_not_match_location`
+**`time_zone_does_not_match_location`**
Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
---
-## Endpoints
-### [`/acs/systems/get`](./get.md)
+## Events
-Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-### [`/acs/systems/list`](./list.md)
+**`acs_system.connected`**
-Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
-### [`/acs/systems/list_compatible_credential_manager_acs_systems`](./list_compatible_credential_manager_acs_systems.md)
+An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
-Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
----
+Properties
-## Events
+- acs_system_id UUID
-### `acs_system.connected`
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
-
+- connected_account_id UUID
-acs_system_id Format: UUID
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
-connected_account_id Format: UUID
+- created_at Datetime
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+ Date and time at which the event was created.
-created_at Format: Datetime
-Date and time at which the event was created.
-
-
+- event_id UUID
-event_id Format: UUID
+ ID of the event.
-ID of the event.
-
-
-event_type Format: Enum
+- event_type Enum
-Value: `acs_system.connected`
-
-
+ Value: `acs_system.connected`
-occurred_at Format: Datetime
-Date and time at which the event occurred.
-
-
+- occurred_at Datetime
-workspace_id Format: UUID
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
-### `acs_system.added`
+**`acs_system.added`**
An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
-acs_system_id Format: UUID
+Properties
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+- acs_system_id UUID
-connected_account_id Format: UUID
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
-created_at Format: Datetime
+- connected_account_id UUID
-Date and time at which the event was created.
-
-
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-event_id Format: UUID
-ID of the event.
-
-
+- created_at Datetime
-event_type Format: Enum
+ Date and time at which the event was created.
-Value: `acs_system.added`
-
-
-occurred_at Format: Datetime
+- event_id UUID
+
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `acs_system.added`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
-Date and time at which the event occurred.
-
-
-workspace_id Format: UUID
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
-### `acs_system.disconnected`
+**`acs_system.disconnected`**
An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
-acs_system_id Format: UUID
+Properties
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+- acs_system_id UUID
-connected_account_id Format: UUID
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
-created_at Format: Datetime
+- connected_account_id UUID
-Date and time at which the event was created.
-
-
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-event_id Format: UUID
-ID of the event.
-
-
+- created_at Datetime
-event_type Format: Enum
+ Date and time at which the event was created.
-Value: `acs_system.disconnected`
-
-
-occurred_at Format: Datetime
+- event_id UUID
-Date and time at which the event occurred.
-
-
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `acs_system.disconnected`
+
+
+- occurred_at Datetime
-workspace_id Format: UUID
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
+## Endpoints
+
+
+[**`/acs/systems/get`**](./get.md)
+
+Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+
+[**`/acs/systems/list`**](./list.md)
+
+Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
+
+
+[**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md)
+
+Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+
diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md
index a5acf3d21..a3514d12e 100644
--- a/docs/api/acs/systems/get.md
+++ b/docs/api/acs/systems/get.md
@@ -1,16 +1,65 @@
# Get an ACS System
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+Specify the desired access control system by including the corresponding `acs_system_id` in the request body.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/systems/get ⇒ { acs_system }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-Specify the desired access control system by including the corresponding `acs_system_id` in the request body.
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_system_id`** (Required)
+
+ID of the desired access control system.
+
+---
+
+
+## Response
+
+[acs\_system](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_system
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get a Specific ACS system
+
+Specify the `acs_system_id` of the ACS system that you want to retrieve.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.systems.get({
@@ -18,7 +67,7 @@ await seam.acs.systems.get({
});
```
-#### Response
+#### Output
```javascript
[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
@@ -26,13 +75,13 @@ await seam.acs.systems.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```python
[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")]
@@ -40,13 +89,13 @@ seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```ruby
[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
@@ -54,14 +103,14 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
```
-#### Response
+#### Output
```php
acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
```
-#### Response
+#### Output
```seam_cli
[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
@@ -84,7 +133,7 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -102,7 +151,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}}
@@ -111,23 +160,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_system_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired access control system.
-
-***
-
-## Return Type
-
-[acs\_system](./)
diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md
index 1f06c66db..96f315166 100644
--- a/docs/api/acs/systems/list.md
+++ b/docs/api/acs/systems/list.md
@@ -1,16 +1,66 @@
# List ACS Systems
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
+
+To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
+
-To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace.
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`connected_account_id`**
+
+ID of the connected account by which to filter the list of returned access control systems.
+
+---
+
+
+## Response
+
+Array of [acs\_systems](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_system
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List ACS systems by connected account
+
+To filter the list of ACS systems, include a `connected_account_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.systems.list({
@@ -18,7 +68,7 @@ await seam.acs.systems.list({
});
```
-#### Response
+#### Output
```javascript
[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
@@ -26,13 +76,13 @@ await seam.acs.systems.list({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```python
[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")]
@@ -40,13 +90,13 @@ seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```ruby
[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
@@ -54,7 +104,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->systems->list(
);
```
-#### Response
+#### Output
```php
acs->systems->list(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000"
```
-#### Response
+#### Output
```seam_cli
[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
@@ -86,7 +136,7 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -104,7 +154,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}}
@@ -113,24 +163,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `connected_account_id`
-
-Format: `UUID`
-Required: No
-
-ID of the connected account by which to filter the list of returned access control systems.
-
-***
-
-## Return Type
-Array<[acs\_system](./)>
diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
index fb60f14d5..ae5933420 100644
--- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
+++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
@@ -1,16 +1,65 @@
# List Compatible Credential Manager ACS Systems
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body.
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_system_id`** (Required)
+
+ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.
+
+---
+
+
+## Response
+
+Array of [acs\_systems](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_system
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List compatible credential manager ACS systems
+
+Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({
@@ -18,7 +67,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({
});
```
-#### Response
+#### Output
```javascript
[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }]
@@ -26,7 +75,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.systems.list_compatible_credential_manager_acs_systems(
@@ -34,7 +83,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems(
)
```
-#### Response
+#### Output
```python
[AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")]
@@ -42,7 +91,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.systems.list_compatible_credential_manager_acs_systems(
@@ -50,7 +99,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems(
)
```
-#### Response
+#### Output
```ruby
[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }]
@@ -58,7 +107,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->systems->list_compatible_credential_manager_acs_systems(
);
```
-#### Response
+#### Output
```php
acs->systems->list_compatible_credential_manager_acs_systems(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
```
-#### Response
+#### Output
```seam_cli
[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }]
@@ -90,7 +139,7 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -108,7 +157,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}}
@@ -117,23 +166,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_system_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.
-
-***
-
-## Return Type
-Array<[acs\_system](./)>
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
index 803a320a5..07ff5e68f 100644
--- a/docs/api/acs/users/README.md
+++ b/docs/api/acs/users/README.md
@@ -1,6 +1,13 @@
# ACS Users
-## `acs_user`
+## The acs_user Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -8,327 +15,386 @@ An `acs_user` typically refers to an individual who requires access, like an emp
For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems).
-### `access_schedule`
-
-Format: `Object`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ access_schedule: [example value],
+ acs_system_id: [example value],
+ acs_user_id: [example value],
+ created_at: [example value],
+ display_name: [example value],
+ email: [example value],
+ email_address: [example value],
+ errors: [example value],
+ external_type: [example value],
+ external_type_display_name: [example value],
+ full_name: [example value],
+ hid_acs_system_id: [example value],
+ is_managed: [example value],
+ is_suspended: [example value],
+ pending_mutations: [example value],
+ phone_number: [example value],
+ user_identity_email_address: [example value],
+ user_identity_full_name: [example value],
+ user_identity_id: [example value],
+ user_identity_phone_number: [example value],
+ warnings: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
+
+**`access_schedule`** *Object*
`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.
+
+
+ Child Properties
-ends_at Format: Datetime
+ - ends_at Datetime
-Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
+ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
+ - starts_at Datetime
-starts_at Format: Datetime
+ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
---
-### `acs_system_id`
-
-Format: `UUID`
+**`acs_system_id`** *UUID*
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-
-### `acs_user_id`
-Format: `UUID`
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
---
-### `created_at`
-
-Format: `Datetime`
+**`acs_user_id`** *UUID*
-Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
-
----
+ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### `display_name`
-Format: `String`
-Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
---
-### `email`
-
-{% hint style="warning" %}
-**Deprecated**. use email_address.
-{% endhint %}
-
-Format: `String`
+**`created_at`** *Datetime*
----
+Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
-### `email_address`
-Format: `String`
-Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
---
-### [`errors`](./#errors-1)
+**`display_name`** *String*
-Format: `List`
-
-Item format: `Object`
-
-Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-
-The specific structure of each object in this list depends on the value of its `error_code` field.
+Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Variants:
-
-deleted_externally
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
-**`created_at`**
-Format: `Datetime`
+---
-Date and time at which Seam created the error.
+**`email`** *String*
----
-**`error_code`**
-Format: `Enum`
+{% hint style="warning" %}
+**Deprecated**. use email_address.
+{% endhint %}
-Possible enum values:
-- `deleted_externally`
---
-**`message`**
-Format: `String`
+**`email_address`** *String*
+Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
-
-salto_ks_subscription_limit_exceeded
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
-**`created_at`**
-Format: `Datetime`
+---
+[**`errors`**](./#errors) *List* *of Objects*
-Date and time at which Seam created the error.
+Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-**`error_code`**
-Format: `Enum`
-Possible enum values:
-- `salto_ks_subscription_limit_exceeded`
+The specific structure of each object in this list depends on the value of its `error_code` field.
----
+Variants:
+
+deleted_externally
-**`message`**
-Format: `String`
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - deleted_externally
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+
+salto_ks_subscription_limit_exceeded
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - salto_ks_subscription_limit_exceeded
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
failed_to_create_on_acs_system
Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the error.
-
----
-
-**`error_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `failed_to_create_on_acs_system`
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - failed_to_create_on_acs_system
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
failed_to_update_on_acs_system
Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the error.
-
----
-
-**`error_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `failed_to_update_on_acs_system`
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - failed_to_update_on_acs_system
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
failed_to_delete_on_acs_system
Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which Seam created the error.
-
----
-
-**`error_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `failed_to_delete_on_acs_system`
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - failed_to_delete_on_acs_system
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
latch_conflict_with_resident_user
Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
-**`created_at`**
-Format: `Datetime`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the error.
+
+
+ ---
+
+ **`error_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - latch_conflict_with_resident_user
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+
+
+---
-Date and time at which Seam created the error.
+**`external_type`** *Enum*
----
+Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
-**`error_code`**
-Format: `Enum`
+
+Enum values
+
+- pti_user
+- brivo_user
+- hid_credential_manager_user
+- salto_site_user
+- latch_user
+- dormakaba_community_user
+- salto_space_user
+
-Possible enum values:
-- `latch_conflict_with_resident_user`
---
-**`message`**
-Format: `String`
+**`external_type_display_name`** *String*
+
+Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
-### `external_type`
+**`full_name`** *String*
+
+Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Format: `Enum`
-Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
-Possible enum values:
-- `pti_user`
-- `brivo_user`
-- `hid_credential_manager_user`
-- `salto_site_user`
-- `latch_user`
-- `dormakaba_community_user`
-- `salto_space_user`
---
-### `external_type_display_name`
+**`hid_acs_system_id`** *UUID*
-Format: `String`
-Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
----
-### `full_name`
-
-Format: `String`
-
-Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
---
-### `hid_acs_system_id`
+**`is_managed`** *Boolean*
-Format: `UUID`
----
-### `is_managed`
-Format: `Boolean`
---
-### `is_suspended`
-
-Format: `Boolean`
+**`is_suspended`** *Boolean*
Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).
----
-### `pending_mutations`
-Format: `List`
-Item format: `Object`
+---
+
+**`pending_mutations`** *List* *of Objects*
Pending mutations associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.
+
+
+
The specific structure of each object in this list depends on the value of its `mutation_code` field.
Variants:
@@ -337,275 +403,291 @@ Variants:
Seam is in the process of pushing a user creation to the integrated access system.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which the mutation was created.
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the mutation.
-
----
-
-**`mutation_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `creating`
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which the mutation was created.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the mutation.
+
+
+ ---
+
+ **`mutation_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - creating
+
+
+
deleting
Seam is in the process of pushing a user deletion to the integrated access system.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which the mutation was created.
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the mutation.
-
----
-
-**`mutation_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `deleting`
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which the mutation was created.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the mutation.
+
+
+ ---
+
+ **`mutation_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - deleting
+
+
+
updating_user_information
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which the mutation was created.
-
----
-
-**`from`**
-Format: `Object`
-
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the mutation.
-
----
-
-**`mutation_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `updating_user_information`
-
----
-
-**`to`**
-Format: `Object`
-
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which the mutation was created.
+
+
+ ---
+
+ **`from`** Format: `Object`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the mutation.
+
+
+ ---
+
+ **`mutation_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - updating_user_information
+
+
+
+ ---
+
+ **`to`** Format: `Object`
+
+
+
updating_access_schedule
Seam is in the process of pushing an access schedule update to the integrated access system.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which the mutation was created.
-
----
-
-**`from`**
-Format: `Object`
-
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the mutation.
-
----
-
-**`mutation_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `updating_access_schedule`
-
----
-
-**`to`**
-Format: `Object`
-
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which the mutation was created.
+
+
+ ---
+
+ **`from`** Format: `Object`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the mutation.
+
+
+ ---
+
+ **`mutation_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - updating_access_schedule
+
+
+
+ ---
+
+ **`to`** Format: `Object`
+
+
+
updating_suspension_state
Seam is in the process of pushing a suspension state update to the integrated access system.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which the mutation was created.
-
----
-
-**`from`**
-Format: `Object`
-
-
----
-
-**`message`**
-Format: `String`
-
-
-Detailed description of the mutation.
-
----
-
-**`mutation_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `updating_suspension_state`
-
----
-
-**`to`**
-Format: `Object`
-
-
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which the mutation was created.
+
+
+ ---
+
+ **`from`** Format: `Object`
+
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the mutation.
+
+
+ ---
+
+ **`mutation_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - updating_suspension_state
+
+
+
+ ---
+
+ **`to`** Format: `Object`
+
+
+
updating_group_membership
Seam is in the process of pushing an access group membership update to the integrated access system.
-**`created_at`**
-Format: `Datetime`
-
-
-Date and time at which the mutation was created.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which the mutation was created.
+
+
+ ---
+
+ **`from`** Format: `Object`
+
+
+ Old access group membership.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the mutation.
+
+
+ ---
+
+ **`mutation_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - updating_group_membership
+
+
+
+ ---
+
+ **`to`** Format: `Object`
+
+
+ New access group membership.
+
+
+
---
-**`from`**
-Format: `Object`
+**`phone_number`** *String*
+Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
-Old access group membership.
-
----
-
-**`message`**
-Format: `String`
-Detailed description of the mutation.
---
-**`mutation_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `updating_group_membership`
+**`user_identity_email_address`** *String*
----
-
-**`to`**
-Format: `Object`
+Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-New access group membership.
-
---
-### `phone_number`
-
-Format: `String`
-
-Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+**`user_identity_full_name`** *String*
----
+Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### `user_identity_email_address`
-Format: `String`
-Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
---
-### `user_identity_full_name`
+**`user_identity_id`** *String*
-Format: `String`
+ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
----
-### `user_identity_id`
-Format: `String`
+---
-ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+**`user_identity_phone_number`** *String*
----
+Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
-### `user_identity_phone_number`
-Format: `String`
-Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
---
-### [`warnings`](./#warnings-1)
+[**`warnings`**](./#warnings) *List* *of Objects*
+
+Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-Format: `List`
-Item format: `Object`
-Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
The specific structure of each object in this list depends on the value of its `warning_code` field.
@@ -615,333 +697,359 @@ Variants:
Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.
-**`created_at`**
-Format: `Datetime`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - being_deleted
+
+
+
+
+
+salto_ks_user_not_subscribed
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
-Date and time at which Seam created the warning.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - salto_ks_user_not_subscribed
+
+
+
+
+
+unknown_issue_with_acs_user
----
+An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
-**`message`**
-Format: `String`
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - unknown_issue_with_acs_user
+
+
+
+
+
+latch_resident_user
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+ **`created_at`** Format: `Datetime`
+
+
+ Date and time at which Seam created the warning.
+
+
+ ---
+
+ **`message`** Format: `String`
+
+
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+
+ ---
+
+ **`warning_code`** Format: `Enum`
+
+
+ Enum values:
+
+ - latch_resident_user
+
+
+
+
---
-**`warning_code`**
-Format: `Enum`
-
-
-Possible enum values:
-- `being_deleted`
+**`workspace_id`** *UUID*
-
-
-salto_ks_user_not_subscribed
-
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-**`created_at`**
-Format: `Datetime`
-Date and time at which Seam created the warning.
---
-**`message`**
-Format: `String`
+## Errors
+
+**`deleted_externally`**
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
---
-**`warning_code`**
-Format: `Enum`
+**`salto_ks_subscription_limit_exceeded`**
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
-Possible enum values:
-- `salto_ks_user_not_subscribed`
+---
-
-
-unknown_issue_with_acs_user
+**`failed_to_create_on_acs_system`**
-An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
-**`created_at`**
-Format: `Datetime`
+---
+**`failed_to_update_on_acs_system`**
-Date and time at which Seam created the warning.
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
---
-**`message`**
-Format: `String`
+**`failed_to_delete_on_acs_system`**
-
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
---
-**`warning_code`**
-Format: `Enum`
-
+**`latch_conflict_with_resident_user`**
-Possible enum values:
-- `unknown_issue_with_acs_user`
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
-
-
-latch_resident_user
+---
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
-**`created_at`**
-Format: `Datetime`
+## Warnings
+**`being_deleted`**
-Date and time at which Seam created the warning.
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.
---
-**`message`**
-Format: `String`
-
+**`salto_ks_user_not_subscribed`**
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
---
-**`warning_code`**
-Format: `Enum`
+**`unknown_issue_with_acs_user`**
+
+An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
+---
-Possible enum values:
-- `latch_resident_user`
+**`latch_resident_user`**
-
+Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
---
-### `workspace_id`
-Format: `UUID`
+## Events
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+**`acs_user.created`**
----
+An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
-## Errors
+
-### `deleted_externally`
+Properties
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
+- acs_system_id UUID
----
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-### `salto_ks_subscription_limit_exceeded`
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
+- acs_user_id UUID
----
-### `failed_to_create_on_acs_system`
+- connected_account_id UUID
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
----
-### `failed_to_update_on_acs_system`
+- created_at Datetime
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+ Date and time at which the event was created.
----
-### `failed_to_delete_on_acs_system`
+- event_id UUID
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+ ID of the event.
----
-### `latch_conflict_with_resident_user`
+- event_type Enum
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
+ Value: `acs_user.created`
----
-## Warnings
+- occurred_at Datetime
-### `being_deleted`
+ Date and time at which the event occurred.
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.
----
+- workspace_id UUID
-### `salto_ks_user_not_subscribed`
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
+
---
-### `unknown_issue_with_acs_user`
+**`acs_user.deleted`**
-An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
+An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
----
+
-### `latch_resident_user`
+Properties
-Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
+- acs_system_id UUID
----
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-## Endpoints
-### [`/acs/users/add_to_access_group`](./add_to_access_group.md)
+- acs_user_id UUID
-Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/users/create`](./create.md)
-Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### [`/acs/users/delete`](./delete.md)
+- connected_account_id UUID
-Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md).
-### [`/acs/users/get`](./get.md)
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### [`/acs/users/list`](./list.md)
-Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### [`/acs/users/list_accessible_entrances`](./list_accessible_entrances.md)
+- created_at Datetime
-Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.
-### [`/acs/users/remove_from_access_group`](./remove_from_access_group.md)
+ Date and time at which the event was created.
-Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-### [`/acs/users/revoke_access_to_all_entrances`](./revoke_access_to_all_entrances.md)
-Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-### [`/acs/users/suspend`](./suspend.md)
+- event_id UUID
-[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.
-### [`/acs/users/unsuspend`](./unsuspend.md)
+ ID of the event.
-[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.
-### [`/acs/users/update`](./update.md)
-Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+- event_type Enum
----
+ Value: `acs_user.deleted`
-## Events
-### `acs_user.created`
+- occurred_at Datetime
-An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
+ Date and time at which the event occurred.
-
-acs_system_id Format: UUID
+- workspace_id UUID
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-acs_user_id Format: UUID
-
-connected_account_id Format: UUID
+---
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+## Endpoints
-created_at Format: Datetime
-Date and time at which the event was created.
-
-
+[**`/acs/users/add_to_access_group`**](./add_to_access_group.md)
-event_id Format: UUID
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-ID of the event.
-
-
-event_type Format: Enum
+[**`/acs/users/create`**](./create.md)
-Value: `acs_user.created`
-
-
+Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-occurred_at Format: Datetime
-Date and time at which the event occurred.
-
-
+[**`/acs/users/delete`**](./delete.md)
-workspace_id Format: UUID
+Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
-### `acs_user.deleted`
+[**`/acs/users/get`**](./get.md)
-An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
+Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-
-acs_system_id Format: UUID
+[**`/acs/users/list`**](./list.md)
-ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-acs_user_id Format: UUID
-
-
-connected_account_id Format: UUID
+[**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md)
-ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
+Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.
-created_at Format: Datetime
-Date and time at which the event was created.
-
-
+[**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md)
-event_id Format: UUID
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
-ID of the event.
-
-
-event_type Format: Enum
+[**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md)
-Value: `acs_user.deleted`
-
-
+Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-occurred_at Format: Datetime
-Date and time at which the event occurred.
-
-
+[**`/acs/users/suspend`**](./suspend.md)
-workspace_id Format: UUID
+[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.
+
+
+[**`/acs/users/unsuspend`**](./unsuspend.md)
+
+[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.
+
+
+[**`/acs/users/update`**](./update.md)
+
+Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
----
diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md
index 353929c39..eee5501c2 100644
--- a/docs/api/acs/users/add_to_access_group.md
+++ b/docs/api/acs/users/add_to_access_group.md
@@ -1,14 +1,60 @@
# Add an ACS User to an Access Group
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PUT /acs/users/add_to_access_group ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_access_group_id`** (Required)
+
+ID of the desired access group.
+
+---
+
+**`acs_user_id`** (Required)
+
+ID of the desired `acs_user`.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Add an ACS user to an access group
Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.addToAccessGroup({
@@ -17,7 +63,7 @@ await seam.acs.users.addToAccessGroup({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.acs.users.addToAccessGroup({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.add_to_access_group(
@@ -34,7 +80,7 @@ seam.acs.users.add_to_access_group(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.add_to_access_group(
@@ -51,7 +97,7 @@ seam.acs.users.add_to_access_group(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->add_to_access_group(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +156,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,32 +165,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_access_group_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired access group.
-
-***
-
-### `acs_user_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired `acs_user`.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md
index 392036700..64d83c23f 100644
--- a/docs/api/acs/users/create.md
+++ b/docs/api/acs/users/create.md
@@ -1,14 +1,103 @@
# Create an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/create ⇒ { acs_user }
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_system_id`** (Required)
+
+ID of the `acs_system` to which to add the new `acs_user`.
+
+---
+
+**`full_name`** (Required)
+
+Full name of the new `acs_user`.
+
+---
+
+**`access_schedule`**
+
+`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`.
+
+---
+
+**`acs_access_group_ids`** *of UUIDs*
+
+Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.
+
+---
+
+**`email`**
+
+---
+
+**`email_address`**
+
+Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+---
+
+**`phone_number`**
+
+Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+
+---
+
+**`user_identity_id`**
+
+ID of the user identity with which to associate the new `acs_user`.
+
+---
+
+
+## Response
+
+[acs\_user](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_user
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Create a new ACS user
Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.create({
@@ -16,11 +105,10 @@ await seam.acs.users.create({
full_name: "Jane Doe",
email_address: "jane@example.com",
phone_number: "+15555550100",
- acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
});
```
-#### Response
+#### Output
```javascript
{
@@ -37,7 +125,7 @@ await seam.acs.users.create({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.create(
@@ -45,11 +133,10 @@ seam.acs.users.create(
full_name="Jane Doe",
email_address="jane@example.com",
phone_number="+15555550100",
- acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
)
```
-#### Response
+#### Output
```python
AcsUser(
@@ -66,7 +153,7 @@ AcsUser(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.create(
@@ -74,11 +161,10 @@ seam.acs.users.create(
full_name: "Jane Doe",
email_address: "jane@example.com",
phone_number: "+15555550100",
- acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
)
```
-#### Response
+#### Output
```ruby
{
@@ -95,7 +181,7 @@ seam.acs.users.create(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
- phone_number: "+15555550100",
- acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"]
+ phone_number: "+15555550100"
);
```
-#### Response
+#### Output
```php
acs->users->create(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
-seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"]
+seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100"
```
-#### Response
+#### Output
```seam_cli
{
@@ -149,7 +234,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -161,17 +246,16 @@ func main() {
client.Acs.Users.Create(
context.Background(),
users.UsersCreateRequest{
- AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
- FullName: api.String("Jane Doe"),
- EmailAddress: api.String("jane@example.com"),
- PhoneNumber: api.String("+15555550100"),
- AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")},
+ AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ FullName: api.String("Jane Doe"),
+ EmailAddress: api.String("jane@example.com"),
+ PhoneNumber: api.String("+15555550100"),
},
)
}
```
-#### Response
+#### Output
```go
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
@@ -180,99 +264,374 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
+---
-## Request Parameters
+### Create a new ACS user
-### `acs_system_id`
+Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule.
-Format: `UUID`
-Required: Yes
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Code
-ID of the `acs_system` to which to add the new `acs_user`.
+```javascript
+await seam.acs.users.create({
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ access_schedule: {
+ starts_at: "2024-11-01T15:00:00.000Z",
+ ends_at: "2024-11-04T11:00:00.000Z",
+ },
+});
+```
-***
+#### Output
-### `full_name`
+```javascript
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
-Format: `String`
-Required: Yes
+{% tab title="Python" %}
+#### Code
-Full name of the new `acs_user`.
+```python
+seam.acs.users.create(
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+ access_schedule={
+ "starts_at": "2024-11-01T15:00:00.000Z",
+ "ends_at": "2024-11-04T11:00:00.000Z",
+ },
+)
+```
-***
+#### Output
-### `access_schedule`
+```python
+AcsUser(
+ acs_user_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ workspace_id="123e4567-e89b-12d3-a456-426614174000",
+ created_at="2024-04-05T07:57:05.323Z",
+ display_name="Jane Doe",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+)
+```
+{% endtab %}
-Format: `Object`
-Required: No
+{% tab title="Ruby" %}
+#### Code
-`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`.
+```ruby
+seam.acs.users.create(
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ access_schedule: {
+ starts_at: "2024-11-01T15:00:00.000Z",
+ ends_at: "2024-11-04T11:00:00.000Z",
+ },
+)
+```
-
+#### Output
-ends_at Format: Datetime
-
+```ruby
+{
+ "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+}
+```
+{% endtab %}
-
+{% tab title="PHP" %}
+#### Code
-starts_at Format: Datetime
-
+```php
+acs->users->create(
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ access_schedule: [
+ "starts_at" => "2024-11-01T15:00:00.000Z",
+ "ends_at" => "2024-11-04T11:00:00.000Z",
+ ]
+);
+```
-***
+#### Output
-### `acs_access_group_ids`
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+];
+```
+{% endtab %}
-Format: `List`
-Item format: `UUID`
-Required: No
+{% tab title="Seam CLI" %}
+#### Code
-Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.
+```seam_cli
+seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"}
+```
+
+#### Output
+
+```seam_cli
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
-***
+{% tab title="Go" %}
+#### Code
-### `email`
+```go
+package main
-Format: `String`
-Required: No
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Create(
+ context.Background(),
+ users.UsersCreateRequest{
+ AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ FullName: api.String("Jane Doe"),
+ EmailAddress: api.String("jane@example.com"),
+ PhoneNumber: api.String("+15555550100"),
+ AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")},
+ },
+ )
+}
+```
-{% hint style="warning" %}
-**Deprecated**. use email_address.
-{% endhint %}
+#### Output
-***
+```go
+api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
+```
+{% endtab %}
-### `email_address`
+{% endtabs %}
+---
-Format: `String`
-Required: No
+### Create a new ACS user in an access group
-Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md).
-***
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Code
-### `phone_number`
+```javascript
+await seam.acs.users.create({
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
+});
+```
-Format: `String`
-Required: No
+#### Output
-Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+```javascript
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
-***
+{% tab title="Python" %}
+#### Code
-### `user_identity_id`
+```python
+seam.acs.users.create(
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+ acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
+)
+```
-Format: `UUID`
-Required: No
+#### Output
-ID of the user identity with which to associate the new `acs_user`.
+```python
+AcsUser(
+ acs_user_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ workspace_id="123e4567-e89b-12d3-a456-426614174000",
+ created_at="2024-04-05T07:57:05.323Z",
+ display_name="Jane Doe",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+)
+```
+{% endtab %}
-***
+{% tab title="Ruby" %}
+#### Code
-## Return Type
+```ruby
+seam.acs.users.create(
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
+)
+```
-[acs\_user](./)
+#### Output
+
+```ruby
+{
+ "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Code
+
+```php
+acs->users->create(
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"]
+);
+```
+
+#### Output
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Code
+
+```seam_cli
+seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"]
+```
+
+#### Output
+
+```seam_cli
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Code
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Create(
+ context.Background(),
+ users.UsersCreateRequest{
+ AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ FullName: api.String("Jane Doe"),
+ EmailAddress: api.String("jane@example.com"),
+ PhoneNumber: api.String("+15555550100"),
+ AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")},
+ },
+ )
+}
+```
+
+#### Output
+
+```go
+api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
+```
+{% endtab %}
+
+{% endtabs %}
diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md
index 6990c3f68..7207aa613 100644
--- a/docs/api/acs/users/delete.md
+++ b/docs/api/acs/users/delete.md
@@ -1,14 +1,54 @@
# Delete an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/delete ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_user_id`** (Required)
+
+ID of the desired `acs_user`.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Delete an ACS user
Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.delete({
@@ -16,7 +56,7 @@ await seam.acs.users.delete({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -24,13 +64,13 @@ await seam.acs.users.delete({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```python
None
@@ -38,13 +78,13 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```ruby
nil
@@ -52,14 +92,14 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
```
-#### Response
+#### Output
```php
null
@@ -67,13 +107,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -81,7 +121,7 @@ seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -99,7 +139,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -108,23 +148,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-## Request Parameters
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired `acs_user`.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md
index c3641ccf2..c990fea87 100644
--- a/docs/api/acs/users/get.md
+++ b/docs/api/acs/users/get.md
@@ -1,14 +1,63 @@
# Get an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/get ⇒ { acs_user }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_user_id`** (Required)
+
+ID of the desired `acs_user`.
+
+---
+
+
+## Response
+
+[acs\_user](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_user
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get a specific ACS user
+
+Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.get({
@@ -16,7 +65,7 @@ await seam.acs.users.get({
});
```
-#### Response
+#### Output
```javascript
{
@@ -33,13 +82,13 @@ await seam.acs.users.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```python
AcsUser(
@@ -56,13 +105,13 @@ AcsUser(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```ruby
{
@@ -79,14 +128,14 @@ seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
```
-#### Response
+#### Output
```php
acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
```
-#### Response
+#### Output
```seam_cli
{
@@ -127,7 +176,7 @@ seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -145,7 +194,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
@@ -154,23 +203,4 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired `acs_user`.
-
-***
-
-## Return Type
-
-[acs\_user](./)
diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md
index 002e16713..27a37db8f 100644
--- a/docs/api/acs/users/list.md
+++ b/docs/api/acs/users/list.md
@@ -1,20 +1,110 @@
# List ACS Users
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/list ⇒ { acs_users: [acs_user, …] }
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_system_id`**
+
+ID of the `acs_system` for which you want to retrieve all `acs_user`s.
+
+---
+
+**`created_before`**
+
+---
+
+**`limit`**
+
+Maximum number of records to return per page.
+
+---
+
+**`page_cursor`**
+
+Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+
+---
+
+**`search`**
+
+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`.
+
+---
+
+**`user_identity_email_address`**
+
+Email address of the user identity for which you want to retrieve all `acs_user`s.
+
+---
+
+**`user_identity_id`**
+
+ID of the user identity for which you want to retrieve all `acs_user`s.
+
+---
+
+**`user_identity_phone_number`**
+
+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`).
+
+---
+
+
+## Response
+
+Array of [acs\_users](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_user
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List all ACS users
Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.list();
```
-#### Response
+#### Output
```javascript
{
@@ -31,13 +121,13 @@ await seam.acs.users.list();
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.list()
```
-#### Response
+#### Output
```python
AcsUser(
@@ -54,13 +144,13 @@ AcsUser(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.list()
```
-#### Response
+#### Output
```ruby
{
@@ -77,14 +167,14 @@ seam.acs.users.list()
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->list();
```
-#### Response
+#### Output
```php
acs->users->list();
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users list
```
-#### Response
+#### Output
```seam_cli
{
@@ -125,7 +215,7 @@ seam acs users list
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -135,7 +225,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
@@ -144,85 +234,4 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_system_id`
-
-Format: `UUID`
-Required: No
-
-ID of the `acs_system` for which you want to retrieve all `acs_user`s.
-
-***
-
-### `created_before`
-
-Format: `Datetime`
-Required: No
-
-***
-
-### `limit`
-
-Format: `Number`
-Required: No
-
-Maximum number of records to return per page.
-
-***
-
-### `page_cursor`
-
-Format: `String`
-Required: No
-
-Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
-
-***
-
-### `search`
-
-Format: `String`
-Required: No
-
-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`.
-
-***
-
-### `user_identity_email_address`
-
-Format: `String`
-Required: No
-
-Email address of the user identity for which you want to retrieve all `acs_user`s.
-
-***
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: No
-
-ID of the user identity for which you want to retrieve all `acs_user`s.
-
-***
-
-### `user_identity_phone_number`
-
-Format: `String`
-Required: No
-
-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`).
-
-***
-
-## Return Type
-Array<[acs\_user](./)>
diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md
index 01dfa114d..c7e183802 100644
--- a/docs/api/acs/users/list_accessible_entrances.md
+++ b/docs/api/acs/users/list_accessible_entrances.md
@@ -1,29 +1,49 @@
# List ACS User-Accessible Entrances
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] }
```
+{% endtab %}
+{% endtabs %}
-Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.
+
-## Authentication Methods
+Authentication Methods
- API key
- Client session token
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_user_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_user_id`** (Required)
ID of the desired `acs_user`.
-***
+---
-## Return Type
-Array<[acs\_entrance](./)>
+## Response
+
+Array of [acs\_entrances](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_entrance
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md
index 55111a1a8..0d683acda 100644
--- a/docs/api/acs/users/remove_from_access_group.md
+++ b/docs/api/acs/users/remove_from_access_group.md
@@ -1,14 +1,60 @@
# Remove an ACS User from an Access Group
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/remove_from_access_group ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_access_group_id`** (Required)
+
+ID of the desired access group.
+
+---
+
+**`acs_user_id`** (Required)
+
+ID of the desired `acs_user`.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Remove an ACS user from an access group
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.removeFromAccessGroup({
@@ -17,7 +63,7 @@ await seam.acs.users.removeFromAccessGroup({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.acs.users.removeFromAccessGroup({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.remove_from_access_group(
@@ -34,7 +80,7 @@ seam.acs.users.remove_from_access_group(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.remove_from_access_group(
@@ -51,7 +97,7 @@ seam.acs.users.remove_from_access_group(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->remove_from_access_group(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +156,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,32 +165,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_access_group_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired access group.
-
-***
-
-### `acs_user_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired `acs_user`.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md
index 9dec79059..9b4e5c40d 100644
--- a/docs/api/acs/users/revoke_access_to_all_entrances.md
+++ b/docs/api/acs/users/revoke_access_to_all_entrances.md
@@ -1,28 +1,39 @@
# Revoke ACS User Access to All Entrances
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/revoke_access_to_all_entrances ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_user_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`acs_user_id`** (Required)
ID of the desired `acs_user`.
-***
+---
+
-## Return Type
+## Response
void
diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md
index 00049298f..af10e9baf 100644
--- a/docs/api/acs/users/suspend.md
+++ b/docs/api/acs/users/suspend.md
@@ -1,14 +1,54 @@
# Suspend an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/suspend ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_user_id`** (Required)
+
+ID of the desired `acs_user`.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Suspend an ACS user
[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.suspend({
@@ -16,7 +56,7 @@ await seam.acs.users.suspend({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -24,13 +64,13 @@ await seam.acs.users.suspend({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```python
None
@@ -38,13 +78,13 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```ruby
nil
@@ -52,14 +92,14 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
```
-#### Response
+#### Output
```php
null
@@ -67,13 +107,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -81,7 +121,7 @@ seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -99,7 +139,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -108,23 +148,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-## Request Parameters
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired `acs_user`.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md
index 5ffa24617..a0f9a4533 100644
--- a/docs/api/acs/users/unsuspend.md
+++ b/docs/api/acs/users/unsuspend.md
@@ -1,14 +1,54 @@
# Unsuspend an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /acs/users/unsuspend ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_user_id`** (Required)
+
+ID of the desired `acs_user`.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Unsuspend an ACS user
[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.unsuspend({
@@ -16,7 +56,7 @@ await seam.acs.users.unsuspend({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -24,13 +64,13 @@ await seam.acs.users.unsuspend({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```python
None
@@ -38,13 +78,13 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```
-#### Response
+#### Output
```ruby
nil
@@ -52,7 +92,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->unsuspend(
);
```
-#### Response
+#### Output
```php
null
@@ -69,13 +109,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -83,7 +123,7 @@ seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -101,7 +141,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -110,23 +150,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-## Request Parameters
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired `acs_user`.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md
index d55e3203c..2f2d0d5ac 100644
--- a/docs/api/acs/users/update.md
+++ b/docs/api/acs/users/update.md
@@ -1,14 +1,86 @@
# Update an ACS User
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /acs/users/update ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_user_id`** (Required)
+
+ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+---
+
+**`access_schedule`**
+
+`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`.
+
+---
+
+**`email`**
+
+---
+
+**`email_address`**
+
+Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+---
+
+**`full_name`**
+
+Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+---
+
+**`hid_acs_system_id`**
+
+---
+
+**`phone_number`**
+
+Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Update an ACS user
+
+Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.acs.users.update({
@@ -17,7 +89,7 @@ await seam.acs.users.update({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +97,7 @@ await seam.acs.users.update({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.acs.users.update(
@@ -33,7 +105,7 @@ seam.acs.users.update(
)
```
-#### Response
+#### Output
```python
None
@@ -41,7 +113,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.acs.users.update(
@@ -50,7 +122,7 @@ seam.acs.users.update(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -58,7 +130,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
acs->users->update(
);
```
-#### Response
+#### Output
```php
null
@@ -76,13 +148,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -90,7 +162,7 @@ seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --pho
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -109,7 +181,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -118,87 +190,4 @@ nil
{% endtabs %}
-## Authentication Methods
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-
-***
-
-### `access_schedule`
-
-Format: `Object`
-Required: No
-
-`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`.
-
-
-
-ends_at Format: Datetime
-
-
-
-
-starts_at Format: Datetime
-
-
-***
-
-### `email`
-
-Format: `String`
-Required: No
-
-{% hint style="warning" %}
-**Deprecated**. use email_address.
-{% endhint %}
-
-***
-
-### `email_address`
-
-Format: `String`
-Required: No
-
-Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-
-***
-
-### `full_name`
-
-Format: `String`
-Required: No
-
-Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
-
-***
-
-### `hid_acs_system_id`
-
-Format: `UUID`
-Required: No
-
-***
-
-### `phone_number`
-
-Format: `String`
-Required: No
-
-Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index b24e72222..e39a8bcff 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -1,217 +1,237 @@
# Phones
-## `phone`
+## The phone Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
Represents an app user's mobile phone.
-### `created_at`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ created_at: [example value],
+ custom_metadata: [example value],
+ device_id: [example value],
+ device_type: [example value],
+ display_name: [example value],
+ errors: [example value],
+ nickname: [example value],
+ properties: [example value],
+ warnings: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
-Format: `Datetime`
+**`created_at`** *Datetime*
Date and time at which the `phone` was created.
----
-### `custom_metadata`
-Format: `Record`
+
+---
+
+**`custom_metadata`** *Record*
Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone.
----
-### `device_id`
-Format: `UUID`
+
+---
+
+**`device_id`** *UUID*
ID of the `phone`.
----
-### `device_type`
-Format: `Enum`
+
+---
+
+**`device_type`** *Enum*
Type of phone.
-Possible enum values:
-- `ios_phone`
-- `android_phone`
----
+
+Enum values
+
+- ios_phone
+- android_phone
+
-### `display_name`
-Format: `String`
+---
+
+**`display_name`** *String*
Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
----
-### `errors`
-Format: `List`
-Item format: `Object`
+---
+
+**`errors`** *List* *of Objects*
Errors associated with the `phone`.
-
-error_code Format: String
-
-
-message Format: String
+ Child Object Properties
+ error_code String
+ message String
---
-### `nickname`
-
-Format: `String`
+**`nickname`** *String*
Optional nickname to describe the phone, settable through Seam.
----
-### `properties`
-Format: `Object`
-Properties of the phone.
+---
-
+**`properties`** *Object*
+
+Properties of the phone.
-assa_abloy_credential_service_metadata Format: Object
-ASSA ABLOY Credential Service metadata for the phone.
-
+ Child Properties
+
+ - assa_abloy_credential_service_metadata Object
+
+ ASSA ABLOY Credential Service metadata for the phone.
-assa_abloy_credential_service_metadata.endpoints Format: List Item format: Object
+ - assa_abloy_credential_service_metadata.endpoints List of Objects
-Endpoints associated with the phone.
+ Endpoints associated with the phone.
-- endpoint_id Format: String
+- endpoint_id String
ID of the associated endpoint.
-- is_active Format: Boolean
+- is_active Boolean
Indicated whether the endpoint is active.
-
-
+ - assa_abloy_credential_service_metadata.has_active_endpoint Boolean
-assa_abloy_credential_service_metadata.has_active_endpoint Format: Boolean
+ Indicates whether the credential service has active endpoints associated with the phone.
-Indicates whether the credential service has active endpoints associated with the phone.
-
+ - salto_space_credential_service_metadata Object
-
+ Salto Space credential service metadata for the phone.
+
+ - salto_space_credential_service_metadata.has_active_phone Boolean
-salto_space_credential_service_metadata Format: Object
+ Indicates whether the credential service has an active associated phone.
-Salto Space credential service metadata for the phone.
-
+---
+
+**`warnings`** *List* *of Objects*
+
+Warnings associated with the `phone`.
+
-salto_space_credential_service_metadata.has_active_phone Format: Boolean
-Indicates whether the credential service has an active associated phone.
+
+ Child Object Properties
+ message String
+ warning_code String
---
-### `warnings`
+**`workspace_id`** *UUID*
-Format: `List`
+ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`.
-Item format: `Object`
-Warnings associated with the `phone`.
-
-message Format: String
-
+---
+
+
+## Events
+
+**`phone.deactivated`**
+
+A phone device was deactivated.
-warning_code Format: String
-
+Properties
----
+- created_at Datetime
-### `workspace_id`
+ Date and time at which the event was created.
-Format: `UUID`
-ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`.
+- device_id UUID
----
+ ID of the [device](../../core-concepts/devices/README.md).
-## Endpoints
-### [`/phones/deactivate`](./deactivate.md)
+- event_id UUID
-Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process).
-### [`/phones/get`](./get.md)
+ ID of the event.
-Returns a single phone entry matching the provided `device_id`.
-### [`/phones/list`](./list.md)
-Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+- event_type Enum
----
+ Value: `phone.deactivated`
-## Events
-### `phone.deactivated`
+- occurred_at Datetime
-A phone device was deactivated.
+ Date and time at which the event occurred.
-
-created_at Format: Datetime
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
-Date and time at which the event was created.
-
-device_id Format: UUID
+---
-ID of the [device](../../core-concepts/devices/README.md).
-
-
+## Endpoints
-event_id Format: UUID
-ID of the event.
-
-
+[**`/phones/deactivate`**](./deactivate.md)
-event_type Format: Enum
+Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process).
-Value: `phone.deactivated`
-
-
-occurred_at Format: Datetime
+[**`/phones/get`**](./get.md)
-Date and time at which the event occurred.
-
-
+Returns a single phone entry matching the provided `device_id`.
-workspace_id Format: UUID
-ID of the [workspace](../../core-concepts/workspaces/README.md).
-
----
+[**`/phones/list`**](./list.md)
+
+Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+
diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md
index df72e2816..3d4f122a3 100644
--- a/docs/api/phones/deactivate.md
+++ b/docs/api/phones/deactivate.md
@@ -1,29 +1,40 @@
# Deactivate a Phone
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /phones/deactivate ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process).
+
-## Authentication Methods
+Authentication Methods
- API key
- Client session token
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `device_id`
+## Request Parameters
-Format: `String`
-Required: Yes
+**`device_id`** (Required)
Device ID of the desired phone.
-***
+---
+
-## Return Type
+## Response
void
diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md
index a76360d2c..facf02c0f 100644
--- a/docs/api/phones/get.md
+++ b/docs/api/phones/get.md
@@ -1,28 +1,48 @@
# Get Phone
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a single phone entry matching the provided `device_id`.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /phones/get ⇒ { phone }
```
+{% endtab %}
+{% endtabs %}
-Returns a single phone entry matching the provided `device_id`.
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `device_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`device_id`** (Required)
Device ID of the desired phone.
-***
+---
-## Return Type
+
+## Response
[phone](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of phone
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md
index 37b95939d..8c5028946 100644
--- a/docs/api/phones/list.md
+++ b/docs/api/phones/list.md
@@ -1,37 +1,54 @@
# List Phones
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /phones/list ⇒ { phones: [phone, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `acs_credential_id`
+## Request Parameters
-Format: `UUID`
-Required: No
+**`acs_credential_id`**
ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones.
-***
-
-### `owner_user_identity_id`
+---
-Format: `UUID`
-Required: No
+**`owner_user_identity_id`**
ID of the user identity that represents the owner by which to filter the list of returned phones.
-***
+---
-## Return Type
-Array<[phone](./)>
+## Response
+
+Array of [phones](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of phone
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md
index e361df769..f40205492 100644
--- a/docs/api/phones/simulate/README.md
+++ b/docs/api/phones/simulate/README.md
@@ -2,6 +2,9 @@
## Endpoints
-### [`/phones/simulate/create_sandbox_phone`](./create_sandbox_phone.md)
+
+[**`/phones/simulate/create_sandbox_phone`**](./create_sandbox_phone.md)
Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).
+
+
diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md
index fe4fd3c69..2153e42c7 100644
--- a/docs/api/phones/simulate/create_sandbox_phone.md
+++ b/docs/api/phones/simulate/create_sandbox_phone.md
@@ -1,129 +1,66 @@
# Create a Sandbox Phone
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /phones/simulate/create_sandbox_phone ⇒ { phone }
```
+{% endtab %}
+{% endtabs %}
-Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `user_identity_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`user_identity_id`** (Required)
ID of the user identity to associate with the simulated phone.
-***
+---
-### `assa_abloy_metadata`
-
-Format: `Object`
-Required: No
+**`assa_abloy_metadata`**
ASSA ABLOY metadata to associate with the simulated phone.
-
-
-application_version Format: String
-
-Application version that you want to use for the simulated phone.
-
-
-
-
-ble_capability Format: Boolean
-
-Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.
-
-
-
-
-hce_capability Format: Boolean
-
-Indicates whether the simulated phone should have host card emulation (HCE) capability.
-
-
-
-
-nfc_capability Format: Boolean
-
-Indicates whether the simulated phone should have near-field communication (NFC) capability.
-
-
-
-
-seos_applet_version Format: String
+---
-SEOS applet version that you want to use for the simulated phone.
-
-
-
-
-seos_tsm_endpoint_id Format: Number
-
-ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.
-
-
-***
-
-### `custom_sdk_installation_id`
-
-Format: `String`
-Required: No
+**`custom_sdk_installation_id`**
ID of the custom SDK installation to use for the simulated phone.
-***
-
-### `phone_metadata`
+---
-Format: `Object`
-Required: No
+**`phone_metadata`**
Metadata to associate with the simulated phone.
-
-
-device_manufacturer Format: String
+---
-Manufacturer that you want to use for the simulated phone.
-
-
-
-device_model Format: String
-
-Device model that you want to use for the simulated phone.
-
-
-
-
-operating_system Format: Enum
-
-Mobile operating system that you want to use for the simulated phone.
-
-Possible enum values:
-- `android`
-- `ios`
-
-
-
-
-os_version Format: String
-
-Mobile operating system version that you want to use for the simulated phone.
-
-
-***
-
-## Return Type
+## Response
[phone](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of phone
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md
index 7b588df9a..b4a0bf881 100644
--- a/docs/api/thermostats/README.md
+++ b/docs/api/thermostats/README.md
@@ -1,519 +1,510 @@
# Thermostats
-## Endpoints
-### [`/thermostats/activate_climate_preset`](./activate_climate_preset.md)
+## Events
-Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/cool`](./cool.md)
+**`thermostat.climate_preset_activated`**
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/create_climate_preset`](./create_climate_preset.md)
+A thermostat [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) was activated.
-Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/delete_climate_preset`](./delete_climate_preset.md)
+
-Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/heat`](./heat.md)
+Properties
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/heat_cool`](./heat_cool.md)
+- climate_preset_key String
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/list`](./list.md)
+ Key of the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated.
-Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/off`](./off.md)
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
-### [`/thermostats/set_fallback_climate_preset`](./set_fallback_climate_preset.md)
+- connected_account_id UUID
-Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/set_fan_mode`](./set_fan_mode.md)
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/set_hvac_mode`](./set_hvac_mode.md)
-Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/set_temperature_threshold`](./set_temperature_threshold.md)
+- created_at Datetime
-Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
-### [`/thermostats/update_climate_preset`](./update_climate_preset.md)
+ Date and time at which the event was created.
-Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
----
+- device_id UUID
-## Events
+ ID of the device.
-### `thermostat.climate_preset_activated`
-A thermostat [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) was activated.
+- event_id UUID
-
+ ID of the event.
-climate_preset_key Format: String
-Key of the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated.
-
-
+- event_type Enum
-connected_account_id Format: UUID
+ Value: `thermostat.climate_preset_activated`
-ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-
-
-created_at Format: Datetime
+- is_fallback_climate_preset Boolean
-Date and time at which the event was created.
-
-
+ Indicates whether the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated is the [fallback climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-device_id Format: UUID
-ID of the device.
-
-
+- occurred_at Datetime
-event_id Format: UUID
+ Date and time at which the event occurred.
-ID of the event.
-
-
-event_type Format: Enum
+- thermostat_schedule_id UUID
-Value: `thermostat.climate_preset_activated`
-
-
+ ID of the [thermostat schedule](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that prompted the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to be activated.
-is_fallback_climate_preset Format: Boolean
-Indicates whether the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated is the [fallback climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+- workspace_id UUID
-occurred_at Format: Datetime
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
-Date and time at which the event occurred.
-
-thermostat_schedule_id Format: UUID
+---
+
+**`thermostat.manually_adjusted`**
+
+A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.
-ID of the [thermostat schedule](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that prompted the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to be activated.
-
-workspace_id Format: UUID
+Properties
-ID of the [workspace](../../core-concepts/workspaces/README.md).
-
----
+- connected_account_id UUID
-### `thermostat.manually_adjusted`
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.
-
+- cooling_set_point_celsius Number
-connected_account_id Format: UUID
+ Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-
-
-cooling_set_point_celsius Format: Number
+- cooling_set_point_fahrenheit Number
-Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-
+ Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-cooling_set_point_fahrenheit Format: Number
-Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-
+- created_at Datetime
-created_at Format: Datetime
+ Date and time at which the event was created.
-Date and time at which the event was created.
-
-
-device_id Format: UUID
+- device_id UUID
-ID of the device.
-
-
+ ID of the device.
-event_id Format: UUID
-ID of the event.
-
-
+- event_id UUID
-event_type Format: Enum
+ ID of the event.
-Value: `thermostat.manually_adjusted`
-
-
-fan_mode_setting Format: Enum
+- event_type Enum
-Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+ Value: `thermostat.manually_adjusted`
-Possible enum values:
-- `auto`
-- `on`
-- `circulate`
-
-
-heating_set_point_celsius Format: Number
+- fan_mode_setting Enum
-Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
+ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+ Enum values:
-heating_set_point_fahrenheit Format: Number
-
-Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+ - auto`
+ - on`
+ - circulate`
-
-hvac_mode_setting Format: Enum
-Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+- heating_set_point_celsius Number
-Possible enum values:
-- `off`
-- `heat`
-- `cool`
-- `heat_cool`
-
-
+ Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-method Format: Enum
-Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+- heating_set_point_fahrenheit Number
+
+ Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-Possible enum values:
-- `seam`
-- `external`
-
-
-occurred_at Format: Datetime
+- hvac_mode_setting Enum
-Date and time at which the event occurred.
+ Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+
+ Enum values:
+
+ - off`
+ - heat`
+ - cool`
+ - heat_cool`
+
+
+- method Enum
+
+ Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+ Enum values:
+
+ - seam`
+ - external`
+
+
+
+- occurred_at Datetime
-workspace_id Format: UUID
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../core-concepts/workspaces/README.md).
+
---
-### `thermostat.temperature_threshold_exceeded`
+**`thermostat.temperature_threshold_exceeded`**
A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading exceeded the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-connected_account_id Format: UUID
+Properties
-ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-
-
+- connected_account_id UUID
-created_at Format: Datetime
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-Date and time at which the event was created.
-
-
-device_id Format: UUID
+- created_at Datetime
-ID of the device.
-
-
+ Date and time at which the event was created.
-event_id Format: UUID
-ID of the event.
-
-
+- device_id UUID
-event_type Format: Enum
+ ID of the device.
-Value: `thermostat.temperature_threshold_exceeded`
-
-
-lower_limit_celsius Format: Number
+- event_id UUID
-Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
+ ID of the event.
-lower_limit_fahrenheit Format: Number
-Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
+- event_type Enum
-occurred_at Format: Datetime
+ Value: `thermostat.temperature_threshold_exceeded`
-Date and time at which the event occurred.
-
-
-temperature_celsius Format: Number
+- lower_limit_celsius Number
-Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+ Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-temperature_fahrenheit Format: Number
-Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+- lower_limit_fahrenheit Number
-upper_limit_celsius Format: Number
+ Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
-upper_limit_fahrenheit Format: Number
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- temperature_celsius Number
+
+ Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+- temperature_fahrenheit Number
+
+ Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
-workspace_id Format: UUID
+- upper_limit_celsius Number
+
+ Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
+
+
+- upper_limit_fahrenheit Number
+
+ Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../core-concepts/workspaces/README.md).
+
---
-### `thermostat.temperature_threshold_no_longer_exceeded`
+**`thermostat.temperature_threshold_no_longer_exceeded`**
A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-connected_account_id Format: UUID
+Properties
-ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-
-
+- connected_account_id UUID
-created_at Format: Datetime
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-Date and time at which the event was created.
-
-
-device_id Format: UUID
+- created_at Datetime
-ID of the device.
-
-
+ Date and time at which the event was created.
-event_id Format: UUID
-ID of the event.
-
-
+- device_id UUID
-event_type Format: Enum
+ ID of the device.
-Value: `thermostat.temperature_threshold_no_longer_exceeded`
-
-
-lower_limit_celsius Format: Number
+- event_id UUID
-Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
+ ID of the event.
-lower_limit_fahrenheit Format: Number
-Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
+- event_type Enum
-occurred_at Format: Datetime
+ Value: `thermostat.temperature_threshold_no_longer_exceeded`
-Date and time at which the event occurred.
-
-
-temperature_celsius Format: Number
+- lower_limit_celsius Number
-Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+ Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-temperature_fahrenheit Format: Number
-Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+- lower_limit_fahrenheit Number
-upper_limit_celsius Format: Number
+ Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
-upper_limit_fahrenheit Format: Number
+- occurred_at Datetime
-Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
-
-
+ Date and time at which the event occurred.
+
+
+- temperature_celsius Number
+
+ Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+- temperature_fahrenheit Number
+
+ Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+- upper_limit_celsius Number
+
+ Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
+
+
+- upper_limit_fahrenheit Number
-workspace_id Format: UUID
+ Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../core-concepts/workspaces/README.md).
+
---
-### `thermostat.temperature_reached_set_point`
+**`thermostat.temperature_reached_set_point`**
A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-connected_account_id Format: UUID
+Properties
-ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-
-
+- connected_account_id UUID
-created_at Format: Datetime
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-Date and time at which the event was created.
-
-
-desired_temperature_celsius Format: Number
+- created_at Datetime
-Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-
+ Date and time at which the event was created.
-desired_temperature_fahrenheit Format: Number
-Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-
+- desired_temperature_celsius Number
-device_id Format: UUID
+ Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-ID of the device.
-
-
-event_id Format: UUID
+- desired_temperature_fahrenheit Number
-ID of the event.
-
-
+ Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-event_type Format: Enum
-Value: `thermostat.temperature_reached_set_point`
-
-
+- device_id UUID
-occurred_at Format: Datetime
+ ID of the device.
-Date and time at which the event occurred.
-
-
-temperature_celsius Format: Number
+- event_id UUID
-Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+ ID of the event.
-temperature_fahrenheit Format: Number
-Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+- event_type Enum
+
+ Value: `thermostat.temperature_reached_set_point`
+
+
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- temperature_celsius Number
+
+ Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+- temperature_fahrenheit Number
+
+ Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-workspace_id Format: UUID
-ID of the [workspace](../../core-concepts/workspaces/README.md).
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
+
+
---
-### `thermostat.temperature_changed`
+**`thermostat.temperature_changed`**
A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 °C.
-connected_account_id Format: UUID
+Properties
-ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-
-
+- connected_account_id UUID
-created_at Format: Datetime
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
-Date and time at which the event was created.
-
-
-device_id Format: UUID
+- created_at Datetime
-ID of the device.
-
-
+ Date and time at which the event was created.
-event_id Format: UUID
-ID of the event.
-
-
+- device_id UUID
-event_type Format: Enum
+ ID of the device.
-Value: `thermostat.temperature_changed`
-
-
-occurred_at Format: Datetime
+- event_id UUID
-Date and time at which the event occurred.
-
-
+ ID of the event.
-temperature_celsius Format: Number
-Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
+- event_type Enum
-temperature_fahrenheit Format: Number
+ Value: `thermostat.temperature_changed`
-Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-
-
-workspace_id Format: UUID
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- temperature_celsius Number
+
+ Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+- temperature_fahrenheit Number
+
+ Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../core-concepts/workspaces/README.md).
+
---
+## Endpoints
+
+
+[**`/thermostats/activate_climate_preset`**](./activate_climate_preset.md)
+
+Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+[**`/thermostats/cool`**](./cool.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+
+[**`/thermostats/create_climate_preset`**](./create_climate_preset.md)
+
+Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+[**`/thermostats/delete_climate_preset`**](./delete_climate_preset.md)
+
+Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+[**`/thermostats/heat`**](./heat.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+
+[**`/thermostats/heat_cool`**](./heat_cool.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+
+[**`/thermostats/list`**](./list.md)
+
+Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+[**`/thermostats/off`**](./off.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+
+[**`/thermostats/set_fallback_climate_preset`**](./set_fallback_climate_preset.md)
+
+Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+[**`/thermostats/set_fan_mode`**](./set_fan_mode.md)
+
+Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+[**`/thermostats/set_hvac_mode`**](./set_hvac_mode.md)
+
+Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+[**`/thermostats/set_temperature_threshold`**](./set_temperature_threshold.md)
+
+Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
+
+
+[**`/thermostats/update_climate_preset`**](./update_climate_preset.md)
+
+Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
index a57f5e365..d25d25825 100644
--- a/docs/api/thermostats/activate_climate_preset.md
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -1,14 +1,75 @@
# Activate a Climate Preset
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/activate_climate_preset ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`climate_preset_key`** (Required)
+
+Climate preset key of the desired climate preset.
+
+---
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+
+## Response
+
+[action\_attempt](./)
+
+**`ACTIVATE_CLIMATE_PRESET`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Activate a climate preset
+
+Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.activateClimatePreset({
@@ -17,7 +78,7 @@ await seam.thermostats.activateClimatePreset({
});
```
-#### Response
+#### Output
```javascript
{
@@ -29,7 +90,7 @@ await seam.thermostats.activateClimatePreset({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.activate_climate_preset(
@@ -37,7 +98,7 @@ seam.thermostats.activate_climate_preset(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -49,7 +110,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.activate_climate_preset(
@@ -58,7 +119,7 @@ seam.thermostats.activate_climate_preset(
)
```
-#### Response
+#### Output
```ruby
{
@@ -70,7 +131,7 @@ seam.thermostats.activate_climate_preset(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->activate_climate_preset(
);
```
-#### Response
+#### Output
```php
thermostats->activate_climate_preset(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied"
```
-#### Response
+#### Output
```seam_cli
{
@@ -111,7 +172,7 @@ seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-42
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -129,7 +190,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"}
@@ -138,88 +199,4 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `climate_preset_key`
-
-Format: `String`
-Required: Yes
-
-Climate preset key of the desired climate preset.
-
-***
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `ACTIVATE_CLIMATE_PRESET`
-
-Activating climate preset.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `ACTIVATE_CLIMATE_PRESET`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: String
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-#### `status`
-
-Format: `Enum`
-
-Possible enum values:
-- `success`
-- `pending`
-- `error`
-
----
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
index fc5c62af7..e252c3b44 100644
--- a/docs/api/thermostats/cool.md
+++ b/docs/api/thermostats/cool.md
@@ -1,14 +1,82 @@
# Set to Cool Mode
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/cool ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`cooling_set_point_celsius`**
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
+
+---
+
+**`cooling_set_point_fahrenheit`**
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
+
+---
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_HVAC_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set to cool mode
+
+Specify the desired cooling set point in °C or °F.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.cool({
@@ -17,7 +85,7 @@ await seam.thermostats.cool({
});
```
-#### Response
+#### Output
```javascript
{
@@ -29,7 +97,7 @@ await seam.thermostats.cool({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.cool(
@@ -37,7 +105,7 @@ seam.thermostats.cool(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -49,7 +117,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.cool(
@@ -58,7 +126,7 @@ seam.thermostats.cool(
)
```
-#### Response
+#### Output
```ruby
{
@@ -70,7 +138,7 @@ seam.thermostats.cool(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->cool(
);
```
-#### Response
+#### Output
```php
thermostats->cool(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25
```
-#### Response
+#### Output
```seam_cli
{
@@ -111,7 +179,7 @@ seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooli
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -129,7 +197,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"}
@@ -138,98 +206,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `cooling_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
-
-***
-
-### `cooling_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `SET_HVAC_MODE`
-
-Setting HVAC mode.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `SET_HVAC_MODE`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: String
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-#### `status`
-
-Format: `Enum`
-
-Possible enum values:
-- `success`
-- `pending`
-- `error`
-
----
diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md
index e05970bad..84feed414 100644
--- a/docs/api/thermostats/create_climate_preset.md
+++ b/docs/api/thermostats/create_climate_preset.md
@@ -1,14 +1,109 @@
# Create a Climate Preset
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/create_climate_preset ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`climate_preset_key`** (Required)
+
+Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+
+---
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`cooling_set_point_celsius`**
+
+Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`cooling_set_point_fahrenheit`**
+
+Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`fan_mode_setting`**
+
+Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+
+---
+
+**`heating_set_point_celsius`**
+
+Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`heating_set_point_fahrenheit`**
+
+Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`hvac_mode_setting`**
+
+Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+
+---
+
+**`manual_override_allowed`**
+
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
+
+---
+
+**`name`**
+
+User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Create a climate preset
+
+Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.createClimatePreset({
@@ -23,7 +118,7 @@ await seam.thermostats.createClimatePreset({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -31,7 +126,7 @@ await seam.thermostats.createClimatePreset({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.create_climate_preset(
@@ -46,7 +141,7 @@ seam.thermostats.create_climate_preset(
)
```
-#### Response
+#### Output
```python
None
@@ -54,7 +149,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.create_climate_preset(
@@ -69,7 +164,7 @@ seam.thermostats.create_climate_preset(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -77,7 +172,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->create_climate_preset(
);
```
-#### Response
+#### Output
```php
null
@@ -101,13 +196,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true
```
-#### Response
+#### Output
```seam_cli
{}
@@ -115,7 +210,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -139,7 +234,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -148,120 +243,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `climate_preset_key`
-
-Format: `String`
-Required: Yes
-
-Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
-
-***
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `cooling_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `cooling_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `fan_mode_setting`
-
-Format: `Enum`
-Required: No
-
-Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
-Possible enum values:
-- `auto`
-- `on`
-- `circulate`
-
-***
-
-### `heating_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `heating_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `hvac_mode_setting`
-
-Format: `Enum`
-Required: No
-
-Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
-
-Possible enum values:
-- `off`
-- `heat`
-- `cool`
-- `heat_cool`
-
-***
-
-### `manual_override_allowed`
-
-Format: `Boolean`
-Required: No
-
-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`
-
-Format: `String`
-Required: No
-
-User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md
index c1530ab8e..c47abea6d 100644
--- a/docs/api/thermostats/delete_climate_preset.md
+++ b/docs/api/thermostats/delete_climate_preset.md
@@ -1,14 +1,61 @@
# Delete a Climate Preset
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/delete_climate_preset ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`climate_preset_key`** (Required)
+
+Climate preset key of the desired climate preset.
+
+---
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Delete a climate preset
+
+Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.deleteClimatePreset({
@@ -17,7 +64,7 @@ await seam.thermostats.deleteClimatePreset({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +72,7 @@ await seam.thermostats.deleteClimatePreset({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.delete_climate_preset(
@@ -33,7 +80,7 @@ seam.thermostats.delete_climate_preset(
)
```
-#### Response
+#### Output
```python
None
@@ -41,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.delete_climate_preset(
@@ -50,7 +97,7 @@ seam.thermostats.delete_climate_preset(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -58,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->delete_climate_preset(
);
```
-#### Response
+#### Output
```php
null
@@ -76,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -90,7 +137,7 @@ seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-4266
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -108,7 +155,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -117,33 +164,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-### `climate_preset_key`
-
-Format: `String`
-Required: Yes
-
-Climate preset key of the desired climate preset.
-
-***
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
index 28b5d99e9..75ad94fcb 100644
--- a/docs/api/thermostats/heat.md
+++ b/docs/api/thermostats/heat.md
@@ -1,14 +1,82 @@
# Set to Heat Mode
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/heat ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`heating_set_point_celsius`**
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
+
+---
+
+**`heating_set_point_fahrenheit`**
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
+
+---
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_HVAC_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set to heat mode
+
+Specify the desired heating set point in °C or °F.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.heat({
@@ -17,7 +85,7 @@ await seam.thermostats.heat({
});
```
-#### Response
+#### Output
```javascript
{
@@ -29,7 +97,7 @@ await seam.thermostats.heat({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.heat(
@@ -37,7 +105,7 @@ seam.thermostats.heat(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -49,7 +117,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.heat(
@@ -58,7 +126,7 @@ seam.thermostats.heat(
)
```
-#### Response
+#### Output
```ruby
{
@@ -70,7 +138,7 @@ seam.thermostats.heat(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->heat(
);
```
-#### Response
+#### Output
```php
thermostats->heat(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20
```
-#### Response
+#### Output
```seam_cli
{
@@ -111,7 +179,7 @@ seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heati
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -129,7 +197,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"}
@@ -138,98 +206,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `heating_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
-
-***
-
-### `heating_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `SET_HVAC_MODE`
-
-Setting HVAC mode.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `SET_HVAC_MODE`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: String
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-#### `status`
-
-Format: `Enum`
-
-Possible enum values:
-- `success`
-- `pending`
-- `error`
-
----
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
index fe71a1613..cb56f47a3 100644
--- a/docs/api/thermostats/heat_cool.md
+++ b/docs/api/thermostats/heat_cool.md
@@ -1,14 +1,94 @@
# Set to Heat-Cool (Auto) Mode
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/heat_cool ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`cooling_set_point_celsius`**
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
+
+---
+
+**`cooling_set_point_fahrenheit`**
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
+
+---
+
+**`heating_set_point_celsius`**
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
+
+---
+
+**`heating_set_point_fahrenheit`**
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
+
+---
+
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_HVAC_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set to heat-cool (auto) mode
+
+Specify the desired heating set point in °C or °F.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.heatCool({
@@ -18,7 +98,7 @@ await seam.thermostats.heatCool({
});
```
-#### Response
+#### Output
```javascript
{
@@ -30,7 +110,7 @@ await seam.thermostats.heatCool({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.heat_cool(
@@ -40,7 +120,7 @@ seam.thermostats.heat_cool(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -52,7 +132,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.heat_cool(
@@ -62,7 +142,7 @@ seam.thermostats.heat_cool(
)
```
-#### Response
+#### Output
```ruby
{
@@ -74,7 +154,7 @@ seam.thermostats.heat_cool(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->heat_cool(
);
```
-#### Response
+#### Output
```php
thermostats->heat_cool(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20
```
-#### Response
+#### Output
```seam_cli
{
@@ -116,7 +196,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -135,7 +215,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"}
@@ -144,116 +224,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `cooling_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
-
-***
-
-### `cooling_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
-
-***
-
-### `heating_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
-
-***
-
-### `heating_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `SET_HVAC_MODE`
-
-Setting HVAC mode.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `SET_HVAC_MODE`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: String
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-#### `status`
-
-Format: `Enum`
-
-Possible enum values:
-- `success`
-- `pending`
-- `error`
-
----
diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md
index f6abab73b..c7c1d38fc 100644
--- a/docs/api/thermostats/list.md
+++ b/docs/api/thermostats/list.md
@@ -1,20 +1,147 @@
# List Thermostats
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/list ⇒ { devices: [device, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`connect_webview_id`**
+
+ID of the Connect Webview by which to filter devices.
+
+---
+
+**`connected_account_id`**
+
+ID of the connected account by which to filter.
+
+---
+
+**`connected_account_ids`** *of UUIDs*
+
+Array of IDs of the connected accounts by which to filter devices.
+
+---
+
+**`created_before`**
+
+Date threshold for devices to return. If specified, returns only devices created before the specified date.
+
+---
+
+**`custom_metadata_has`**
+
+Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.
+
+---
+
+**`device_ids`** *of UUIDs*
+
+Array of device IDs by which to filter devices.
+
+---
+
+**`device_type`**
+
+Device type by which to filter devices.
+
+---
+
+**`device_types`** *of Enums*
+
+Array of device types by which to filter devices.
+
+
+Enum values
+
+Possible enum values:
+- ecobee_thermostat
+- nest_thermostat
+- honeywell_resideo_thermostat
+- tado_thermostat
+- sensi_thermostat
+
+
+---
+
+**`limit`**
+
+Numerical limit on the number of devices to return.
+
+---
+
+**`manufacturer`**
+
+Manufacturer by which to filter devices.
+
+---
+
+**`page_cursor`**
+
+Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+
+---
+
+**`user_identifier_key`**
+
+Your own internal user ID for the user by which to filter devices.
+
+---
+
+
+## Response
+
+Array of [devices](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of device
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List thermostats
+
+To filter the list of returned thermostats, specify the desired parameters.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.list();
```
-#### Response
+#### Output
```javascript
[
@@ -45,13 +172,13 @@ await seam.thermostats.list();
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.list()
```
-#### Response
+#### Output
```python
[
@@ -82,13 +209,13 @@ seam.thermostats.list()
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.list()
```
-#### Response
+#### Output
```ruby
[
@@ -119,14 +246,14 @@ seam.thermostats.list()
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->list();
```
-#### Response
+#### Output
```php
thermostats->list();
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats list
```
-#### Response
+#### Output
```seam_cli
[
@@ -200,7 +327,7 @@ seam thermostats list
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -210,7 +337,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}}
@@ -219,146 +346,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `connect_webview_id`
-
-Format: `UUID`
-Required: No
-
-ID of the Connect Webview by which to filter devices.
-
-***
-
-### `connected_account_id`
-
-Format: `UUID`
-Required: No
-
-ID of the connected account by which to filter.
-
-***
-
-### `connected_account_ids`
-
-Format: `List`
-Item format: `UUID`
-Required: No
-
-Array of IDs of the connected accounts by which to filter devices.
-
-***
-
-### `created_before`
-
-Format: `Datetime`
-Required: No
-
-Date threshold for devices to return. If specified, returns only devices created before the specified date.
-
-***
-
-### `custom_metadata_has`
-
-Format: `Record`
-Required: No
-
-Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.
-
-***
-
-### `device_ids`
-
-Format: `List`
-Item format: `UUID`
-Required: No
-
-Array of device IDs by which to filter devices.
-
-***
-
-### `device_type`
-
-Format: `Enum`
-Required: No
-
-Device type by which to filter devices.
-
-Possible enum values:
-- `ecobee_thermostat`
-- `nest_thermostat`
-- `honeywell_resideo_thermostat`
-- `tado_thermostat`
-- `sensi_thermostat`
-
-***
-
-### `device_types`
-
-Format: `List`
-Item format: `Enum`
-Required: No
-
-Array of device types by which to filter devices.
-
-Possible enum values:
-- `ecobee_thermostat`
-- `nest_thermostat`
-- `honeywell_resideo_thermostat`
-- `tado_thermostat`
-- `sensi_thermostat`
-
-***
-
-### `limit`
-
-Format: `Number`
-Required: No
-
-Numerical limit on the number of devices to return.
-
-***
-
-### `manufacturer`
-
-Format: `Enum`
-Required: No
-
-Manufacturer by which to filter devices.
-
-Possible enum values:
-- `ecobee`
-- `nest`
-- `honeywell_resideo`
-- `tado`
-
-***
-
-### `page_cursor`
-
-Format: `String`
-Required: No
-
-Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
-
-***
-
-### `user_identifier_key`
-
-Format: `String`
-Required: No
-
-Your own internal user ID for the user by which to filter devices.
-
-***
-
-## Return Type
-Array<[device](./)>
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
index 8000f9edc..71faea834 100644
--- a/docs/api/thermostats/off.md
+++ b/docs/api/thermostats/off.md
@@ -1,14 +1,70 @@
# Set to Off Mode
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/off ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_HVAC_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set to off mode
+
+Specify the `device_id` of the thermostat that you want to set to off mode.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.off({
@@ -16,7 +72,7 @@ await seam.thermostats.off({
});
```
-#### Response
+#### Output
```javascript
{
@@ -28,13 +84,13 @@ await seam.thermostats.off({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -46,13 +102,13 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```ruby
{
@@ -64,14 +120,14 @@ seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000")
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000");
```
-#### Response
+#### Output
```php
thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000");
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000"
```
-#### Response
+#### Output
```seam_cli
{
@@ -102,7 +158,7 @@ seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -119,7 +175,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"}
@@ -128,80 +184,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `SET_HVAC_MODE`
-
-Setting HVAC mode.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `SET_HVAC_MODE`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: String
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-#### `status`
-
-Format: `Enum`
-
-Possible enum values:
-- `success`
-- `pending`
-- `error`
-
----
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md
index 51b61ece3..d8914ac59 100644
--- a/docs/api/thermostats/schedules/README.md
+++ b/docs/api/thermostats/schedules/README.md
@@ -1,119 +1,162 @@
# Thermostat Schedules
-## `thermostat_schedule`
+## The thermostat_schedule Object
-Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
-### `climate_preset_key`
-Format: `String`
+Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
-Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ climate_preset_key: [example value],
+ created_at: [example value],
+ device_id: [example value],
+ ends_at: [example value],
+ errors: [example value],
+ is_override_allowed: [example value],
+ max_override_period_minutes: [example value],
+ name: [example value],
+ starts_at: [example value],
+ thermostat_schedule_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
---
+## Properties
+
+**`climate_preset_key`** *String*
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
-### `created_at`
-Format: `Datetime`
-Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created.
---
-### `device_id`
+**`created_at`** *Datetime*
+
+Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created.
+
-Format: `UUID`
-ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.
---
-### `ends_at`
+**`device_id`** *UUID*
+
+ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.
+
-Format: `Datetime`
-Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
---
-### `errors`
+**`ends_at`** *Datetime*
-Format: `List`
+Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-Item format: `Object`
-Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
-
-error_code Format: String
+---
-Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
+**`errors`** *List* *of Objects*
+
+Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
-
-message Format: String
-Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
+ Child Object Properties
+ error_code String
+
+ Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+ message String
+
+ Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
---
-### `is_override_allowed`
-
-Format: `Boolean`
+**`is_override_allowed`** *Boolean*
Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts.
----
-### `max_override_period_minutes`
-Format: `Number`
+
+---
+
+**`max_override_period_minutes`** *Number*
Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
----
-### `name`
-Format: `String`
+
+---
+
+**`name`** *String*
User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
----
-### `starts_at`
-Format: `Datetime`
+
+---
+
+**`starts_at`** *Datetime*
Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
----
-### `thermostat_schedule_id`
-Format: `UUID`
+
+---
+
+**`thermostat_schedule_id`** *UUID*
ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+
+
---
## Endpoints
-### [`/thermostats/schedules/create`](./create.md)
+
+[**`/thermostats/schedules/create`**](./create.md)
Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/schedules/delete`](./delete.md)
+
+
+[**`/thermostats/schedules/delete`**](./delete.md)
Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/schedules/get`](./get.md)
+
+
+[**`/thermostats/schedules/get`**](./get.md)
Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
-### [`/thermostats/schedules/list`](./list.md)
+
+
+[**`/thermostats/schedules/list`**](./list.md)
Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
-### [`/thermostats/schedules/update`](./update.md)
+
+
+[**`/thermostats/schedules/update`**](./update.md)
Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+
diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md
index 86acd5059..56d8c66dc 100644
--- a/docs/api/thermostats/schedules/create.md
+++ b/docs/api/thermostats/schedules/create.md
@@ -1,14 +1,100 @@
# Create a Thermostat Schedule
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/schedules/create ⇒ { thermostat_schedule }
```
+{% endtab %}
+{% endtabs %}
-Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`climate_preset_key`** (Required)
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
+
+---
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`ends_at`** (Required)
+
+Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+---
+
+**`starts_at`** (Required)
+
+Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+---
+
+**`is_override_allowed`**
+
+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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+---
+
+**`max_override_period_minutes`**
+
+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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+---
+
+**`name`**
+
+User-friendly name to identify the thermostat schedule.
+
+---
+
+
+## Response
+
+[thermostat\_schedule](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of thermostat_schedule
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Create a thermostat schedule
+
+Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.schedules.create({
@@ -21,7 +107,7 @@ await seam.thermostats.schedules.create({
});
```
-#### Response
+#### Output
```javascript
{
@@ -37,7 +123,7 @@ await seam.thermostats.schedules.create({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.schedules.create(
@@ -50,7 +136,7 @@ seam.thermostats.schedules.create(
)
```
-#### Response
+#### Output
```python
ThermostatSchedule(
@@ -66,7 +152,7 @@ ThermostatSchedule(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.schedules.create(
@@ -79,7 +165,7 @@ seam.thermostats.schedules.create(
)
```
-#### Response
+#### Output
```ruby
{
@@ -95,7 +181,7 @@ seam.thermostats.schedules.create(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->schedules->create(
);
```
-#### Response
+#### Output
```php
thermostats->schedules->create(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90
```
-#### Response
+#### Output
```seam_cli
{
@@ -148,7 +234,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -171,7 +257,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90}
@@ -180,78 +266,4 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `climate_preset_key`
-
-Format: `String`
-Required: Yes
-
-Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
-
-***
-
-### `device_id`
-
-Format: `String`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `ends_at`
-
-Format: `String`
-Required: Yes
-Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-***
-
-### `starts_at`
-
-Format: `String`
-Required: Yes
-
-Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-***
-
-### `is_override_allowed`
-
-Format: `Boolean`
-Required: No
-
-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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
-
-***
-
-### `max_override_period_minutes`
-
-Format: `Number`
-Required: No
-
-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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
-
-***
-
-### `name`
-
-Format: `String`
-Required: No
-
-User-friendly name to identify the thermostat schedule.
-
-***
-
-## Return Type
-
-[thermostat\_schedule](./)
diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md
index 6957e69cb..9e637dc7a 100644
--- a/docs/api/thermostats/schedules/delete.md
+++ b/docs/api/thermostats/schedules/delete.md
@@ -1,14 +1,55 @@
# Delete a Thermostat Schedule
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/schedules/delete ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`thermostat_schedule_id`** (Required)
+
+ID of the desired thermostat schedule.
+
+---
-Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Delete a thermostat schedule
+
+Specify the `thermostat_schedule_id` of the desired thermostat schedule.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.schedules.delete({
@@ -16,7 +57,7 @@ await seam.thermostats.schedules.delete({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -24,7 +65,7 @@ await seam.thermostats.schedules.delete({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.schedules.delete(
@@ -32,7 +73,7 @@ seam.thermostats.schedules.delete(
)
```
-#### Response
+#### Output
```python
None
@@ -40,13 +81,13 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4")
```
-#### Response
+#### Output
```ruby
nil
@@ -54,7 +95,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->schedules->delete(
);
```
-#### Response
+#### Output
```php
null
@@ -71,13 +112,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -85,7 +126,7 @@ seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-b
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -103,7 +144,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -112,24 +153,4 @@ nil
{% endtabs %}
-## Authentication Methods
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `thermostat_schedule_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat schedule.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md
index 6126c3528..3d88407fe 100644
--- a/docs/api/thermostats/schedules/get.md
+++ b/docs/api/thermostats/schedules/get.md
@@ -1,14 +1,64 @@
# Get a Thermostat Schedule
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/schedules/get ⇒ { thermostat_schedule }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`thermostat_schedule_id`** (Required)
+
+ID of the desired thermostat schedule.
+
+---
+
+
+## Response
+
+[thermostat\_schedule](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of thermostat_schedule
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get a specific thermostat schedule
+
+Specify the `thermostat_schedule_id` of the desired thermostat schedule.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.schedules.get({
@@ -16,7 +66,7 @@ await seam.thermostats.schedules.get({
});
```
-#### Response
+#### Output
```javascript
{
@@ -32,7 +82,7 @@ await seam.thermostats.schedules.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.schedules.get(
@@ -40,7 +90,7 @@ seam.thermostats.schedules.get(
)
```
-#### Response
+#### Output
```python
ThermostatSchedule(
@@ -56,13 +106,13 @@ ThermostatSchedule(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4")
```
-#### Response
+#### Output
```ruby
{
@@ -78,7 +128,7 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->schedules->get(
);
```
-#### Response
+#### Output
```php
thermostats->schedules->get(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4"
```
-#### Response
+#### Output
```seam_cli
{
@@ -126,7 +176,7 @@ seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -144,7 +194,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}
@@ -153,24 +203,4 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `thermostat_schedule_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat schedule.
-
-***
-
-## Return Type
-
-[thermostat\_schedule](./)
diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md
index 63019cf43..c9e54d7df 100644
--- a/docs/api/thermostats/schedules/list.md
+++ b/docs/api/thermostats/schedules/list.md
@@ -1,14 +1,70 @@
# List Thermostat Schedules
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`user_identifier_key`**
+
+User identifier key by which to filter the list of returned thermostat schedules.
+
+---
+
+
+## Response
+
+Array of [thermostat\_schedules](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of thermostat_schedule
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List thermostat schedules for a thermostat
+
+Specify the `device_id` of the desired thermostat.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.schedules.list({
@@ -16,7 +72,7 @@ await seam.thermostats.schedules.list({
});
```
-#### Response
+#### Output
```javascript
[
@@ -43,13 +99,13 @@ await seam.thermostats.schedules.list({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```python
[
@@ -76,13 +132,13 @@ seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000"
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000")
```
-#### Response
+#### Output
```ruby
[
@@ -109,7 +165,7 @@ seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->schedules->list(
);
```
-#### Response
+#### Output
```php
thermostats->schedules->list(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000"
```
-#### Response
+#### Output
```seam_cli
[
@@ -179,7 +235,7 @@ seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-42661417400
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -197,7 +253,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}}
@@ -206,33 +262,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `user_identifier_key`
-
-Format: `String`
-Required: No
-
-User identifier key by which to filter the list of returned thermostat schedules.
-
-***
-
-## Return Type
-Array<[thermostat\_schedule](./)>
diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md
index 152f50201..f1d3bd380 100644
--- a/docs/api/thermostats/schedules/update.md
+++ b/docs/api/thermostats/schedules/update.md
@@ -1,14 +1,91 @@
# Update a Thermostat Schedule
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /thermostats/schedules/update ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`thermostat_schedule_id`** (Required)
+
+ID of the desired thermostat schedule.
+
+---
+
+**`climate_preset_key`**
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
+
+---
+
+**`ends_at`**
+
+Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+---
+
+**`is_override_allowed`**
+
+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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+---
+
+**`max_override_period_minutes`**
+
+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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+---
+
+**`name`**
+
+User-friendly name to identify the thermostat schedule.
+
+---
+
+**`starts_at`**
+
+Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Update a thermostat schedule
+
+Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.schedules.update({
@@ -17,7 +94,7 @@ await seam.thermostats.schedules.update({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +102,7 @@ await seam.thermostats.schedules.update({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.schedules.update(
@@ -34,7 +111,7 @@ seam.thermostats.schedules.update(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +119,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.schedules.update(
@@ -51,7 +128,7 @@ seam.thermostats.schedules.update(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +136,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->schedules->update(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +154,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +168,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -110,7 +187,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -119,78 +196,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `thermostat_schedule_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat schedule.
-
-***
-
-### `climate_preset_key`
-
-Format: `String`
-Required: No
-
-Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
-
-***
-
-### `ends_at`
-
-Format: `String`
-Required: No
-
-Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-***
-
-### `is_override_allowed`
-
-Format: `Boolean`
-Required: No
-
-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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
-
-***
-
-### `max_override_period_minutes`
-
-Format: `Number`
-Required: No
-
-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](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
-
-***
-### `name`
-
-Format: `String`
-Required: No
-
-User-friendly name to identify the thermostat schedule.
-
-***
-
-### `starts_at`
-
-Format: `String`
-Required: No
-
-Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md
index c529eab66..082217834 100644
--- a/docs/api/thermostats/set_fallback_climate_preset.md
+++ b/docs/api/thermostats/set_fallback_climate_preset.md
@@ -1,14 +1,60 @@
# Set the Fallback Climate Preset
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/set_fallback_climate_preset ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`climate_preset_key`** (Required)
+
+Climate preset key of the desired climate preset.
+
+---
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Set the fallback climate preset
+
+Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.setFallbackClimatePreset({
@@ -17,7 +63,7 @@ await seam.thermostats.setFallbackClimatePreset({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.thermostats.setFallbackClimatePreset({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.set_fallback_climate_preset(
@@ -33,7 +79,7 @@ seam.thermostats.set_fallback_climate_preset(
)
```
-#### Response
+#### Output
```python
None
@@ -41,7 +87,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.set_fallback_climate_preset(
@@ -50,7 +96,7 @@ seam.thermostats.set_fallback_climate_preset(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -58,7 +104,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->set_fallback_climate_preset(
);
```
-#### Response
+#### Output
```php
null
@@ -76,13 +122,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -90,7 +136,7 @@ seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a45
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -108,7 +154,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -117,32 +163,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `climate_preset_key`
-
-Format: `String`
-Required: Yes
-
-Climate preset key of the desired climate preset.
-
-***
-
-### `device_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
index 7c662caf9..c971e2abf 100644
--- a/docs/api/thermostats/set_fan_mode.md
+++ b/docs/api/thermostats/set_fan_mode.md
@@ -1,14 +1,78 @@
# Set the Fan Mode Setting
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/set_fan_mode ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+---
+
+**`fan_mode`**
+
+---
+
+**`fan_mode_setting`**
+
+Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.
+
+---
+
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_FAN_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set fan mode setting
+
+Specify the desired fan mode setting.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.setFanMode({
@@ -17,7 +81,7 @@ await seam.thermostats.setFanMode({
});
```
-#### Response
+#### Output
```javascript
{
@@ -29,7 +93,7 @@ await seam.thermostats.setFanMode({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.set_fan_mode(
@@ -37,7 +101,7 @@ seam.thermostats.set_fan_mode(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -49,7 +113,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.set_fan_mode(
@@ -58,7 +122,7 @@ seam.thermostats.set_fan_mode(
)
```
-#### Response
+#### Output
```ruby
{
@@ -70,7 +134,7 @@ seam.thermostats.set_fan_mode(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->set_fan_mode(
);
```
-#### Response
+#### Output
```php
thermostats->set_fan_mode(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto"
```
-#### Response
+#### Output
```seam_cli
{
@@ -111,7 +175,7 @@ seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000"
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -129,7 +193,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"}
@@ -138,108 +202,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-***
-
-### `fan_mode`
-
-Format: `Enum`
-Required: No
-
-Possible enum values:
-- `auto`
-- `on`
-- `circulate`
-
-{% hint style="warning" %}
-**Deprecated**. Use `fan_mode_setting` instead.
-{% endhint %}
-
-***
-
-### `fan_mode_setting`
-
-Format: `Enum`
-Required: No
-
-Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.
-
-Possible enum values:
-- `auto`
-- `on`
-- `circulate`
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `SET_FAN_MODE`
-
-Setting fan mode.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `SET_FAN_MODE`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: String
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-#### `status`
-
-Format: `Enum`
-
-Possible enum values:
-- `success`
-- `pending`
-- `error`
-
----
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
index 9bc6ae023..6f918d28a 100644
--- a/docs/api/thermostats/set_hvac_mode.md
+++ b/docs/api/thermostats/set_hvac_mode.md
@@ -1,14 +1,98 @@
# Set the HVAC Mode
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/set_hvac_mode ⇒ { action_attempt }
```
+{% endtab %}
+{% endtabs %}
-Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`hvac_mode_setting`** (Required)
+
+---
+
+**`cooling_set_point_celsius`**
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
+
+---
+
+**`cooling_set_point_fahrenheit`**
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
+
+---
+
+**`heating_set_point_celsius`**
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
+
+---
+
+**`heating_set_point_fahrenheit`**
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
+
+---
+
+
+## Response
+
+[action\_attempt](./)
+
+**`SET_HVAC_MODE`**
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ action_attempt_id: [example value],
+ action_type: [example value],
+ error: [example value],
+ result: [example value],
+ status: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Set HVAC mode
+
+Specify the desired heating and cooling set points in °C or °F.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.setHvacMode({
@@ -19,7 +103,7 @@ await seam.thermostats.setHvacMode({
});
```
-#### Response
+#### Output
```javascript
{
@@ -31,7 +115,7 @@ await seam.thermostats.setHvacMode({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.set_hvac_mode(
@@ -42,7 +126,7 @@ seam.thermostats.set_hvac_mode(
)
```
-#### Response
+#### Output
```python
ActionAttempt(
@@ -54,7 +138,7 @@ ActionAttempt(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.set_hvac_mode(
@@ -65,7 +149,7 @@ seam.thermostats.set_hvac_mode(
)
```
-#### Response
+#### Output
```ruby
{
@@ -77,7 +161,7 @@ seam.thermostats.set_hvac_mode(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->set_hvac_mode(
);
```
-#### Response
+#### Output
```php
thermostats->set_hvac_mode(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25
```
-#### Response
+#### Output
```seam_cli
{
@@ -120,7 +204,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -140,7 +224,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"}
@@ -149,129 +233,4 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `hvac_mode_setting`
-
-Format: `Enum`
-Required: Yes
-
-Possible enum values:
-- `off`
-- `cool`
-- `heat`
-- `heat_cool`
-
-***
-
-### `cooling_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
-
-***
-
-### `cooling_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
-
-***
-
-### `heating_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
-
-***
-
-### `heating_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
-
-***
-
-## Return Type
-
-[action\_attempt](./)
-
-### `SET_HVAC_MODE`
-
-Setting HVAC mode.
-
-#### `action_attempt_id`
-
-Format: `UUID`
-
-ID of the action attempt.
-
----
-
-#### `action_type`
-
-Format: `Enum`
-
-Value: `SET_HVAC_MODE`
-
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-
-type Format: String
-
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-#### `status`
-
-Format: `Enum`
-
-Possible enum values:
-- `success`
-- `pending`
-- `error`
-
----
diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md
index 35d0e7e62..21d4f7c3e 100644
--- a/docs/api/thermostats/set_temperature_threshold.md
+++ b/docs/api/thermostats/set_temperature_threshold.md
@@ -1,14 +1,78 @@
# Set a Temperature Threshold
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /thermostats/set_temperature_threshold ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`lower_limit_celsius`**
+
+Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
+
+---
+
+**`lower_limit_fahrenheit`**
+
+Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
+
+---
+
+**`upper_limit_celsius`**
+
+Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
+
+---
+
+**`upper_limit_fahrenheit`**
+
+Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Set a temperature threshold
+
+Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.setTemperatureThreshold({
@@ -18,7 +82,7 @@ await seam.thermostats.setTemperatureThreshold({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -26,7 +90,7 @@ await seam.thermostats.setTemperatureThreshold({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.set_temperature_threshold(
@@ -36,7 +100,7 @@ seam.thermostats.set_temperature_threshold(
)
```
-#### Response
+#### Output
```python
None
@@ -44,7 +108,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.set_temperature_threshold(
@@ -54,7 +118,7 @@ seam.thermostats.set_temperature_threshold(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -62,7 +126,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->set_temperature_threshold(
);
```
-#### Response
+#### Output
```php
null
@@ -81,13 +145,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30
```
-#### Response
+#### Output
```seam_cli
{}
@@ -95,7 +159,7 @@ seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -114,7 +178,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -123,59 +187,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `lower_limit_celsius`
-
-Format: `Number`
-Required: No
-
-Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
-
-***
-
-### `lower_limit_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
-
-***
-
-### `upper_limit_celsius`
-Format: `Number`
-Required: No
-
-Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
-
-***
-
-### `upper_limit_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md
index 55ddf5a83..b05e76fe5 100644
--- a/docs/api/thermostats/simulate/README.md
+++ b/docs/api/thermostats/simulate/README.md
@@ -2,9 +2,14 @@
## Endpoints
-### [`/thermostats/simulate/hvac_mode_adjusted`](./hvac_mode_adjusted.md)
+
+[**`/thermostats/simulate/hvac_mode_adjusted`**](./hvac_mode_adjusted.md)
Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
-### [`/thermostats/simulate/temperature_reached`](./temperature_reached.md)
+
+
+[**`/thermostats/simulate/temperature_reached`**](./temperature_reached.md)
Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
+
+
diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md
index 0c3700180..a73c7938e 100644
--- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md
+++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md
@@ -1,79 +1,69 @@
# HVAC Mode Adjusted
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/simulate/hvac_mode_adjusted ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `device_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`device_id`** (Required)
ID of the desired thermostat device.
-***
-
-### `hvac_mode`
+---
-Format: `Enum`
-Required: Yes
+**`hvac_mode`** (Required)
Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate.
-Possible enum values:
-- `off`
-- `cool`
-- `heat`
-- `heat_cool`
+---
-***
-
-### `cooling_set_point_celsius`
-
-Format: `Number`
-Required: No
+**`cooling_set_point_celsius`**
Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.
-***
-
-### `cooling_set_point_fahrenheit`
+---
-Format: `Number`
-Required: No
+**`cooling_set_point_fahrenheit`**
Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.
-***
+---
-### `heating_set_point_celsius`
-
-Format: `Number`
-Required: No
+**`heating_set_point_celsius`**
Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.
-***
-
-### `heating_set_point_fahrenheit`
+---
-Format: `Number`
-Required: No
+**`heating_set_point_fahrenheit`**
Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.
-***
+---
+
-## Return Type
+## Response
void
diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md
index b3ced60f6..2b5f8d6a7 100644
--- a/docs/api/thermostats/simulate/temperature_reached.md
+++ b/docs/api/thermostats/simulate/temperature_reached.md
@@ -1,46 +1,51 @@
# Temperature Reached
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /thermostats/simulate/temperature_reached ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `device_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`device_id`** (Required)
ID of the desired thermostat device.
-***
-
-### `temperature_celsius`
+---
-Format: `Number`
-Required: No
+**`temperature_celsius`**
Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.
-***
+---
-### `temperature_fahrenheit`
-
-Format: `Number`
-Required: No
+**`temperature_fahrenheit`**
Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.
-***
+---
+
-## Return Type
+## Response
void
diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md
index 1304b12a8..fbbe11d48 100644
--- a/docs/api/thermostats/update_climate_preset.md
+++ b/docs/api/thermostats/update_climate_preset.md
@@ -1,14 +1,109 @@
# Update a Climate Preset
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /thermostats/update_climate_preset ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`climate_preset_key`** (Required)
+
+Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+
+---
+
+**`device_id`** (Required)
+
+ID of the desired thermostat device.
+
+---
+
+**`manual_override_allowed`** (Required)
+
+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).
+
+---
+
+**`cooling_set_point_celsius`**
+
+Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`cooling_set_point_fahrenheit`**
+
+Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`fan_mode_setting`**
+
+Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+
+---
+
+**`heating_set_point_celsius`**
+
+Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`heating_set_point_fahrenheit`**
+
+Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+---
+
+**`hvac_mode_setting`**
+
+Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+
+---
+
+**`name`**
+
+User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Update a climate preset
+
+Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.thermostats.updateClimatePreset({
@@ -19,7 +114,7 @@ await seam.thermostats.updateClimatePreset({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -27,7 +122,7 @@ await seam.thermostats.updateClimatePreset({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.thermostats.update_climate_preset(
@@ -38,7 +133,7 @@ seam.thermostats.update_climate_preset(
)
```
-#### Response
+#### Output
```python
None
@@ -46,7 +141,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.thermostats.update_climate_preset(
@@ -57,7 +152,7 @@ seam.thermostats.update_climate_preset(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -65,7 +160,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
thermostats->update_climate_preset(
);
```
-#### Response
+#### Output
```php
null
@@ -85,13 +180,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true
```
-#### Response
+#### Output
```seam_cli
{}
@@ -99,7 +194,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -119,7 +214,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -128,120 +223,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `climate_preset_key`
-
-Format: `String`
-Required: Yes
-
-Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
-
-***
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired thermostat device.
-
-***
-
-### `manual_override_allowed`
-
-Format: `Boolean`
-Required: Yes
-
-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 %}
-
-***
-### `cooling_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `cooling_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `fan_mode_setting`
-
-Format: `Enum`
-Required: No
-
-Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
-
-Possible enum values:
-- `auto`
-- `on`
-- `circulate`
-
-***
-
-### `heating_set_point_celsius`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `heating_set_point_fahrenheit`
-
-Format: `Number`
-Required: No
-
-Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
-
-***
-
-### `hvac_mode_setting`
-
-Format: `Enum`
-Required: No
-
-Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
-
-Possible enum values:
-- `off`
-- `heat`
-- `cool`
-- `heat_cool`
-
-***
-
-### `name`
-
-Format: `String`
-Required: No
-
-User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md
index a548abed3..4995daccc 100644
--- a/docs/api/user_identities/README.md
+++ b/docs/api/user_identities/README.md
@@ -1,107 +1,171 @@
# User Identities
-## `user_identity`
+## The user_identity Object
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
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.
-### `created_at`
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ created_at: [example value],
+ display_name: [example value],
+ email_address: [example value],
+ full_name: [example value],
+ phone_number: [example value],
+ user_identity_id: [example value],
+ user_identity_key: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+## Properties
-Format: `Datetime`
+**`created_at`** *Datetime*
Date and time at which the user identity was created.
----
-### `display_name`
-Format: `String`
---
-### `email_address`
+**`display_name`** *String*
+
+
-Format: `String`
-Unique email address for the user identity.
---
-### `full_name`
+**`email_address`** *String*
+
+Unique email address for the user identity.
+
+
-Format: `String`
---
-### `phone_number`
+**`full_name`** *String*
+
+
-Format: `String`
-Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
---
-### `user_identity_id`
+**`phone_number`** *String*
+
+Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+
-Format: `UUID`
-ID of the user identity.
---
-### `user_identity_key`
+**`user_identity_id`** *UUID*
+
+ID of the user identity.
+
-Format: `String`
-Unique key for the user identity.
---
-### `workspace_id`
+**`user_identity_key`** *String*
+
+Unique key for the user identity.
+
+
+
+
+---
-Format: `UUID`
+**`workspace_id`** *UUID*
ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity.
+
+
+
---
## Endpoints
-### [`/user_identities/add_acs_user`](./add_acs_user.md)
+
+[**`/user_identities/add_acs_user`**](./add_acs_user.md)
Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/create`](./create.md)
+
+
+[**`/user_identities/create`**](./create.md)
Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/delete`](./delete.md)
+
+
+[**`/user_identities/delete`**](./delete.md)
Deletes a specified [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). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
-### [`/user_identities/generate_instant_key`](./generate_instant_key.md)
+
+
+[**`/user_identities/generate_instant_key`**](./generate_instant_key.md)
Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/get`](./get.md)
+
+
+[**`/user_identities/get`**](./get.md)
Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/grant_access_to_device`](./grant_access_to_device.md)
+
+
+[**`/user_identities/grant_access_to_device`**](./grant_access_to_device.md)
Grants a specified [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) access to a specified [device](../../core-concepts/devices/README.md).
-### [`/user_identities/list`](./list.md)
+
+
+[**`/user_identities/list`**](./list.md)
Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/list_accessible_devices`](./list_accessible_devices.md)
+
+
+[**`/user_identities/list_accessible_devices`**](./list_accessible_devices.md)
Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/list_acs_systems`](./list_acs_systems.md)
+
+
+[**`/user_identities/list_acs_systems`**](./list_acs_systems.md)
Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/list_acs_users`](./list_acs_users.md)
+
+
+[**`/user_identities/list_acs_users`**](./list_acs_users.md)
Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/remove_acs_user`](./remove_acs_user.md)
+
+
+[**`/user_identities/remove_acs_user`**](./remove_acs_user.md)
Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/revoke_access_to_device`](./revoke_access_to_device.md)
+
+
+[**`/user_identities/revoke_access_to_device`**](./revoke_access_to_device.md)
Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-### [`/user_identities/update`](./update.md)
+
+
+[**`/user_identities/update`**](./update.md)
+
+
diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md
index a28099b6b..22cf82108 100644
--- a/docs/api/user_identities/add_acs_user.md
+++ b/docs/api/user_identities/add_acs_user.md
@@ -1,14 +1,60 @@
# Add an ACS User to a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PUT /user_identities/add_acs_user ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_user_id`** (Required)
+
+ID of the desired ACS user.
+
+---
+
+**`user_identity_id`** (Required)
+
+ID of the desired user identity.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Add an ACS user to a user identity
+
+Specify the desired `acs_user_id` and `user_identity_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.addAcsUser({
@@ -17,7 +63,7 @@ await seam.userIdentities.addAcsUser({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.userIdentities.addAcsUser({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.add_acs_user(
@@ -34,7 +80,7 @@ seam.user_identities.add_acs_user(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.add_acs_user(
@@ -51,7 +97,7 @@ seam.user_identities.add_acs_user(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->add_acs_user(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0b
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -109,7 +155,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -118,32 +164,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired ACS user.
-
-***
-
-### `user_identity_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user identity.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md
index 830059bfb..a595e7ca7 100644
--- a/docs/api/user_identities/create.md
+++ b/docs/api/user_identities/create.md
@@ -1,14 +1,81 @@
# Create a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Creates a new [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/create ⇒ { user_identity }
```
+{% endtab %}
+{% endtabs %}
-Creates a new [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).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`email_address`**
+
+Unique email address for the user identity.
+
+---
+
+**`full_name`**
+
+Full name of the user associated with the user identity.
+
+---
+
+**`phone_number`**
+
+Unique phone number for the user identity in E.164 format (for example, +15555550100).
+
+---
+
+**`user_identity_key`**
+
+Unique key for the user identity.
+
+---
+
+
+## Response
+
+[user\_identity](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of user_identity
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Create a user identity
+
+Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.create({
@@ -19,7 +86,7 @@ await seam.userIdentities.create({
});
```
-#### Response
+#### Output
```javascript
{
@@ -36,7 +103,7 @@ await seam.userIdentities.create({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.create(
@@ -47,7 +114,7 @@ seam.user_identities.create(
)
```
-#### Response
+#### Output
```python
UserIdentity(
@@ -64,7 +131,7 @@ UserIdentity(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.create(
@@ -75,7 +142,7 @@ seam.user_identities.create(
)
```
-#### Response
+#### Output
```ruby
{
@@ -92,7 +159,7 @@ seam.user_identities.create(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->create(
);
```
-#### Response
+#### Output
```php
user_identities->create(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe"
```
-#### Response
+#### Output
```seam_cli
{
@@ -145,7 +212,7 @@ seam user-identities create --user_identity_key "jean_doe" --email_address "jean
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -165,7 +232,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}
@@ -174,50 +241,4 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `email_address`
-
-Format: `String`
-Required: No
-
-Unique email address for the user identity.
-
-***
-
-### `full_name`
-
-Format: `String`
-Required: No
-
-Full name of the user associated with the user identity.
-
-***
-
-### `phone_number`
-
-Format: `String`
-Required: No
-
-Unique phone number for the user identity in E.164 format (for example, +15555550100).
-
-***
-
-### `user_identity_key`
-Format: `String`
-Required: No
-
-Unique key for the user identity.
-
-***
-
-## Return Type
-
-[user\_identity](./)
diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md
index 2d5537330..b822a8403 100644
--- a/docs/api/user_identities/delete.md
+++ b/docs/api/user_identities/delete.md
@@ -1,14 +1,54 @@
# Delete a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes a specified [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). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/delete ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`user_identity_id`** (Required)
+
+ID of the desired user identity.
+
+---
-Deletes a specified [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). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Delete a user identity
+
+Specify the desired `user_identity_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.delete({
@@ -16,7 +56,7 @@ await seam.userIdentities.delete({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -24,13 +64,13 @@ await seam.userIdentities.delete({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135")
```
-#### Response
+#### Output
```python
None
@@ -38,13 +78,13 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135")
```
-#### Response
+#### Output
```ruby
nil
@@ -52,7 +92,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->delete(
);
```
-#### Response
+#### Output
```php
null
@@ -69,13 +109,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -83,7 +123,7 @@ seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceec
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -100,7 +140,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -109,23 +149,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: Yes
-ID of the desired user identity.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md
index 27128b1d4..b4ddb81b1 100644
--- a/docs/api/user_identities/enrollment_automations/README.md
+++ b/docs/api/user_identities/enrollment_automations/README.md
@@ -1,107 +1,142 @@
# Enrollment Automations
-## `enrollment_automation`
+## The enrollment_automation Object
-Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
-### `created_at`
-Format: `Datetime`
+Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).
-Date and time at which the enrollment automation was created.
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ created_at: [example value],
+ credential_manager_acs_system_id: [example value],
+ enrollment_automation_id: [example value],
+ user_identity_id: [example value],
+ workspace_id: [example value]
+}
+```
+{% endtab %}
+{% endtabs %}
---
+## Properties
+
+**`created_at`** *Datetime*
+
+Date and time at which the enrollment automation was created.
-### `credential_manager_acs_system_id`
-Format: `UUID`
-ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.
---
-### `enrollment_automation_id`
+**`credential_manager_acs_system_id`** *UUID*
+
+ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.
+
-Format: `UUID`
-ID of the enrollment automation.
---
-### `user_identity_id`
+**`enrollment_automation_id`** *UUID*
+
+ID of the enrollment automation.
+
-Format: `UUID`
-ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
---
-### `workspace_id`
+**`user_identity_id`** *UUID*
+
+ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
-Format: `UUID`
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation.
----
-## Endpoints
+---
-### [`/user_identities/enrollment_automations/delete`](./delete.md)
+**`workspace_id`** *UUID*
-Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with 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) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).
-### [`/user_identities/enrollment_automations/get`](./get.md)
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation.
-Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
-### [`/user_identities/enrollment_automations/launch`](./launch.md)
-Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
-### [`/user_identities/enrollment_automations/list`](./list.md)
-Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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).
---
+
## Events
-### `enrollment_automation.deleted`
+**`enrollment_automation.deleted`**
An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.
-created_at Format: Datetime
+Properties
-Date and time at which the event was created.
-
-
+- created_at Datetime
-enrollment_automation_id Format: UUID
+ Date and time at which the event was created.
-ID of the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut).
-
-
-event_id Format: UUID
+- enrollment_automation_id UUID
-ID of the event.
-
-
+ ID of the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut).
-event_type Format: Enum
-Value: `enrollment_automation.deleted`
-
-
+- event_id UUID
-occurred_at Format: Datetime
+ ID of the event.
+
+
+- event_type Enum
+
+ Value: `enrollment_automation.deleted`
-Date and time at which the event occurred.
-
-
-workspace_id Format: UUID
+- occurred_at Datetime
+
+ Date and time at which the event occurred.
+
+
+- workspace_id UUID
+
+ ID of the [workspace](../../../core-concepts/workspaces/README.md).
-ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
+## Endpoints
+
+
+[**`/user_identities/enrollment_automations/delete`**](./delete.md)
+
+Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with 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) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).
+
+
+[**`/user_identities/enrollment_automations/get`**](./get.md)
+
+Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+
+[**`/user_identities/enrollment_automations/launch`**](./launch.md)
+
+Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+
+[**`/user_identities/enrollment_automations/list`**](./list.md)
+
+Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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).
+
+
diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md
index 444c2d6a7..de928e2d2 100644
--- a/docs/api/user_identities/enrollment_automations/delete.md
+++ b/docs/api/user_identities/enrollment_automations/delete.md
@@ -1,14 +1,54 @@
# Delete an Enrollment Automation
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with 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) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/enrollment_automations/delete ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`enrollment_automation_id`** (Required)
+
+ID of the desired enrollment automation.
+
+---
-Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with 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) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Delete an enrollment automation
+
+Specify the desired `enrollment_automation_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.enrollmentAutomations.delete({
@@ -16,7 +56,7 @@ await seam.userIdentities.enrollmentAutomations.delete({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -24,7 +64,7 @@ await seam.userIdentities.enrollmentAutomations.delete({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.enrollment_automations.delete(
@@ -32,7 +72,7 @@ seam.user_identities.enrollment_automations.delete(
)
```
-#### Response
+#### Output
```python
None
@@ -40,7 +80,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.enrollment_automations.delete(
@@ -48,7 +88,7 @@ seam.user_identities.enrollment_automations.delete(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -56,7 +96,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->enrollment_automations->delete(
);
```
-#### Response
+#### Output
```php
null
@@ -73,13 +113,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -87,7 +127,7 @@ seam user-identities enrollment-automations delete --enrollment_automation_id "0
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -105,7 +145,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -114,23 +154,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `enrollment_automation_id`
-
-Format: `UUID`
-Required: Yes
-ID of the desired enrollment automation.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md
index 25be9f253..a9e5d5ee9 100644
--- a/docs/api/user_identities/enrollment_automations/get.md
+++ b/docs/api/user_identities/enrollment_automations/get.md
@@ -1,14 +1,64 @@
# Get an Enrollment Automation
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`enrollment_automation_id`** (Required)
+
+ID of the desired enrollment automation.
+
+---
+
+
+## Response
+
+[enrollment\_automation](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of enrollment_automation
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get an enrollment automation
+
+Specify the desired `enrollment_automation_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.enrollmentAutomations.get({
@@ -16,7 +66,7 @@ await seam.userIdentities.enrollmentAutomations.get({
});
```
-#### Response
+#### Output
```javascript
{
@@ -32,7 +82,7 @@ await seam.userIdentities.enrollmentAutomations.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.enrollment_automations.get(
@@ -40,7 +90,7 @@ seam.user_identities.enrollment_automations.get(
)
```
-#### Response
+#### Output
```python
EnrollmentAutomation(
@@ -56,7 +106,7 @@ EnrollmentAutomation(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.enrollment_automations.get(
@@ -64,7 +114,7 @@ seam.user_identities.enrollment_automations.get(
)
```
-#### Response
+#### Output
```ruby
{
@@ -80,7 +130,7 @@ seam.user_identities.enrollment_automations.get(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->enrollment_automations->get(
);
```
-#### Response
+#### Output
```php
user_identities->enrollment_automations->get(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895"
```
-#### Response
+#### Output
```seam_cli
{
@@ -130,7 +180,7 @@ seam user-identities enrollment-automations get --enrollment_automation_id "0550
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -148,7 +198,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}
@@ -157,24 +207,4 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `enrollment_automation_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired enrollment automation.
-
-***
-
-## Return Type
-
-[enrollment\_automation](./)
diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md
index c4f00f49a..d03377d73 100644
--- a/docs/api/user_identities/enrollment_automations/launch.md
+++ b/docs/api/user_identities/enrollment_automations/launch.md
@@ -1,14 +1,87 @@
# Launch an Enrollment Automation
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation }
```
+{% endtab %}
+{% endtabs %}
-Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`credential_manager_acs_system_id`** (Required)
+
+ID of the desired ACS system that serves as the credential manager.
+
+---
+
+**`user_identity_id`** (Required)
+
+ID of the desired user identity.
+
+---
+
+**`acs_credential_pool_id`**
+
+ID of the ACS credential pool from which to obtain credentials for the user identity.
+
+---
+
+**`create_credential_manager_user`**
+
+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`.
+
+---
+
+**`credential_manager_acs_user_id`**
+
+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`.
+
+---
+
+
+## Response
+
+[unknown](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of unknown
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Launch an enrollment automation
+
+Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.enrollmentAutomations.launch({
@@ -19,7 +92,7 @@ await seam.userIdentities.enrollmentAutomations.launch({
});
```
-#### Response
+#### Output
```javascript
{
@@ -35,7 +108,7 @@ await seam.userIdentities.enrollmentAutomations.launch({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.enrollment_automations.launch(
@@ -46,7 +119,7 @@ seam.user_identities.enrollment_automations.launch(
)
```
-#### Response
+#### Output
```python
Unknown(
@@ -62,7 +135,7 @@ Unknown(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.enrollment_automations.launch(
@@ -73,7 +146,7 @@ seam.user_identities.enrollment_automations.launch(
)
```
-#### Response
+#### Output
```ruby
{
@@ -89,7 +162,7 @@ seam.user_identities.enrollment_automations.launch(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->enrollment_automations->launch(
);
```
-#### Response
+#### Output
```php
user_identities->enrollment_automations->launch(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true
```
-#### Response
+#### Output
```seam_cli
{
@@ -142,7 +215,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -163,7 +236,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}
@@ -172,59 +245,4 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `credential_manager_acs_system_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired ACS system that serves as the credential manager.
-
-***
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: Yes
-ID of the desired user identity.
-
-***
-
-### `acs_credential_pool_id`
-
-Format: `UUID`
-Required: No
-
-ID of the ACS credential pool from which to obtain credentials for the user identity.
-
-***
-
-### `create_credential_manager_user`
-
-Format: `Boolean`
-Required: No
-
-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`.
-
-***
-
-### `credential_manager_acs_user_id`
-
-Format: `UUID`
-Required: No
-
-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`.
-
-***
-
-## Return Type
-
-[unknown](./)
diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md
index ed6a8bfcd..1d1c95a1a 100644
--- a/docs/api/user_identities/enrollment_automations/list.md
+++ b/docs/api/user_identities/enrollment_automations/list.md
@@ -1,14 +1,64 @@
# List Enrollment Automations
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`user_identity_id`** (Required)
+
+ID of the user identity for which you want to retrieve all enrollment automations.
+
+---
+
+
+## Response
+
+Array of [enrollment\_automations](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of enrollment_automation
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List enrollment automations
+
+Specify the desired `user_identity_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.enrollmentAutomations.list({
@@ -16,7 +66,7 @@ await seam.userIdentities.enrollmentAutomations.list({
});
```
-#### Response
+#### Output
```javascript
[
@@ -34,7 +84,7 @@ await seam.userIdentities.enrollmentAutomations.list({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.enrollment_automations.list(
@@ -42,7 +92,7 @@ seam.user_identities.enrollment_automations.list(
)
```
-#### Response
+#### Output
```python
[
@@ -60,7 +110,7 @@ seam.user_identities.enrollment_automations.list(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.enrollment_automations.list(
@@ -68,7 +118,7 @@ seam.user_identities.enrollment_automations.list(
)
```
-#### Response
+#### Output
```ruby
[
@@ -86,7 +136,7 @@ seam.user_identities.enrollment_automations.list(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->enrollment_automations->list(
);
```
-#### Response
+#### Output
```php
user_identities->enrollment_automations->list(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
```
-#### Response
+#### Output
```seam_cli
[
@@ -140,7 +190,7 @@ seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c7
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -158,7 +208,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}}
@@ -167,24 +217,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the user identity for which you want to retrieve all enrollment automations.
-
-***
-
-## Return Type
-Array<[enrollment\_automation](./)>
diff --git a/docs/api/user_identities/generate_instant_key.md b/docs/api/user_identities/generate_instant_key.md
index b6d8c0151..2d4b1956c 100644
--- a/docs/api/user_identities/generate_instant_key.md
+++ b/docs/api/user_identities/generate_instant_key.md
@@ -1,37 +1,54 @@
# Generate an Instant Key
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/instant-keys) for a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/generate_instant_key ⇒ { instant_key }
```
+{% endtab %}
+{% endtabs %}
-Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/instant-keys) for a specified [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).
+
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `user_identity_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`user_identity_id`** (Required)
ID of the user identity for which you want to generate an instant key.
-***
-
-### `max_use_count`
+---
-Format: `Number`
-Required: No
+**`max_use_count`**
The maximum number of times the instant key can be used. Defaults to 1.
-***
+---
-## Return Type
+
+## Response
[instant\_key](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of instant_key
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md
index 71491a12d..6c5c2159c 100644
--- a/docs/api/user_identities/get.md
+++ b/docs/api/user_identities/get.md
@@ -1,14 +1,67 @@
# Get a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/get ⇒ { user_identity }
```
+{% endtab %}
+{% endtabs %}
-Returns a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`user_identity_id`**
+
+ID of the desired user identity.
+
+---
+
+**`user_identity_key`**
+
+---
+
+
+## Response
+
+[user\_identity](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of user_identity
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### Get a user identity
+
+Specify the `user_identity_id` of the user identity that you want to retrieve.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.get({
@@ -16,7 +69,7 @@ await seam.userIdentities.get({
});
```
-#### Response
+#### Output
```javascript
{
@@ -33,13 +86,13 @@ await seam.userIdentities.get({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")
```
-#### Response
+#### Output
```python
UserIdentity(
@@ -56,13 +109,13 @@ UserIdentity(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")
```
-#### Response
+#### Output
```ruby
{
@@ -79,7 +132,7 @@ seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->get(
);
```
-#### Response
+#### Output
```php
user_identities->get(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
```
-#### Response
+#### Output
```seam_cli
{
@@ -129,7 +182,7 @@ seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -146,7 +199,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}
@@ -155,30 +208,4 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-## Request Parameters
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: No
-
-ID of the desired user identity.
-
-***
-
-### `user_identity_key`
-
-Format: `String`
-Required: No
-
-***
-
-## Return Type
-
-[user\_identity](./)
diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md
index 7d8d86901..9902a3940 100644
--- a/docs/api/user_identities/grant_access_to_device.md
+++ b/docs/api/user_identities/grant_access_to_device.md
@@ -1,14 +1,60 @@
# Grant a User Identity Access to a Device
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Grants a specified [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) access to a specified [device](../../core-concepts/devices/README.md).
+
+{% tabs %}
+{% tab title="Signature" %}
```
PUT /user_identities/grant_access_to_device ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Grants a specified [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) access to a specified [device](../../core-concepts/devices/README.md).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired managed device.
+
+---
+
+**`user_identity_id`** (Required)
+
+ID of the desired user identity.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Grant a user identity access to a device
+
+Specify the desired `user_identity_id` and `device_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.grantAccessToDevice({
@@ -17,7 +63,7 @@ await seam.userIdentities.grantAccessToDevice({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.userIdentities.grantAccessToDevice({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.grant_access_to_device(
@@ -34,7 +80,7 @@ seam.user_identities.grant_access_to_device(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.grant_access_to_device(
@@ -51,7 +97,7 @@ seam.user_identities.grant_access_to_device(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->grant_access_to_device(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-43
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -109,7 +155,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -118,32 +164,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired managed device.
-
-***
-
-### `user_identity_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user identity.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md
index 8c772d108..a3d37c2d1 100644
--- a/docs/api/user_identities/list.md
+++ b/docs/api/user_identities/list.md
@@ -1,20 +1,68 @@
# List User Identities
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`credential_manager_acs_system_id`**
+
+---
+
+
+## Response
+
+Array of [user\_identitys](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of user_identity
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List user identities
+
+To filter the list of user identities, specify the desired `credential_manager_acs_system_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.list();
```
-#### Response
+#### Output
```javascript
[
@@ -33,13 +81,13 @@ await seam.userIdentities.list();
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.list()
```
-#### Response
+#### Output
```python
[
@@ -58,13 +106,13 @@ seam.user_identities.list()
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.list()
```
-#### Response
+#### Output
```ruby
[
@@ -83,14 +131,14 @@ seam.user_identities.list()
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->list();
```
-#### Response
+#### Output
```php
user_identities->list();
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities list
```
-#### Response
+#### Output
```seam_cli
[
@@ -135,7 +183,7 @@ seam user-identities list
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -145,7 +193,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}}
@@ -154,22 +202,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `credential_manager_acs_system_id`
-
-Format: `UUID`
-Required: No
-
-***
-
-## Return Type
-Array<[user\_identity](./)>
diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md
index b52bb01e4..8d04b84ff 100644
--- a/docs/api/user_identities/list_accessible_devices.md
+++ b/docs/api/user_identities/list_accessible_devices.md
@@ -1,14 +1,63 @@
# List Accessible Devices for a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`user_identity_id`** (Required)
+
+ID of the user identity for which you want to retrieve all accessible devices.
+
+---
+
+
+## Response
+
+Array of [devices](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of device
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List accessible devices for a user identity
+
+Specify the desired `user_identity_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.listAccessibleDevices({
@@ -16,7 +65,7 @@ await seam.userIdentities.listAccessibleDevices({
});
```
-#### Response
+#### Output
```javascript
[
@@ -76,7 +125,7 @@ await seam.userIdentities.listAccessibleDevices({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.list_accessible_devices(
@@ -84,7 +133,7 @@ seam.user_identities.list_accessible_devices(
)
```
-#### Response
+#### Output
```python
[
@@ -144,7 +193,7 @@ seam.user_identities.list_accessible_devices(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.list_accessible_devices(
@@ -152,7 +201,7 @@ seam.user_identities.list_accessible_devices(
)
```
-#### Response
+#### Output
```ruby
[
@@ -216,7 +265,7 @@ seam.user_identities.list_accessible_devices(
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->list_accessible_devices(
);
```
-#### Response
+#### Output
```php
user_identities->list_accessible_devices(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf"
```
-#### Response
+#### Output
```seam_cli
[
@@ -359,7 +408,7 @@ seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -376,7 +425,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}}
@@ -385,23 +434,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the user identity for which you want to retrieve all accessible devices.
-
-***
-
-## Return Type
-Array<[device](./)>
diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md
index 0b132eb99..ecef8fc96 100644
--- a/docs/api/user_identities/list_acs_systems.md
+++ b/docs/api/user_identities/list_acs_systems.md
@@ -1,14 +1,64 @@
# List ACS Systems Associated with a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`user_identity_id`** (Required)
+
+ID of the user identity for which you want to retrieve all access control systems.
+
+---
+
+
+## Response
+
+Array of [acs\_systems](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_system
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List ACS systems associated with a user identity
+
+Specify the desired `user_identity_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.listAcsSystems({
@@ -16,7 +66,7 @@ await seam.userIdentities.listAcsSystems({
});
```
-#### Response
+#### Output
```javascript
[
@@ -36,7 +86,7 @@ await seam.userIdentities.listAcsSystems({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.list_acs_systems(
@@ -44,7 +94,7 @@ seam.user_identities.list_acs_systems(
)
```
-#### Response
+#### Output
```python
[
@@ -64,13 +114,13 @@ seam.user_identities.list_acs_systems(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f")
```
-#### Response
+#### Output
```ruby
[
@@ -90,7 +140,7 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->list_acs_systems(
);
```
-#### Response
+#### Output
```php
user_identities->list_acs_systems(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
```
-#### Response
+#### Output
```seam_cli
[
@@ -146,7 +196,7 @@ seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -163,7 +213,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}}
@@ -172,24 +222,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Client session token
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the user identity for which you want to retrieve all access control systems.
-
-***
-
-## Return Type
-Array<[acs\_system](./)>
diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md
index da047b2d6..7d215791b 100644
--- a/docs/api/user_identities/list_acs_users.md
+++ b/docs/api/user_identities/list_acs_users.md
@@ -1,14 +1,63 @@
# List ACS Users Associated with a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] }
```
+{% endtab %}
+{% endtabs %}
-Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`user_identity_id`** (Required)
+
+ID of the user identity for which you want to retrieve all ACS users.
+
+---
+
+
+## Response
+
+Array of [acs\_users](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of acs_user
+}
+```
+{% endtab %}
+{% endtabs %}
+
+---
+
+## Examples
+
+### List ACS users for a user identity
+
+Specify the desired `user_identity_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.listAcsUsers({
@@ -16,7 +65,7 @@ await seam.userIdentities.listAcsUsers({
});
```
-#### Response
+#### Output
```javascript
[
@@ -38,7 +87,7 @@ await seam.userIdentities.listAcsUsers({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.list_acs_users(
@@ -46,7 +95,7 @@ seam.user_identities.list_acs_users(
)
```
-#### Response
+#### Output
```python
[
@@ -68,13 +117,13 @@ seam.user_identities.list_acs_users(
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")
```
-#### Response
+#### Output
```ruby
[
@@ -96,7 +145,7 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->list_acs_users(
);
```
-#### Response
+#### Output
```php
user_identities->list_acs_users(
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
```
-#### Response
+#### Output
```seam_cli
[
@@ -156,7 +205,7 @@ seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -173,7 +222,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}}
@@ -182,23 +231,4 @@ func main() {
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `user_identity_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the user identity for which you want to retrieve all ACS users.
-
-***
-
-## Return Type
-Array<[acs\_user](./)>
diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md
index c7d7b1d60..8adf274eb 100644
--- a/docs/api/user_identities/remove_acs_user.md
+++ b/docs/api/user_identities/remove_acs_user.md
@@ -1,14 +1,60 @@
# Remove an ACS User from a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/remove_acs_user ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`acs_user_id`** (Required)
+
+ID of the ACS user.
+
+---
+
+**`user_identity_id`** (Required)
+
+ID of the desired user identity.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Remove an ACS user from a user identity
+
+Specify the desired `acs_user_id` and `user_identity_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.removeAcsUser({
@@ -17,7 +63,7 @@ await seam.userIdentities.removeAcsUser({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.userIdentities.removeAcsUser({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.remove_acs_user(
@@ -34,7 +80,7 @@ seam.user_identities.remove_acs_user(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.remove_acs_user(
@@ -51,7 +97,7 @@ seam.user_identities.remove_acs_user(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->remove_acs_user(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -109,7 +155,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -118,32 +164,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `acs_user_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the ACS user.
-
-***
-
-### `user_identity_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user identity.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md
index 2f7c45659..9e047e98f 100644
--- a/docs/api/user_identities/revoke_access_to_device.md
+++ b/docs/api/user_identities/revoke_access_to_device.md
@@ -1,14 +1,60 @@
# Revoke Access to a Device from a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [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).
+
+{% tabs %}
+{% tab title="Signature" %}
```
POST /user_identities/revoke_access_to_device ⇒ void
```
+{% endtab %}
+{% endtabs %}
-Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [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).
+
+
+Authentication Methods
+
+- API key
+- Personal access token
+
Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
+
+## Request Parameters
+
+**`device_id`** (Required)
+
+ID of the desired managed device.
+
+---
+
+**`user_identity_id`** (Required)
+
+ID of the desired user identity.
+
+---
+
+
+## Response
+
+void
+
+---
+
+## Examples
+
+### Revoke access to a device from a user identity
+
+Specify the desired `user_identity_id` and `device_id`.
{% tabs %}
{% tab title="JavaScript" %}
-#### Request
+#### Code
```javascript
await seam.userIdentities.revokeAccessToDevice({
@@ -17,7 +63,7 @@ await seam.userIdentities.revokeAccessToDevice({
});
```
-#### Response
+#### Output
```javascript
// void
@@ -25,7 +71,7 @@ await seam.userIdentities.revokeAccessToDevice({
{% endtab %}
{% tab title="Python" %}
-#### Request
+#### Code
```python
seam.user_identities.revoke_access_to_device(
@@ -34,7 +80,7 @@ seam.user_identities.revoke_access_to_device(
)
```
-#### Response
+#### Output
```python
None
@@ -42,7 +88,7 @@ None
{% endtab %}
{% tab title="Ruby" %}
-#### Request
+#### Code
```ruby
seam.user_identities.revoke_access_to_device(
@@ -51,7 +97,7 @@ seam.user_identities.revoke_access_to_device(
)
```
-#### Response
+#### Output
```ruby
nil
@@ -59,7 +105,7 @@ nil
{% endtab %}
{% tab title="PHP" %}
-#### Request
+#### Code
```php
user_identities->revoke_access_to_device(
);
```
-#### Response
+#### Output
```php
null
@@ -77,13 +123,13 @@ null
{% endtab %}
{% tab title="Seam CLI" %}
-#### Request
+#### Code
```seam_cli
seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45"
```
-#### Response
+#### Output
```seam_cli
{}
@@ -91,7 +137,7 @@ seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4
{% endtab %}
{% tab title="Go" %}
-#### Request
+#### Code
```go
package main
@@ -109,7 +155,7 @@ func main() {
}
```
-#### Response
+#### Output
```go
nil
@@ -118,32 +164,4 @@ nil
{% endtabs %}
-## Authentication Methods
-
-- API key
-- Personal access token
-
Must also include the `seam-workspace` header in the request.
-
-## Request Parameters
-
-### `device_id`
-
-Format: `UUID`
-Required: Yes
-
-ID of the desired managed device.
-
-***
-
-### `user_identity_id`
-Format: `UUID`
-Required: Yes
-
-ID of the desired user identity.
-
-***
-
-## Return Type
-
-void
diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md
index 4c5eefe47..71ac692cd 100644
--- a/docs/api/user_identities/update.md
+++ b/docs/api/user_identities/update.md
@@ -1,62 +1,61 @@
# Update a User Identity
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+
+
+{% tabs %}
+{% tab title="Signature" %}
```
PATCH /user_identities/update ⇒ void
```
+{% endtab %}
+{% endtabs %}
+
-
-## Authentication Methods
+Authentication Methods
- API key
- Personal access token
Must also include the `seam-workspace` header in the request.
-## Request Parameters
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
-### `user_identity_id`
+## Request Parameters
-Format: `UUID`
-Required: Yes
+**`user_identity_id`** (Required)
ID of the user identity.
-***
+---
-### `email_address`
-
-Format: `String`
-Required: No
+**`email_address`**
Unique email address for the user identity.
-***
-
-### `full_name`
-
-Format: `String`
-Required: No
+---
-***
+**`full_name`**
-### `phone_number`
+---
-Format: `String`
-Required: No
+**`phone_number`**
Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
-***
+---
-### `user_identity_key`
-
-Format: `String`
-Required: No
+**`user_identity_key`**
Unique key for the user identity.
-***
+---
+
-## Return Type
+## Response
void
diff --git a/src/data/code-sample-definitions/acs-users.yaml b/src/data/code-sample-definitions/acs-users.yaml
index 77bd23cd8..c09f27b8c 100644
--- a/src/data/code-sample-definitions/acs-users.yaml
+++ b/src/data/code-sample-definitions/acs-users.yaml
@@ -1,6 +1,49 @@
---
- title: 'Create a new ACS user'
description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).'
+ request:
+ path: '/acs/users/create'
+ parameters:
+ acs_system_id: '123e4567-e89b-12d3-a456-426614174000'
+ full_name: 'Jane Doe'
+ email_address: 'jane@example.com'
+ phone_number: '+15555550100'
+ response:
+ body:
+ acs_user:
+ acs_user_id: '123e4567-e89b-12d3-a456-426614174000'
+ acs_system_id: '123e4567-e89b-12d3-a456-426614174000'
+ workspace_id: '123e4567-e89b-12d3-a456-426614174000'
+ created_at: '2024-04-05T07:57:05.323Z'
+ display_name: 'Jane Doe'
+ full_name: 'Jane Doe'
+ email_address: 'jane@example.com'
+ phone_number: '+15555550100'
+- title: 'Create a new ACS user'
+ description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule.'
+ request:
+ path: '/acs/users/create'
+ parameters:
+ acs_system_id: '123e4567-e89b-12d3-a456-426614174000'
+ full_name: 'Jane Doe'
+ email_address: 'jane@example.com'
+ phone_number: '+15555550100'
+ access_schedule:
+ starts_at: '2024-11-01T15:00:00.000Z'
+ ends_at: '2024-11-04T11:00:00.000Z'
+ response:
+ body:
+ acs_user:
+ acs_user_id: '123e4567-e89b-12d3-a456-426614174000'
+ acs_system_id: '123e4567-e89b-12d3-a456-426614174000'
+ workspace_id: '123e4567-e89b-12d3-a456-426614174000'
+ created_at: '2024-04-05T07:57:05.323Z'
+ display_name: 'Jane Doe'
+ full_name: 'Jane Doe'
+ email_address: 'jane@example.com'
+ phone_number: '+15555550100'
+- title: 'Create a new ACS user in an access group'
+ description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).'
request:
path: '/acs/users/create'
parameters:
diff --git a/src/data/paths.yaml b/src/data/paths.yaml
index 4b9238aaa..f27f7831e 100644
--- a/src/data/paths.yaml
+++ b/src/data/paths.yaml
@@ -1,6 +1,6 @@
---
/acs:
- title: Access Control Systems
+ title: Access Control Systems (ACS)
description: Systems for managing and monitoring access to physical spaces
overview: |
Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements:
@@ -80,3 +80,16 @@
title: Enrollment Automations
resources:
- enrollment_automation
+
+/access_codes:
+ title: Access Codes
+ resources:
+ - access_code
+
+/access_codes/unmanaged:
+ title: Unmanaged Access Code
+ resources:
+ - unmanaged_access_code
+
+/access_codes/simulate:
+ title: Access Code Simulations
diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs
index b4bb9c33c..a6d99a758 100644
--- a/src/layouts/api-endpoint.hbs
+++ b/src/layouts/api-endpoint.hbs
@@ -1,17 +1,23 @@
# {{title}}
-```
-{{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}}
-```
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
{{{description}}}
-{{#with primaryCodeSample}}
-{{> code-sample }}
+{% tabs %}
+{% tab title="Signature" %}
+```
+{{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}}
+```
+{% endtab %}
+{% endtabs %}
-{{/with}}
{{#if authMethods}}
-## Authentication Methods
+
+
+Authentication Methods
{{#each authMethods}}
- {{this}}
@@ -20,61 +26,79 @@
{{/if}}
{{/each}}
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+
{{/if}}
+
## Request Parameters
{{#if request.parameters.length}}
{{#each request.parameters}}
-### `{{this.name}}`
-
-Format: `{{this.format}}`
-{{#if this.itemFormat}}
-Item format: `{{this.itemFormat}}`
-{{/if}}
-Required: {{#if this.required}}Yes{{else}}No{{/if}}
+**`{{this.name}}`** {{#if this.jsonType}}*{{this.jsonType}}*{{/if}}{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}}
{{#if this.description}}
{{this.description}}
{{/if}}
{{#if this.itemEnumValues}}
+
-{{> enum-values enumValues=this.itemEnumValues}}
-{{/if}}
-{{#if this.enumValues}}
-
-{{> enum-values}}
-{{/if}}
-{{#if this.objectParameters}}
-{{#each this.objectParameters}}
-
-{{> property-collapsible this}}
-
-{{/each}}
-{{/if}}
-{{#if this.isDeprecated}}
+Enum values
-{{> deprecated-warning}}
+{{> enum-values enumValues=this.itemEnumValues}}
+
{{/if}}
-***
+---
{{/each}}
{{else}}
None
{{/if}}
-## Return Type
-{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}}
+## Response
+
+{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s](./){{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}}
{{#with response.actionAttempt}}
-{{> api-resource headingOffset=true}}
+**`{{name}}`**
+{{> api-response-resource headingOffset=true}}
{{/with}}
-{{#if additionalCodeSamples.length}}
+{{#if response.resourceType}}
+{{#unless response.actionAttempt}}
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+ JSON representation of {{response.resourceType}}
+}
+```
+{% endtab %}
+{% endtabs %}
+{{/unless}}
+{{/if}}
+{{#if primaryCodeSample}}
+
+---
-## Additional Code Samples
+## Examples
+
+{{#with primaryCodeSample}}
+### {{this.title}}
+
+{{this.description}}
+
+{{> code-sample }}
+
+{{/with}}
{{#each additionalCodeSamples}}
+---
+
+### {{this.title}}
+
+{{this.description}}
+
{{> code-sample }}
{{/each}}
{{/if}}
diff --git a/src/layouts/api-namespace.hbs b/src/layouts/api-namespace.hbs
index 49d72cada..a17c63491 100644
--- a/src/layouts/api-namespace.hbs
+++ b/src/layouts/api-namespace.hbs
@@ -8,8 +8,11 @@ description: {{description}}
## Resources
+The {{title}} namespace contains the following resources:
+
{{#each resources}}
### [`{{name}}`]({{link}})
{{description}}
+---
{{/each}}
diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs
index e84975e6f..b9012d4e9 100644
--- a/src/layouts/api-route.hbs
+++ b/src/layouts/api-route.hbs
@@ -3,10 +3,11 @@
{{#each resources}}
{{> api-resource }}
{{#if errors.length}}
+
## Errors
{{#each errors}}
-### `{{name}}`
+**`{{name}}`**
{{description}}
@@ -15,10 +16,11 @@
{{/each}}
{{/if}}
{{#if warnings.length}}
+
## Warnings
{{#each warnings}}
-### `{{name}}`
+**`{{name}}`**
{{description}}
@@ -27,31 +29,37 @@
{{/each}}
{{/if}}
{{/each}}
-## Endpoints
-
-{{#each endpoints}}
-### [`{{path}}`](./{{name}}.md)
-
-{{description}}
-{{/each}}
{{#if events.length}}
----
-
## Events
{{#each events}}
-### `{{name}}`
+**`{{name}}`**
{{#if description}}
{{description}}
{{/if}}
+
+
+Properties
{{#each properties}}
-{{> property-collapsible this}}
+- {{> property-nested this}}
{{/each}}
+
+
---
{{/each}}
{{/if}}
+## Endpoints
+
+{{#each endpoints}}
+
+[**`{{path}}`**](./{{name}}.md)
+
+{{description}}
+
+{{/each}}
+
diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs
index 08fd759b3..e1b3d1162 100644
--- a/src/layouts/partials/api-resource.hbs
+++ b/src/layouts/partials/api-resource.hbs
@@ -1,8 +1,15 @@
{{#if headingOffset}}
-### `{{name}}`
+### The {{name}} Object
{{else}}
-## `{{name}}`
+## The {{name}} Object
{{/if}}
+
+- [Properties](./#properties)
+- [Errors](./#errors)
+- [Warnings](./#warnings)
+- [Events](./#events)
+- [Endpoints](./#endpoints)
+
{{#if description}}
{{description}}
@@ -20,44 +27,66 @@
{% endtabs %}
{{/if}}
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
{{#each properties}}
-{{#if ../headingOffset}}
-#### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}}
+{{#if @last}}
+ {{name}}: [example value]
{{else}}
-### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}}
+ {{name}}: [example value],
{{/if}}
-{{#if isDeprecated}}
+{{/each}}
+}
+```
+{% endtab %}
+{% endtabs %}
-{{> deprecated-warning}}
+---
+{{#if headingOffset}}
+### Properties
+{{else}}
+## Properties
{{/if}}
-Format: `{{format}}`
-{{#if listItemFormat}}
+{{#each properties}}
+{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}}
-Item format: `{{listItemFormat}}`
-{{/if}}
{{#if description}}
-
{{description}}
{{/if}}
+
+{{#if isDeprecated}}
+{{> deprecated-warning}}
+{{/if}}
+
{{#if enumValues}}
+
+Enum values
-{{> enum-values}}
+{{#each enumValues}}
+- {{this}}
+{{/each}}
+
{{/if}}
+
{{#if value}}
-Value: `{{value}}`
+Value: {{value}}
{{/if}}
{{#unless (eq objectProperties undefined)}}
{{#if (eq objectProperties.length 0)}}
This object has no properties.
{{else}}
-{{#each objectProperties}}
-
-{{> property-collapsible this}}
+
+ Child Properties
-{{/each}}
+ {{#each objectProperties}}
+ - {{> property-nested this}}
+ {{/each}}
+
{{/if}}
{{/unless}}
{{#if discriminatorVariants}}
@@ -75,7 +104,7 @@ Variants:
{{#if this.properties.length}}
{{#each this.properties}}
-{{> property-non-collapsible this isLast=@last}}
+ {{> property-non-collapsible this isLast=@last}}
{{/each}}
{{else}}
@@ -85,11 +114,12 @@ This variant has no additional specific properties.
{{/each}}
{{/if}}
{{#if listProperties}}
-{{#each listProperties}}
-
-{{> property-collapsible this}}
-
-{{/each}}
+
+ Child Object Properties
+ {{#each listProperties}}
+ {{> property-nested this}}
+ {{/each}}
+
{{/if}}
---
diff --git a/src/layouts/partials/api-response-resource.hbs b/src/layouts/partials/api-response-resource.hbs
new file mode 100644
index 000000000..05d1a512d
--- /dev/null
+++ b/src/layouts/partials/api-response-resource.hbs
@@ -0,0 +1,15 @@
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+{{#each properties}}
+{{#if @last}}
+ {{name}}: [example value]
+{{else}}
+ {{name}}: [example value],
+{{/if}}
+{{/each}}
+}
+```
+{% endtab %}
+{% endtabs %}
diff --git a/src/layouts/partials/code-sample.hbs b/src/layouts/partials/code-sample.hbs
index 73ef267e6..5302b5f86 100644
--- a/src/layouts/partials/code-sample.hbs
+++ b/src/layouts/partials/code-sample.hbs
@@ -1,13 +1,13 @@
{% tabs %}
{{#each this.code}}
{% tab title="{{this.title}}" %}
-#### Request
+#### Code
```{{@key}}
{{this.request}}
```
-#### Response
+#### Output
```{{@key}}
{{this.response}}
diff --git a/src/layouts/partials/enum-values.hbs b/src/layouts/partials/enum-values.hbs
index b055f3682..a3132c05a 100644
--- a/src/layouts/partials/enum-values.hbs
+++ b/src/layouts/partials/enum-values.hbs
@@ -1,4 +1,4 @@
{{#if indentationOffset}}{{indentationOffset}}{{/if}}Possible enum values:
{{#each enumValues}}
-{{#if ../indentationOffset}}{{../indentationOffset}}{{/if}}- `{{this}}`
-{{/each}}
\ No newline at end of file
+{{#if ../indentationOffset}}{{../indentationOffset}}{{/if}}- {{this}}
+{{/each}}
diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs
index 7db38f980..174e0f618 100644
--- a/src/layouts/partials/property-collapsible.hbs
+++ b/src/layouts/partials/property-collapsible.hbs
@@ -1,5 +1,5 @@
-{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
+{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}}
{{> property-content}}
-
\ No newline at end of file
+
diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs
index 60ed8b02d..1151ef91d 100644
--- a/src/layouts/partials/property-content.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -1,22 +1,27 @@
-{{#if isDeprecated}}
-
-{{> deprecated-warning}}
-{{/if}}
{{#if description}}
{{description}}
{{/if}}
+{{#if isDeprecated}}
+
+{{> deprecated-warning}}
+{{/if}}
{{#if enumValues}}
+
+ Enum values:
-{{> enum-values}}
+ {{#each enumValues}}
+ - {{this}}
+ {{/each}}
+
{{/if}}
-{{#if value}}
+{{#if value}}
Value: `{{value}}`
{{/if}}
{{#if listProperties}}
-{{#each listProperties}}
+{{#each listProperties}}
- {{> property-nested this}}
{{/each}}
-{{/if}}
\ No newline at end of file
+{{/if}}
diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs
index 0839edb19..6174065d6 100644
--- a/src/layouts/partials/property-nested-internal.hbs
+++ b/src/layouts/partials/property-nested-internal.hbs
@@ -1,16 +1,21 @@
-{{#if isDeprecated}}
-
- {{> deprecated-warning}}
-{{/if}}
{{#if description}}
{{description}}
{{/if}}
+{{#if isDeprecated}}
+
+ {{> deprecated-warning}}
+{{/if}}
{{#if enumValues}}
+
+ Enum values:
-{{> enum-values indentationOffset=" "}}
+ {{#each enumValues}}
+ - {{this}}`
+ {{/each}}
+
{{/if}}
{{#if value}}
Value: `{{value}}`
-{{/if}}
\ No newline at end of file
+{{/if}}
diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs
index 92689d8b6..7b4fc98e0 100644
--- a/src/layouts/partials/property-nested.hbs
+++ b/src/layouts/partials/property-nested.hbs
@@ -1,8 +1,8 @@
-{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
+{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}}
{{> property-nested-internal}}
{{#if listProperties}}
{{#each listProperties}}
- {{> property-nested this}}
{{/each}}
-{{/if}}
\ No newline at end of file
+{{/if}}
diff --git a/src/layouts/partials/property-non-collapsible.hbs b/src/layouts/partials/property-non-collapsible.hbs
index c5c5af49a..689e69867 100644
--- a/src/layouts/partials/property-non-collapsible.hbs
+++ b/src/layouts/partials/property-non-collapsible.hbs
@@ -1,5 +1,4 @@
-**`{{name}}`**
-Format: `{{format}}`{{#if listItemFormat}}, Item format: `{{listItemFormat}}`{{/if}}
+**`{{name}}`** Format: `{{format}}`{{#if listItemFormat}}, Item format: `{{listItemFormat}}`{{/if}}
{{> property-content}}
diff --git a/src/lib/layout/api-route.ts b/src/lib/layout/api-route.ts
index fd51d64cd..51695bc27 100644
--- a/src/lib/layout/api-route.ts
+++ b/src/lib/layout/api-route.ts
@@ -345,8 +345,8 @@ function addLinkTargetsToProperties(
sections: { errors: boolean; warnings: boolean },
): void {
const linkableProperties: Record = {
- errors: sections.errors ? './#errors-1' : undefined,
- warnings: sections.warnings ? './#warnings-1' : undefined,
+ errors: sections.errors ? './#errors' : undefined,
+ warnings: sections.warnings ? './#warnings' : undefined,
}
for (const prop of properties) {
diff --git a/src/lib/reference.ts b/src/lib/reference.ts
index adae39a57..dcb64533a 100644
--- a/src/lib/reference.ts
+++ b/src/lib/reference.ts
@@ -57,7 +57,8 @@ export const reference = (
!route.path.startsWith('/acs') &&
!route.path.startsWith('/thermostats') &&
!route.path.startsWith('/phones') &&
- !route.path.startsWith('/user_identities')
+ !route.path.startsWith('/user_identities') &&
+ !route.path.startsWith('/access_codes')
) {
continue
}