Skip to content

Commit e93f136

Browse files
DebbieAtSeamgitbook-bot
authored andcommitted
GITBOOK-602: Add SmartThings thermostats guides
1 parent b014d4b commit e93f136

23 files changed

Lines changed: 5314 additions & 442 deletions
736 KB
Loading
2.76 MB
Loading
2.71 MB
Loading
1.07 MB
Loading
1.32 MB
Loading

docs/SUMMARY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,9 @@
453453
* [Get started with Schlage Locks](device-guides/get-started-with-schlage-locks.md)
454454
* [Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/README.md)
455455
* [Get Started with Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md)
456-
* [Get started with SmartThings Hubs + Smart Locks](device-guides/get-started-with-smartthings-hubs-+-smart-locks.md)
456+
* [SmartThings Hubs + Devices](device-and-system-integration-guides/smartthings-hubs-+-devices/README.md)
457+
* [Get Started with SmartThings Hubs + Thermostats](device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md)
458+
* [Get Started with SmartThings Hubs + Smart Locks](device-guides/get-started-with-smartthings-hubs-+-smart-locks.md)
457459
* [Tedee Locks](device-and-system-integration-guides/tedee-locks/README.md)
458460
* [Get Started with Tedee Locks](device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md)
459461
* [TTLock Locks](device-guides/ttlock-locks.md)

docs/api-clients/client_sessions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ 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="../../api/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>
3131

3232
## `client_session` Methods
3333

docs/api-clients/client_sessions/create.md

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

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

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

1313
## Request
1414

15-
Specify the user ID and, optionally, [connected accounts](../connected_accounts/) associated with the user by including the corresponding parameters in the request body.
15+
Specify the user ID and, optionally, [connected accounts](../../api/connected_accounts/) associated with the user by including the corresponding parameters 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>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>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> associated with this user</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>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>connected_account_ids</code></td><td>Array of strings<br><em>Optional</em></td><td>Array of IDs of the <a href="../../api/connected_accounts/">connected accounts</a> associated with this user</td></tr></tbody></table>
2020

2121
### Sample Request
2222

docs/api-clients/client_sessions/get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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="../../api/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>
3838

3939
### Sample Response
4040

docs/api-clients/client_sessions/get_or_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Specify any combination of desired client session characteristics by including t
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="../../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="../../api/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)