Skip to content

Commit e8b4723

Browse files
DebbieAtSeamgitbook-bot
authored andcommitted
GITBOOK-585: Add thermostat programs
1 parent 4a8008b commit e8b4723

128 files changed

Lines changed: 1307 additions & 471 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/SUMMARY.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@
1515
* [Personal Access Tokens](core-concepts/authentication/personal-access-tokens.md)
1616
* [Client Sessions and Client Session Tokens](core-concepts/authentication/client-session-tokens/README.md)
1717
* [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)
18-
* [Connect Webviews](core-concepts/connect-webviews/README.md)
19-
* [Connect Webview Process](core-concepts/connect-webviews/connect-webview-process.md)
20-
* [Embedding a Connect Webview in Your App](core-concepts/connect-webviews/embedding-a-connect-webview-in-your-app.md)
21-
* [Verifying Successful Account Connection](core-concepts/connect-webviews/verifying-successful-account-connection.md)
22-
* [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)
23-
* [Attaching Custom Metadata to the Connect Webview](core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md)
24-
* [Filtering Connect Webviews by Custom Metadata](core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md)
25-
* [Customizing Connect Webviews](core-concepts/connect-webviews/customizing-connect-webviews.md)
2618
* [Devices](core-concepts/devices/README.md)
2719
* [Displaying Device Health](core-concepts/devices/displaying-device-health.md)
2820
* [Displaying Device Power Status](core-concepts/devices/displaying-device-power-status.md)
@@ -41,7 +33,15 @@
4133

4234
## Capability Guides
4335

44-
* [📋 Device and System Capabilities](capability-guides/device-and-system-capabilities.md)
36+
* [📋 Device and System Capabilities](capability-guides/device-and-system-capabilities/README.md)
37+
* [Connect Webviews](capability-guides/device-and-system-capabilities/connect-webviews/README.md)
38+
* [Connect Webview Process](capability-guides/device-and-system-capabilities/connect-webviews/connect-webview-process.md)
39+
* [Embedding a Connect Webview in Your App](capability-guides/device-and-system-capabilities/connect-webviews/embedding-a-connect-webview-in-your-app.md)
40+
* [Verifying Successful Account Connection](capability-guides/device-and-system-capabilities/connect-webviews/verifying-successful-account-connection.md)
41+
* [Retrieving Devices or Access Control Systems Connected Through a Connect Webview](capability-guides/device-and-system-capabilities/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.md)
42+
* [Attaching Custom Metadata to the Connect Webview](capability-guides/device-and-system-capabilities/connect-webviews/attaching-custom-data-to-the-connect-webview.md)
43+
* [Filtering Connect Webviews by Custom Metadata](capability-guides/device-and-system-capabilities/connect-webviews/filtering-connect-webviews-by-custom-metadata.md)
44+
* [Customizing Connect Webviews](capability-guides/device-and-system-capabilities/connect-webviews/customizing-connect-webviews.md)
4545
* [🔒 Smart Locks](products/smart-locks/README.md)
4646
* [Locking and Unlocking Smart Locks](products/smart-locks/lock-and-unlock.md)
4747
* [Creating and Managing Smart Lock Access Codes](products/smart-locks/access-codes/README.md)
@@ -99,6 +99,7 @@
9999
* [Setting the Fallback Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md)
100100
* [Activating a Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md)
101101
* [Creating and Managing Thermostat Schedules](capability-guides/thermostats/creating-and-managing-thermostat-schedules.md)
102+
* [Creating and Managing Thermostat Programs](capability-guides/thermostats/creating-and-managing-thermostat-programs.md)
102103
* [Testing Your Thermostat App with Simulate Endpoints](capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md)
103104
* [👂 Noise Sensors](products/noise-sensors/README.md)
104105
* [Configuring Noise Threshold Settings](products/noise-sensors/configure-noise-threshold-settings.md)

docs/api-clients/action_attempts/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111

1212
### Action Types
1313

