Skip to content

Commit 7e6339e

Browse files
louis-preclaude
andcommitted
Move files to match published URL paths
Move products/ files into capability-guides/ and webhooks from core-concepts/ to developer-tools/ so file paths match the URLs that GitBook publishes. Update all relative links and SUMMARY.md. Eliminates the products/ directory entirely. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 6f5e2e0 commit 7e6339e

119 files changed

Lines changed: 270 additions & 270 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/guides/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ With the Seam API, you can grant users access to entrances controlled by a varie
3434

3535
Explore our device API guides to start connecting and controlling specific device and system categories.
3636

37-
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden><select></select></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Door Locks API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/smart-locks-16-9.png">smart-locks-16-9.png</a></td><td></td><td><a href="products/smart-locks/">smart-locks</a></td></tr><tr><td><strong>Thermostats API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/thermostats-cover.png">thermostats-cover.png</a></td><td></td><td><a href="products/thermostats/">thermostats</a></td></tr><tr><td><strong>Noise</strong> <strong>Sensors API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/sensors-16-9.png">sensors-16-9.png</a></td><td></td><td><a href="products/noise-sensors/">noise-sensors</a></td></tr><tr><td><strong>Access Control Systems API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/acs-cover.png">acs-cover.png</a></td><td></td><td><a href="products/access-systems/">access-systems</a></td></tr></tbody></table>
37+
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden><select></select></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Door Locks API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/smart-locks-16-9.png">smart-locks-16-9.png</a></td><td></td><td><a href="capability-guides/smart-locks/">smart-locks</a></td></tr><tr><td><strong>Thermostats API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/thermostats-cover.png">thermostats-cover.png</a></td><td></td><td><a href="capability-guides/thermostats/">thermostats</a></td></tr><tr><td><strong>Noise</strong> <strong>Sensors API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/sensors-16-9.png">sensors-16-9.png</a></td><td></td><td><a href="capability-guides/noise-sensors/">noise-sensors</a></td></tr><tr><td><strong>Access Control Systems API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/acs-cover.png">acs-cover.png</a></td><td></td><td><a href="capability-guides/access-systems/">access-systems</a></td></tr></tbody></table>
3838

3939
***
4040

docs/guides/SUMMARY.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,23 @@
4343
## Capability Guides
4444

