Skip to content

Commit be44eec

Browse files
sybohyclaudeseambot
authored
docs: retire seam-supported-device-table references (#1109)
* docs: replace retired supported-device-table with custom-device-db-web The internal device-db endpoint that powered <seam-supported-device-table> has been retired. Update the "Make a Supported Devices Page" guide to use <device-list-by-capability> from seamapi/custom-device-db-web, served from the Seam CDN, including the API-token request step and version pinning guidance. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * ci: Format code * docs: use canonical can_* capability flag names and trim repo link - Replace README short-form capability slugs (remoteunlock, walletkeys) with canonical Seam capability flag names (can_program_online_access_codes, can_provision_wallet_keys) to match the storybook examples and the rest of the docs. - Link the capability-name attribute to the Device and System Capabilities guide so readers can find the full flag list. - Drop the GitHub repo bullet from Next Steps per review feedback. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: remove guides for retired seam-supported-device-table The earlier <seam-supported-device-table> component depended on the now-retired internal device-db endpoint and no longer loads. The new <device-list-by-capability> component is framework-agnostic and only needs the one consolidated guide, so per-framework setup pages are no longer needed. - Delete react-components/supported-devices-table.md (reference page for the dead React component, including an inline live embed that now 404s). - Delete getting-started-with-seam-components/angular.md and vue.md (both used the dead component as their primary example). - Remove the entries from SUMMARY.md and the parent index/card pages. - Update the framework note in make-a-supported-devices-page.md and get-started-with-client-side-components.md to point at framework-native web components docs instead of the deleted guides. - Add .gitbook.yaml redirects from the deleted URLs to the consolidated supported devices page so external links don't break. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Seam Bot <seambot@getseam.com>
1 parent 4b3b680 commit be44eec

11 files changed

Lines changed: 130 additions & 364 deletions

File tree

.gitbook.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,6 @@ redirects:
2323
core-concepts/connect-webviews: core-concepts/connect-webviews/README.md
2424
capability-guides/access-systems/understanding-acs-differences: capability-guides/access-systems/README.md
2525
capability-guides/thermostats/creating-and-managing-climate-schedules: capability-guides/thermostats/creating-and-managing-thermostat-schedules.md
26+
ui-components/overview/react-components/supported-devices-table: ui-components/overview/make-a-supported-devices-page.md
27+
ui-components/overview/getting-started-with-seam-components/angular: ui-components/overview/make-a-supported-devices-page.md
28+
ui-components/overview/getting-started-with-seam-components/vue: ui-components/overview/make-a-supported-devices-page.md

docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md

Lines changed: 56 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -208,21 +208,8 @@ Next, you can perform the basic action of locking and unlocking the door.
208208
| device\_id | String | |
209209

210210
{% tabs %}
211-
{% tab title="Python" %}
212-
```python
213-
# lock the door
214-
seam.locks.lock_door(device_id: some_lock.device_id)
215-
updated_lock = seam.locks.get(device_id: some_lock.device_id)
216-
assert updated_lock.properties["locked"] is True
217-
218-
# Now unlock the door
219-
seam.locks.unlock_door(device_id: some_lock.device_id)
220-
updated_lock = seam.locks.get(device_id: some_lock.device_id)
221-
assert updated_lock.properties["locked"] is False
222-
```
223-
{% endtab %}
211+
{% tab title="JavaScript" %}
224212

225-
{% tab title="Javascript" %}
226213
```javascript
227214
// lock the door
228215
await seam.locks.lockDoor(someLock.device_id)
@@ -236,7 +223,23 @@ console.log(updatedLock.properties.locked) // false
236223
```
237224
{% endtab %}
238225

226+
{% tab title="Python" %}
227+
228+
```python
229+
# lock the door
230+
seam.locks.lock_door(device_id: some_lock.device_id)
231+
updated_lock = seam.locks.get(device_id: some_lock.device_id)
232+
assert updated_lock.properties["locked"] is True
233+
234+
# Now unlock the door
235+
seam.locks.unlock_door(device_id: some_lock.device_id)
236+
updated_lock = seam.locks.get(device_id: some_lock.device_id)
237+
assert updated_lock.properties["locked"] is False
238+
```
239+
{% endtab %}
240+
239241
{% tab title="Ruby" %}
242+
240243
```ruby
241244
# lock the door
242245
seam.locks.lock_door(device_id: some_lock.device_id)
@@ -258,43 +261,8 @@ All Schlage wifi locks come with a keypad built-in to program access codes. Thes
258261
The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Schlage lock. You can find out more about Schlage lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)
259262

260263
{% tabs %}
261-
{% tab title="Python" %}
262-
```python
263-
# create an ongoing code
264-
seam.access_codes.create(
265-
device=some_lock, code="123456", name="Personal Access Code"
266-
)
267-
268-
# create a timebound code
269-
seam.access_codes.create(
270-
device=some_lock,
271-
code="888888",
272-
name="My Temp Access Code",
273-
starts_at="2028-08-12T19:23:42+0000",
274-
ends_at="2028-08-13T19:23:42+0000"
275-
)
276-
277-
# you can use a device or a device_id as the "device" parameter
278-
seam.access_codes.list(device=some_lock)
279-
# [
280-
# AccessCode(
281-
# access_code_id='af5272b1-2a49-4eb5-9388-2447fc7b5bd1',
282-
# type='ongoing',
283-
# code='123459'
284-
# ),
285-
# AccessCode(
286-
# access_code_id='8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
287-
# type='timebound',
288-
# code='888888',
289-
# starts_at='2028-08-12T19:24:00.000Z',
290-
# ends_at='2028-08-13T19:24:00.000Z',
291-
# )
292-
# ]
293-
294-
```
295-
{% endtab %}
264+
{% tab title="JavaScript" %}
296265

297-
{% tab title="Javascript" %}
298266
```javascript
299267
// create an ongoing code
300268
await seam.accessCodes.create({
@@ -338,7 +306,45 @@ await seam.accessCodes.list({
338306
```
339307
{% endtab %}
340308

309+
{% tab title="Python" %}
310+
311+
```python
312+
# create an ongoing code
313+
seam.access_codes.create(
314+
device=some_lock, code="123456", name="Personal Access Code"
315+
)
316+
317+
# create a timebound code
318+
seam.access_codes.create(
319+
device=some_lock,
320+
code="888888",
321+
name="My Temp Access Code",
322+
starts_at="2028-08-12T19:23:42+0000",
323+
ends_at="2028-08-13T19:23:42+0000"
324+
)
325+
326+
# you can use a device or a device_id as the "device" parameter
327+
seam.access_codes.list(device=some_lock)
328+
# [
329+
# AccessCode(
330+
# access_code_id='af5272b1-2a49-4eb5-9388-2447fc7b5bd1',
331+
# type='ongoing',
332+
# code='123459'
333+
# ),
334+
# AccessCode(
335+
# access_code_id='8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
336+
# type='timebound',
337+
# code='888888',
338+
# starts_at='2028-08-12T19:24:00.000Z',
339+
# ends_at='2028-08-13T19:24:00.000Z',
340+
# )
341+
# ]
342+
343+
```
344+
{% endtab %}
345+
341346
{% tab title="Ruby" %}
347+
342348
```ruby
343349
# create an ongoing code
344350
seam.access_codes.create(

docs/guides/SUMMARY.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,6 @@
138138
* [Seam Components](ui-components/overview/README.md)
139139
* [Getting Started with Seam Components](ui-components/overview/getting-started-with-seam-components/README.md)
140140
* [Get Started with React](ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens.md)
141-
* [Get started with Angular](ui-components/overview/getting-started-with-seam-components/angular.md)
142-
* [Get started with Vue](ui-components/overview/getting-started-with-seam-components/vue.md)
143141
* [Get started with Client Side Components](ui-components/overview/getting-started-with-seam-components/get-started-with-client-side-components.md)
144142
* [Components](ui-components/overview/react-components/README.md)
145143
* [Device Details](ui-components/overview/react-components/device-details.md)
@@ -148,7 +146,6 @@
148146
* [Access Code Details](ui-components/overview/react-components/access-code-details.md)
149147
* [Create Access Code Form](ui-components/overview/react-components/create-access-code-form.md)
150148
* [Update Access Code Form](ui-components/overview/react-components/update-access-code-form.md)
151-
* [Supported Devices Table](ui-components/overview/react-components/supported-devices-table.md)
152149
* [Seam Provider](ui-components/overview/react-components/seam-provider.md)
153150
* [Connect Account Button](ui-components/overview/react-components/connect-account-button.md)
154151
* [Make a Supported Devices Page](ui-components/overview/make-a-supported-devices-page.md)

docs/guides/ui-components/overview/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Features include:
1313

1414
## [Getting started with Components ->](getting-started-with-seam-components/get-started-with-client-side-components.md)
1515

16-
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Device Table</strong><br>Display a list of devices, and filter for all the devices with issues.</td><td></td><td></td><td><a href="../../.gitbook/assets/seam-component-device-table.png">seam-component-device-table.png</a></td><td><a href="react-components/device-table.md">device-table.md</a></td></tr><tr><td><strong>Device Details</strong></td><td>Display a device's properties and settings, alerts, and warnings.</td><td></td><td><a href="../../.gitbook/assets/seam-component-device-details.png">seam-component-device-details.png</a></td><td><a href="react-components/device-details.md">device-details.md</a></td></tr><tr><td><strong>Access Code Table</strong><br>Display a list of access codes, and filter for all the access codes with issues.</td><td></td><td></td><td><a href="../../.gitbook/assets/seam-component-access-code-table.png">seam-component-access-code-table.png</a></td><td><a href="react-components/access-code-table.md">access-code-table.md</a></td></tr><tr><td><strong>Access Code Details</strong></td><td>Display an access code's properties, alerts and warnings.</td><td></td><td><a href="../../.gitbook/assets/seam-component-access-code-details.png">seam-component-access-code-details.png</a></td><td><a href="react-components/access-code-details.md">access-code-details.md</a></td></tr><tr><td><strong>Supported Devices Table</strong></td><td>Display a list of all the devices that you support through Seam.</td><td></td><td><a href="../../.gitbook/assets/seam-component-supported-devices-table.png">seam-component-supported-devices-table.png</a></td><td><a href="react-components/supported-devices-table.md">supported-devices-table.md</a></td></tr></tbody></table>
16+
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Device Table</strong><br>Display a list of devices, and filter for all the devices with issues.</td><td></td><td></td><td><a href="../../.gitbook/assets/seam-component-device-table.png">seam-component-device-table.png</a></td><td><a href="react-components/device-table.md">device-table.md</a></td></tr><tr><td><strong>Device Details</strong></td><td>Display a device's properties and settings, alerts, and warnings.</td><td></td><td><a href="../../.gitbook/assets/seam-component-device-details.png">seam-component-device-details.png</a></td><td><a href="react-components/device-details.md">device-details.md</a></td></tr><tr><td><strong>Access Code Table</strong><br>Display a list of access codes, and filter for all the access codes with issues.</td><td></td><td></td><td><a href="../../.gitbook/assets/seam-component-access-code-table.png">seam-component-access-code-table.png</a></td><td><a href="react-components/access-code-table.md">access-code-table.md</a></td></tr><tr><td><strong>Access Code Details</strong></td><td>Display an access code's properties, alerts and warnings.</td><td></td><td><a href="../../.gitbook/assets/seam-component-access-code-details.png">seam-component-access-code-details.png</a></td><td><a href="react-components/access-code-details.md">access-code-details.md</a></td></tr></tbody></table>
1717

1818
## Next Steps
1919

docs/guides/ui-components/overview/getting-started-with-seam-components/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,4 @@ description: Learn how to get started using Seam Components.
77
The following topics help you to get started using Seam Components in various types of applications:
88

99
* [Get Started with React](get-started-with-react-components-and-client-session-tokens.md)
10-
* [Get Started with Angular](angular.md)
11-
* [Get Started with Vue](vue.md)
1210
* [Get Started with Client Side Components](get-started-with-client-side-components.md)

docs/guides/ui-components/overview/getting-started-with-seam-components/angular.md

Lines changed: 0 additions & 106 deletions
This file was deleted.

docs/guides/ui-components/overview/getting-started-with-seam-components/get-started-with-client-side-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Then import the custom elements bundle in your application entrypoint:
8989
import "@seamapi/react/elements.js"
9090
```
9191

92-
Add the components where your framework renders HTML. Some frameworks may require additional configuration to enable web component support, e.g., [Angular](angular.md) or [Vue](vue.md).
92+
Add the components where your framework renders HTML. Some frameworks require additional configuration to enable web component support — refer to your framework's documentation (for example, [Vue's web components guide](https://vuejs.org/guide/extras/web-components.html) or Angular's `CUSTOM_ELEMENTS_SCHEMA`).
9393

9494
```html
9595
<seam-connect-account-button publishable-key="your_publishable_key"></seam-connect-account-button>

0 commit comments

Comments
 (0)