14-
| `CREATE_ACCESS_CODE` | [Creates an Access Code](../access\_codes/create.md) for a keypad lock |
15-
| ------------------------ | --------------------------------------------------------------------------------------------- |
16-
| `DELETE_ACCESS_CODE` | [Deletes an Access Code](../access\_codes/delete.md) for a keypad lock |
17-
| `LOCK_DOOR` | [Locks a Door Lock](../locks/lock\_door.md) for a door lock |
18-
| `UNLOCK_DOOR` | [Unlocks a Door Lock](../locks/unlock\_door.md) for a door lock |
19-
| `CREATE_NOISE_THRESHOLD` | [Creates a Noise Threshold](../noise\_sensors/noise\_thresholds/create.md) for a noise sensor |
20-
| `REMOVE_NOISE_THRESHOLD` | [Removes a Noise Threshold](../noise\_sensors/noise\_thresholds/delete.md) for a noise sensor |
14+
| `CREATE_ACCESS_CODE` | [Creates an Access Code](../../api/access_codes/create.md) for a keypad lock |
15+
| ------------------------ | ------------------------------------------------------------------------------------------- |
16+
| `DELETE_ACCESS_CODE` | [Deletes an Access Code](../../api/access_codes/delete.md) for a keypad lock |
17+
| `LOCK_DOOR` | [Locks a Door Lock](../locks/lock_door.md) for a door lock |
18+
| `UNLOCK_DOOR` | [Unlocks a Door Lock](../locks/unlock_door.md) for a door lock |
19+
| `CREATE_NOISE_THRESHOLD` | [Creates a Noise Threshold](../noise_sensors/noise_thresholds/create.md) for a noise sensor |
20+
| `REMOVE_NOISE_THRESHOLD` | [Removes a Noise Threshold](../noise_sensors/noise_thresholds/delete.md) for a noise sensor |
2121

2222
### List of Methods
2323

docs/api-clients/client_sessions/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ For more information about client sessions and client session tokens, see the fo
2727

2828
The `client_session` object has the following properties:
2929

30-
<table><thead><tr><th width="272">Property</th><th width="132">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>client_session_id</code></td><td>String<br><em>Required</em></td><td>ID of the client session</td></tr><tr><td><code>user_identifier_key</code></td><td>String<br><em>Required</em></td><td>Your own internal user ID for the user</td></tr><tr><td><code>created_at</code></td><td>String<br><em>Required</em></td><td>Date and time at which the client session was created</td></tr><tr><td><code>token</code></td><td>String<br><em>Required</em></td><td>Token that enables you to call <a href="../../seam-components/overview/">Seam components</a> while restricting a user's access to only devices that they own</td></tr><tr><td><code>device_count</code></td><td>Number<br><em>Required</em></td><td>Number of <a href="../../core-concepts/devices/">devices</a> to which this client session grants access</td></tr><tr><td><code>connected_account_ids</code></td><td>Array of strings<br><em>Required</em></td><td>Array of IDs of the <a href="../connected_accounts/">connected accounts</a> associated with this client session</td></tr><tr><td><code>connect_webview_ids</code></td><td>Array of strings<br><em>Required</em></td><td>IDs of the <a href="../../core-concepts/connect-webviews/">Connect Webviews</a> associated with this client session</td></tr><tr><td><code>workspace_id</code></td><td>String<br><em>Required</em></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> associated with this client session</td></tr></tbody></table>
30+
<table><thead><tr><th width="272">Property</th><th width="132">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>client_session_id</code></td><td>String<br><em>Required</em></td><td>ID of the client session</td></tr><tr><td><code>user_identifier_key</code></td><td>String<br><em>Required</em></td><td>Your own internal user ID for the user</td></tr><tr><td><code>created_at</code></td><td>String<br><em>Required</em></td><td>Date and time at which the client session was created</td></tr><tr><td><code>token</code></td><td>String<br><em>Required</em></td><td>Token that enables you to call <a href="../../seam-components/overview/">Seam components</a> while restricting a user's access to only devices that they own</td></tr><tr><td><code>device_count</code></td><td>Number<br><em>Required</em></td><td>Number of <a href="../../core-concepts/devices/">devices</a> to which this client session grants access</td></tr><tr><td><code>connected_account_ids</code></td><td>Array of strings<br><em>Required</em></td><td>Array of IDs of the <a href="../connected_accounts/">connected accounts</a> associated with this client session</td></tr><tr><td><code>connect_webview_ids</code></td><td>Array of strings<br><em>Required</em></td><td>IDs of the <a href="../../capability-guides/device-and-system-capabilities/connect-webviews/">Connect Webviews</a> associated with this client session</td></tr><tr><td><code>workspace_id</code></td><td>String<br><em>Required</em></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> associated with this client session</td></tr></tbody></table>
3131