4545
* [Device and System Capabilities](capability-guides/device-and-system-capabilities.md)
46-
* [Smart Locks](products/smart-locks/README.md)
47-
* [Locking and Unlocking Smart Locks](products/smart-locks/lock-and-unlock.md)
48-
* [Creating and Managing Smart Lock Access Codes](products/smart-locks/access-codes/README.md)
46+
* [Smart Locks](capability-guides/smart-locks/README.md)
47+
* [Locking and Unlocking Smart Locks](capability-guides/smart-locks/lock-and-unlock.md)
48+
* [Creating and Managing Smart Lock Access Codes](capability-guides/smart-locks/access-codes/README.md)
4949
* [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes/README.md)
5050
* [Understanding Code Constraints](capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md)
51-
* [Retrieving Access Codes](products/smart-locks/access-codes/retrieving-access-codes.md)
52-
* [Modifying Access Codes](products/smart-locks/access-codes/modifying-access-codes.md)
53-
* [Deleting Access Codes](products/smart-locks/access-codes/deleting-access-codes.md)
54-
* [Lifecycle of Access Codes](products/smart-locks/access-codes/lifecycle-of-access-codes.md)
55-
* [Access Code Requirements for Door Locks](products/smart-locks/access-codes/access-code-requirements-for-door-locks.md)
56-
* [Streamlining Access Code Management from the Manufacturer App](products/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md)
57-
* [Troubleshooting Access Codes](products/smart-locks/access-codes/troubleshooting-access-code-issues.md)
58-
* [Managing Backup Access Codes](products/smart-locks/access-codes/backup-access-codes.md)
59-
* [Managing Offline Access Codes](products/smart-locks/access-codes/offline-access-codes.md)
51+
* [Retrieving Access Codes](capability-guides/smart-locks/access-codes/retrieving-access-codes.md)
52+
* [Modifying Access Codes](capability-guides/smart-locks/access-codes/modifying-access-codes.md)
53+
* [Deleting Access Codes](capability-guides/smart-locks/access-codes/deleting-access-codes.md)
54+
* [Lifecycle of Access Codes](capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md)
55+
* [Access Code Requirements for Door Locks](capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md)
56+
* [Streamlining Access Code Management from the Manufacturer App](capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md)
57+
* [Troubleshooting Access Codes](capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md)
58+
* [Managing Backup Access Codes](capability-guides/smart-locks/access-codes/backup-access-codes.md)
59+
* [Managing Offline Access Codes](capability-guides/smart-locks/access-codes/offline-access-codes.md)
6060
* [Creating and Updating Multiple Linked Access Codes](capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md)
61-
* [Migrating Existing Unmanaged Access Codes](products/smart-locks/access-codes/migrating-existing-access-codes.md)
62-
* [Access Control Systems](products/access-systems/README.md)
61+
* [Migrating Existing Unmanaged Access Codes](capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md)
62+
* [Access Control Systems](capability-guides/access-systems/README.md)
6363
* [Access System Quick Starts](capability-guides/access-systems/acs-quick-starts/README.md)
6464
* [PIN Code Quick Start](capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md)
6565
* [Encodable Key Card Quick Start](capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md)
@@ -68,8 +68,8 @@
6868
* [Retrieving ACS System Details](capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md)
6969
* [Access Control System Resources](capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md)
7070
* [Understanding Access Control System Differences](capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md)
71-
* [Managing ACS Users](products/access-systems/user-management.md)
72-
* [Suspending and Unsuspending ACS Users](products/access-systems/suspending-and-unsuspending-users.md)
71+
* [Managing ACS Users](capability-guides/access-systems/user-management.md)
72+
* [Suspending and Unsuspending ACS Users](capability-guides/access-systems/suspending-and-unsuspending-users.md)
7373
* [Assigning ACS Users to Access Groups](capability-guides/access-systems/user-management/assigning-users-to-access-groups.md)
7474
* [Retrieving Entrance Details](capability-guides/access-systems/retrieving-entrance-details.md)
7575
* [Managing Credentials](capability-guides/access-systems/managing-credentials.md)
@@ -106,21 +106,21 @@
106106
* [Using Access Grants to Issue Instant Keys](capability-guides/instant-keys/using-access-grants-to-issue-instant-keys.md)
107107
* [Using Seam Console to Issue Instant Keys](capability-guides/instant-keys/using-seam-console-to-issue-instant-keys.md)
108108
* [Delivering Instant Keys](capability-guides/instant-keys/delivering-instant-keys.md)
109-
* [Thermostats](products/thermostats/README.md)
109+
* [Thermostats](capability-guides/thermostats/README.md)
110110
* [Understanding Thermostat Concepts](capability-guides/thermostats/understanding-thermostat-concepts/README.md)
111111
* [HVAC Mode](capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md)
112112
* [Set Points](capability-guides/thermostats/understanding-thermostat-concepts/set-points.md)
113-
* [Retrieving Thermostats](products/thermostats/retrieving-thermostats.md)
113+
* [Retrieving Thermostats](capability-guides/thermostats/retrieving-thermostats.md)
114114
* [Setting and Monitoring Temperature Thresholds](capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md)
115-
* [Setting the Current HVAC and Fan Mode Settings](products/thermostats/configure-current-climate-settings.md)
115+
* [Setting the Current HVAC and Fan Mode Settings](capability-guides/thermostats/configure-current-climate-settings.md)
116116
* [Creating and Managing Climate Presets](capability-guides/thermostats/creating-and-managing-climate-presets/README.md)
117117
* [Setting the Fallback Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md)
118118
* [Activating a Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md)
119119
* [Creating and Managing Thermostat Schedules](capability-guides/thermostats/creating-and-managing-thermostat-schedules.md)
120120
* [Creating and Managing Thermostat Programs](capability-guides/thermostats/creating-and-managing-thermostat-programs.md)
121121
* [Testing Your Thermostat App with Simulate Endpoints](capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md)
122-
* [Noise Sensors](products/noise-sensors/README.md)
123-
* [Configuring Noise Threshold Settings](products/noise-sensors/configure-noise-threshold-settings.md)
122+
* [Noise Sensors](capability-guides/noise-sensors/README.md)
123+
* [Configuring Noise Threshold Settings](capability-guides/noise-sensors/configure-noise-threshold-settings.md)
124124
* [Seam Bridge](capability-guides/seam-bridge.md)
125125
* [Seam Bridge Setup for Windows](capability-guides/seam-bridge/seam-bridge-setup-for-windows.md)
126126
* [Seam Bridge Setup for macOS](capability-guides/seam-bridge/seam-bridge-setup-for-macos.md)
@@ -163,7 +163,7 @@
163163

