Skip to content

Commit 8dab83c

Browse files
authored
Merge branch 'main' into property-italics
2 parents 386970e + 2972c55 commit 8dab83c

113 files changed

Lines changed: 376 additions & 596 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: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@
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)
1826
* [Devices](core-concepts/devices/README.md)
1927
* [Displaying Device Health](core-concepts/devices/displaying-device-health.md)
2028
* [Displaying Device Power Status](core-concepts/devices/displaying-device-power-status.md)
@@ -33,15 +41,7 @@
3341

3442
## Capability Guides
3543

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)
44+
* [📋 Device and System Capabilities](capability-guides/device-and-system-capabilities.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)

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="../../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>
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>
3131

3232
## `client_session` Methods
3333

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="../../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>
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>
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="../../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>
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>
2222

2323
### Sample Request
2424

docs/api-clients/client_sessions/grant_access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Grant a client session access to resources
44

55
# Grant Access to a Client Session
66

7-
Grants a [client session](../../core-concepts/authentication/client-session-tokens/) access to one or more resources, such as [Connect Webviews](../../capability-guides/device-and-system-capabilities/connect-webviews/), [user identities](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.
7+
Grants a [client session](../../core-concepts/authentication/client-session-tokens/) access to one or more resources, such as [Connect Webviews](../../core-concepts/connect-webviews/), [user identities](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.
88

99
{% openapi src="https://connect.getseam.com/openapi.json" path="/client_sessions/grant_access" method="post" %}
1010
[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json)
@@ -16,7 +16,7 @@ Specify the resources that you want a client session to be able to access by inc
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 to associate with the 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</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</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</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 to associate with the 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</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</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</td></tr></tbody></table>
2020

2121
### Sample Request
2222

0 commit comments

Comments
 (0)