Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ redirects:
core-concepts/connect-webviews: core-concepts/connect-webviews/README.md
capability-guides/access-systems/understanding-acs-differences: capability-guides/access-systems/README.md
capability-guides/thermostats/creating-and-managing-climate-schedules: capability-guides/thermostats/creating-and-managing-thermostat-schedules.md
ui-components/overview/react-components/supported-devices-table: ui-components/overview/make-a-supported-devices-page.md
ui-components/overview/getting-started-with-seam-components/angular: ui-components/overview/make-a-supported-devices-page.md
ui-components/overview/getting-started-with-seam-components/vue: ui-components/overview/make-a-supported-devices-page.md
106 changes: 56 additions & 50 deletions docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,21 +208,8 @@ Next, you can perform the basic action of locking and unlocking the door.
| device\_id | String | |

{% tabs %}
{% tab title="Python" %}
```python
# lock the door
seam.locks.lock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is True

# Now unlock the door
seam.locks.unlock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is False
```
{% endtab %}
{% tab title="JavaScript" %}

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

{% tab title="Python" %}

```python
# lock the door
seam.locks.lock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is True

# Now unlock the door
seam.locks.unlock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is False
```
{% endtab %}

{% tab title="Ruby" %}

```ruby
# lock the door
seam.locks.lock_door(device_id: some_lock.device_id)
Expand All @@ -258,43 +261,8 @@ All Schlage wifi locks come with a keypad built-in to program access codes. Thes
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)

{% tabs %}
{% tab title="Python" %}
```python
# create an ongoing code
seam.access_codes.create(
device=some_lock, code="123456", name="Personal Access Code"
)

# create a timebound code
seam.access_codes.create(
device=some_lock,
code="888888",
name="My Temp Access Code",
starts_at="2028-08-12T19:23:42+0000",
ends_at="2028-08-13T19:23:42+0000"
)

# you can use a device or a device_id as the "device" parameter
seam.access_codes.list(device=some_lock)
# [
# AccessCode(
# access_code_id='af5272b1-2a49-4eb5-9388-2447fc7b5bd1',
# type='ongoing',
# code='123459'
# ),
# AccessCode(
# access_code_id='8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
# type='timebound',
# code='888888',
# starts_at='2028-08-12T19:24:00.000Z',
# ends_at='2028-08-13T19:24:00.000Z',
# )
# ]

```
{% endtab %}
{% tab title="JavaScript" %}

{% tab title="Javascript" %}
```javascript
// create an ongoing code
await seam.accessCodes.create({
Expand Down Expand Up @@ -338,7 +306,45 @@ await seam.accessCodes.list({
```
{% endtab %}

{% tab title="Python" %}

```python
# create an ongoing code
seam.access_codes.create(
device=some_lock, code="123456", name="Personal Access Code"
)

# create a timebound code
seam.access_codes.create(
device=some_lock,
code="888888",
name="My Temp Access Code",
starts_at="2028-08-12T19:23:42+0000",
ends_at="2028-08-13T19:23:42+0000"
)

# you can use a device or a device_id as the "device" parameter
seam.access_codes.list(device=some_lock)
# [
# AccessCode(
# access_code_id='af5272b1-2a49-4eb5-9388-2447fc7b5bd1',
# type='ongoing',
# code='123459'
# ),
# AccessCode(
# access_code_id='8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
# type='timebound',
# code='888888',
# starts_at='2028-08-12T19:24:00.000Z',
# ends_at='2028-08-13T19:24:00.000Z',
# )
# ]

```
{% endtab %}

{% tab title="Ruby" %}

```ruby
# create an ongoing code
seam.access_codes.create(
Expand Down
3 changes: 0 additions & 3 deletions docs/guides/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,6 @@
* [Seam Components](ui-components/overview/README.md)
* [Getting Started with Seam Components](ui-components/overview/getting-started-with-seam-components/README.md)
* [Get Started with React](ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens.md)
* [Get started with Angular](ui-components/overview/getting-started-with-seam-components/angular.md)
* [Get started with Vue](ui-components/overview/getting-started-with-seam-components/vue.md)
* [Get started with Client Side Components](ui-components/overview/getting-started-with-seam-components/get-started-with-client-side-components.md)
* [Components](ui-components/overview/react-components/README.md)
* [Device Details](ui-components/overview/react-components/device-details.md)
Expand All @@ -148,7 +146,6 @@
* [Access Code Details](ui-components/overview/react-components/access-code-details.md)
* [Create Access Code Form](ui-components/overview/react-components/create-access-code-form.md)
* [Update Access Code Form](ui-components/overview/react-components/update-access-code-form.md)
* [Supported Devices Table](ui-components/overview/react-components/supported-devices-table.md)
* [Seam Provider](ui-components/overview/react-components/seam-provider.md)
* [Connect Account Button](ui-components/overview/react-components/connect-account-button.md)
* [Make a Supported Devices Page](ui-components/overview/make-a-supported-devices-page.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/ui-components/overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Features include:

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

<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>
<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>

## Next Steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,4 @@ description: Learn how to get started using Seam Components.
The following topics help you to get started using Seam Components in various types of applications:

* [Get Started with React](get-started-with-react-components-and-client-session-tokens.md)
* [Get Started with Angular](angular.md)
* [Get Started with Vue](vue.md)
Comment thread
sybohy marked this conversation as resolved.
* [Get Started with Client Side Components](get-started-with-client-side-components.md)

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Then import the custom elements bundle in your application entrypoint:
import "@seamapi/react/elements.js"
```

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).
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`).

```html
<seam-connect-account-button publishable-key="your_publishable_key"></seam-connect-account-button>
Expand Down
Loading
Loading