3232
## `client_session` Methods
3333

3434
You can perform the following actions on `client_session` objects:
3535

3636
* [Create a client session](create.md)
37-
* [Get or create a client session](get\_or\_create.md)
37+
* [Get or create a client session](get_or_create.md)
3838
* [List client sessions](list.md)
3939
* [Get a client session](get.md)
40-
* [Grant Access to a Client Session](grant\_access.md)
40+
* [Grant Access to a Client Session](grant_access.md)
4141
* [Delete a client session](delete.md)

docs/api-clients/client_sessions/get.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ description: Get a specified client session
66

77
Returns a specified [client session](../../core-concepts/authentication/client-session-tokens/).
88

9-
{% swagger src="https://connect.getseam.com/openapi.json" path="/client_sessions/get" method="post" %}
9+
{% openapi src="https://connect.getseam.com/openapi.json" path="/client_sessions/get" method="post" %}
1010
[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json)
11-
{% endswagger %}
11+
{% endopenapi %}
1212

1313
## Request
1414

1515
Specify the desired client session by including the corresponding `client_session_id` or `user_identifier_key` in the request body.
1616

1717
### Request Body Parameters
1818

19-
<table><thead><tr><th>Parameter</th><th width="112.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>client_session_id</code></td><td>String<br><em>Optional</em></td><td>ID of the desired client session.</td></tr><tr><td><code>user_identifier_key</code></td><td>String<br><em>Optional</em></td><td>Your own internal user ID for the user associated with the client session to retrieve. </td></tr></tbody></table>
19+
<table><thead><tr><th>Parameter</th><th width="112.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>client_session_id</code></td><td>String<br><em>Optional</em></td><td>ID of the desired client session.</td></tr><tr><td><code>user_identifier_key</code></td><td>String<br><em>Optional</em></td><td>Your own internal user ID for the user associated with the client session to retrieve.</td></tr></tbody></table>
2020

2121
### Sample Request
2222