164164
## Developer Tools
165165

166-
* [Webhooks](core-concepts/webhooks.md)
166+
* [Webhooks](developer-tools/webhooks.md)
167167
* [Seam CLI](developer-tools/seam-cli.md)
168168
* [Seam MCP Server](developer-tools/seam-mcp.md)
169169
* [Sandbox Devices and Systems](device-guides/sandbox-and-sample-data/README.md)
File renamed without changes.

docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This quick start walks you through the following basic steps:
2121
1. [Connect](../../../core-concepts/workspaces/#connecting-virtual-devices) an access control system to Seam.
2222
* To get started quickly, use a virtual ACS in a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces).
2323
2. Install a Seam SDK and create an API key.
24-
3. Create an [ACS user](../../../products/access-systems/user-management.md).
24+
3. Create an [ACS user](../../../capability-guides/access-systems/user-management.md).
2525
4. Create an encodable key card [ACS credential](../managing-credentials.md) for the ACS user.
2626

2727
This credential contains both the set of entrances to which the user has access and the access schedule for the user.\
@@ -801,7 +801,7 @@ For a deeper dive into ACS concepts and instructions, see the following topics:
801801
* [Access Control System Resources](../connect-an-acs-to-seam/access-control-system-resources.md)
802802
* [Understanding ACS Differences](../connect-an-acs-to-seam/understanding-access-control-system-differences.md)
803803
2. Create ACS users.
804-
* [Managing ACS Users](../../../products/access-systems/user-management.md)
804+
* [Managing ACS Users](../../../capability-guides/access-systems/user-management.md)
805805
3. For relevant access control systems, assign ACS users to access groups.
806806
* [Assigning ACS Users to Access Groups](../user-management/assigning-users-to-access-groups.md)
807807
4. Learn about available entrances.

docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This quick start walks you through the following basic steps:
1919
1. [Connect](../../../core-concepts/workspaces/#connecting-virtual-devices) an access control system to Seam.
2020
* To get started quickly, use a virtual ACS in a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces).
2121
2. Install a Seam SDK and create an API key.
22-
3. Create an [ACS user](../../../products/access-systems/user-management.md).
22+
3. Create an [ACS user](../../../capability-guides/access-systems/user-management.md).
2323
* Also, specify the access schedule for this user.
2424
4. Assign the ACS user to an [access group](../user-management/assigning-users-to-access-groups.md).
2525
* Access groups are preconfigured to grant access to specific entrances.\
@@ -656,7 +656,7 @@ For a deeper dive into ACS concepts and instructions, see the following topics:
656656
* [Access Control System Resources](../connect-an-acs-to-seam/access-control-system-resources.md)
657657
* [Understanding ACS Differences](../connect-an-acs-to-seam/understanding-access-control-system-differences.md)
658658
2. Create ACS users.
659-
* [Managing ACS Users](../../../products/access-systems/user-management.md)
659+
* [Managing ACS Users](../../../capability-guides/access-systems/user-management.md)
660660
3. For relevant access control systems, assign ACS users to access groups.
661661
* [Assigning ACS Users to Access Groups](../user-management/assigning-users-to-access-groups.md)
662662
4. Learn about available entrances.

docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >-
66

77
# Assigning Credentials to ACS Users
88

9-
This guide explains how to assign existing [credentials](managing-credentials.md) to [ACS users](../../products/access-systems/user-management.md) and unassign credentials from users. Once you assign credentials to ACS users, these users can use the credentials to access areas and resources according to their permissions. When you unassign credentials from ACS users, these users can no longer use these specific credentials to access areas or resources.
9+
This guide explains how to assign existing [credentials](managing-credentials.md) to [ACS users](../../capability-guides/access-systems/user-management.md) and unassign credentials from users. Once you assign credentials to ACS users, these users can use the credentials to access areas and resources according to their permissions. When you unassign credentials from ACS users, these users can no longer use these specific credentials to access areas or resources.
1010

1111
***
1212

docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The following diagram shows an example of one ACS, including the ACS resources a
1212

1313
The following table provides a brief description of each of the Seam ACS resources:
1414

15-
<table><thead><tr><th width="248">ACS Resource</th><th>Description</th></tr></thead><tbody><tr><td><p><img src="../../../.gitbook/assets/acs-system_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/systems/"><code>acs_system</code></a></p></td><td>The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.<br>For more information, see <a href="retrieving-acs-system-details.md">Retrieving ACS System Details</a>.</td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-user_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/users/"><code>acs_user</code></a></p></td><td><p>The set of users who access the entrances.</p><p>If you manage multiple ACSs and need to grant the same user access to <a href="../retrieving-entrance-details.md">entrances</a> in multiple ACSs, you can also use Seam <a href="../../../api/user_identities/">user identities</a>. With user identities, you can link an application user in your own system to one or more Seam ACS users.<br>For more information, see <a href="../../../products/access-systems/user-management.md">Managing ACS Users</a>.</p></td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-access-group_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/access-groups/"><code>acs_access_group</code></a></p></td><td>Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.<br>For more information, see <a href="../user-management/assigning-users-to-access-groups.md">Assigning ACS Users to Access Groups</a>.</td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-credential_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/credentials/"><code>acs_credential</code></a></p></td><td>A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.<br>For more information, see <a href="../managing-credentials.md">Managing Credentials</a>.</td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-entrance_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/entrances/"><code>acs_entrance</code></a></p></td><td>The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.<br>For more information, see <a href="../retrieving-entrance-details.md">Retrieving Entrance Details</a>.</td></tr></tbody></table>
15+
<table><thead><tr><th width="248">ACS Resource</th><th>Description</th></tr></thead><tbody><tr><td><p><img src="../../../.gitbook/assets/acs-system_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/systems/"><code>acs_system</code></a></p></td><td>The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.<br>For more information, see <a href="retrieving-acs-system-details.md">Retrieving ACS System Details</a>.</td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-user_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/users/"><code>acs_user</code></a></p></td><td><p>The set of users who access the entrances.</p><p>If you manage multiple ACSs and need to grant the same user access to <a href="../retrieving-entrance-details.md">entrances</a> in multiple ACSs, you can also use Seam <a href="../../../api/user_identities/">user identities</a>. With user identities, you can link an application user in your own system to one or more Seam ACS users.<br>For more information, see <a href="../../../capability-guides/access-systems/user-management.md">Managing ACS Users</a>.</p></td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-access-group_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/access-groups/"><code>acs_access_group</code></a></p></td><td>Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.<br>For more information, see <a href="../user-management/assigning-users-to-access-groups.md">Assigning ACS Users to Access Groups</a>.</td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-credential_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/credentials/"><code>acs_credential</code></a></p></td><td>A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.<br>For more information, see <a href="../managing-credentials.md">Managing Credentials</a>.</td></tr><tr><td><p><img src="../../../.gitbook/assets/acs-entrance_light.png" alt="" data-size="original"></p><p><a href="../../../api/acs/entrances/"><code>acs_entrance</code></a></p></td><td>The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.<br>For more information, see <a href="../retrieving-entrance-details.md">Retrieving Entrance Details</a>.</td></tr></tbody></table>
1616

1717
{% hint style="info" %}
1818
You configure the access schedules for your ACS users either through access groups or credentials, depending on your specific ACS. There is no separate schedule resource in the Seam API.

0 commit comments

Comments
 (0)