@@ -34,7 +34,7 @@ const clientSession = await seam.clientSessions.get({
3434

3535
Returns a `client_session` containing the following properties:
3636

37-
<table><thead><tr><th width="310">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>workspace_id</code></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> that contains the client session</td></tr><tr><td><code>token</code></td><td>Client session token associated with the client session</td></tr><tr><td><code>user_identifier_key</code></td><td>Your own internal user ID for the user</td></tr><tr><td><code>created_at</code></td><td>Date and time at which the client session was created</td></tr><tr><td><code>client_session_id</code></td><td>ID of the client session</td></tr><tr><td><code>device_count</code></td><td>Number of devices to which the client session grants access</td></tr><tr><td><code>connected_account_ids</code></td><td>Array of <a href="../connected_accounts/">connected account</a> IDs associated with this client session</td></tr><tr><td><code>connect_webview_ids</code></td><td>Array of <a href="../../core-concepts/connect-webviews/">Connect Webview</a> IDs associated with the client session</td></tr><tr><td><code>user_identity_ids</code></td><td>Array of user identity IDs on behalf of which which the client session may act</td></tr></tbody></table>
37+
<table><thead><tr><th width="310">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>workspace_id</code></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> that contains the client session</td></tr><tr><td><code>token</code></td><td>Client session token associated with the client session</td></tr><tr><td><code>user_identifier_key</code></td><td>Your own internal user ID for the user</td></tr><tr><td><code>created_at</code></td><td>Date and time at which the client session was created</td></tr><tr><td><code>client_session_id</code></td><td>ID of the client session</td></tr><tr><td><code>device_count</code></td><td>Number of devices to which the client session grants access</td></tr><tr><td><code>connected_account_ids</code></td><td>Array of <a href="../connected_accounts/">connected account</a> IDs associated with this client session</td></tr><tr><td><code>connect_webview_ids</code></td><td>Array of <a href="../../capability-guides/device-and-system-capabilities/connect-webviews/">Connect Webview</a> IDs associated with the client session</td></tr><tr><td><code>user_identity_ids</code></td><td>Array of user identity IDs on behalf of which which the client session may act</td></tr></tbody></table>
3838

3939
### Sample Response
4040

docs/api-clients/client_sessions/get_or_create.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ description: >-
88

99
Gets a [client session](../../core-concepts/authentication/client-session-tokens/) with specific characteristics or create a new client session with these characteristics if it does not yet exist.
1010

11-
{% swagger src="https://connect.getseam.com/openapi.json" path="/client_sessions/get_or_create" method="post" %}
11+
{% openapi src="https://connect.getseam.com/openapi.json" path="/client_sessions/get_or_create" method="post" %}
1212
[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json)
13-
{% endswagger %}
13+
{% endopenapi %}
1414

1515
## Request
1616

1717
Specify any combination of desired client session characteristics by including the corresponding parameters in the request body.
1818

1919
### Request Body Parameters
2020

21-
<table><thead><tr><th>Parameter</th><th width="112.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>user_identifier_key</code></td><td>String<br><em>Optional</em></td><td>Your own internal user ID for the user to associate with the client session (or that is already associated with the existing client session)</td></tr><tr><td><code>connect_webview_ids</code></td><td>Array of strings<br><em>Optional</em></td><td>Array of IDs of the <a href="../../core-concepts/connect-webviews/">Connect Webviews</a> to associate with the client session (or that are already associated with the existing client session)</td></tr><tr><td><code>connected_account_ids</code></td><td>Array of strings<br><em>Optional</em></td><td>Array of IDs of the <a href="../connected_accounts/">connected accounts</a> to associate with the client session (or that are already associated with the existing client session)</td></tr><tr><td><code>user_identity_ids</code></td><td>Array of strings<br><em>Optional</em></td><td>Array of IDs of the <a href="../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity">user identities</a> to associate with the client session (or that are already associated with the existing client session)</td></tr><tr><td><code>expires_at</code></td><td>String<br><em>Optional</em></td><td>Date and time at which the client session should expire (or at which the existing client session expires)</td></tr></tbody></table>
21+
<table><thead><tr><th>Parameter</th><th width="112.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>user_identifier_key</code></td><td>String<br><em>Optional</em></td><td>Your own internal user ID for the user to associate with the client session (or that is already associated with the existing client session)</td></tr><tr><td><code>connect_webview_ids</code></td><td>Array of strings<br><em>Optional</em></td><td>Array of IDs of the <a href="../../capability-guides/device-and-system-capabilities/connect-webviews/">Connect Webviews</a> to associate with the client session (or that are already associated with the existing client session)</td></tr><tr><td><code>connected_account_ids</code></td><td>Array of strings<br><em>Optional</em></td><td>Array of IDs of the <a href="../connected_accounts/">connected accounts</a> to associate with the client session (or that are already associated with the existing client session)</td></tr><tr><td><code>user_identity_ids</code></td><td>Array of strings<br><em>Optional</em></td><td>Array of IDs of the <a href="../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity">user identities</a> to associate with the client session (or that are already associated with the existing client session)</td></tr><tr><td><code>expires_at</code></td><td>String<br><em>Optional</em></td><td>Date and time at which the client session should expire (or at which the existing client session expires)</td></tr></tbody></table>
2222

2323
### Sample Request
2424

0 commit comments

Comments
 (0)