Skip to content

Commit de4583e

Browse files
mikewuumikewuu
authored
Merge branch 'main' into param-json-type
2 parents f72d2e4 + f9cba06 commit de4583e

17 files changed

Lines changed: 851 additions & 1177 deletions

File tree

‎docs/api-clients/connect_webviews/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ To enable a user to connect their device account to Seam through your app, you m
1616

1717
| **`connect_webview_id`** | String (UUID) | ID of the Connect Webview |
1818
| -------------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19-
| **`accepted_providers`** | Array of strings | List of accepted [device provider keys](./#device-provider-keys) |
19+
| **`accepted_providers`** | Array of strings | List of accepted [device provider keys](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews) |
2020
| **`accepted_devices`** | Array of strings | List of accepted [devices](../../core-concepts/devices/) |
2121
| **`any_provider_allowed`** | Boolean | Indicates whether any provider is allowed |
2222
| **`any_device_allowed`** | Boolean | Indicates whether any device is allowed |
23-
| **`selected_provider`** | String | Selected provider of the Connect Webview, one of [device provider keys](./#device-provider-keys) |
23+
| **`selected_provider`** | String | Selected provider of the Connect Webview, one of [device provider keys](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews) |
2424
| **`custom_metadata`** | <p>JSON object</p><p><em>Optional</em></p> | <p>A set of up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters<br>For more information, see <a href="../../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md">Attaching Custom Data to the Connect Webview</a>.</p> |
2525
| **`automatically_manage_new_devices`** | Boolean | Indicates whether Seam should [import all new devices](../../core-concepts/connect-webviews/customizing-connect-webviews.md#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API |
2626
| **`wait_for_device_creation`** | Boolean | Indicates whether Seam should [finish syncing all devices](../../core-concepts/connect-webviews/customizing-connect-webviews.md#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview |

‎docs/api-clients/connect_webviews/create.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ To enable a user to connect their devices or systems to Seam, they must sign in
1616

1717
### Request Parameters
1818

19-
| Parameter | Type | Description |
20-
| ---------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21-
| `provider_category` | String | <p>Specifies the category of providers to include.<br>Supported categories:</p><ul><li><code>stable</code></li><li><code>consumer_smartlocks</code></li><li><code>thermostats</code></li><li><code>noise_sensors</code></li></ul><p>See <a href="./#provider-category-keys">Provider Category Keys</a>.</p> |
22-
| `accepted_providers` | String\[] | Array of accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Device Provider Keys](./#device-provider-keys). |
23-
| `custom_redirect_url` | <p>String<br><em>Optional</em></p> | URL to redirect user to after provider login is complete |
24-
| `custom_redirect_failure_url` | <p>String</p><p>Optional</p> | Alternative URL to redirect the user on error. If this is not set, falls back to `custom_redirect_url` |
25-
| `automatically_manage_new_devices` | Boolean | <p>Indicates whether newly added devices should appear as managed devices<br>Default: <code>true</code></p> |
19+
| Parameter | Type | Description |
20+
| ---------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| `provider_category` | String | <p>Specifies the category of providers to include.<br>Supported categories:</p><ul><li><code>stable</code></li><li><code>consumer_smartlocks</code></li><li><code>thermostats</code></li><li><code>noise_sensors</code></li></ul><p>See <a href="../../core-concepts/connect-webviews/connect-webview-process.md#step-1-create-a-connect-webview">Step 1: Create a Connect Webview</a>.</p> |
22+
| `accepted_providers` | String\[] | Array of accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See the list of [device provider keys](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). |
23+
| `custom_redirect_url` | <p>String<br><em>Optional</em></p> | URL to redirect user to after provider login is complete |
24+
| `custom_redirect_failure_url` | <p>String</p><p>Optional</p> | Alternative URL to redirect the user on error. If this is not set, falls back to `custom_redirect_url` |
25+
| `automatically_manage_new_devices` | Boolean | <p>Indicates whether newly added devices should appear as managed devices<br>Default: <code>true</code></p> |
2626

2727
### Sample Request
2828

‎docs/api-clients/connect_webviews/list.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ echo json_encode($webviews);
6363

6464
Returns a `connect_webviews` array, in which each returned `connect_webview` contains the following properties:
6565

66-
<table><thead><tr><th width="310">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>connect_webview_id</code></td><td>ID of the Connect Webview</td></tr><tr><td><code>connected_account_id</code></td><td>ID of the <a href="../connected_accounts/">connected account</a> that was created after the user successfully logged in</td></tr><tr><td><code>url</code></td><td>URL for the Connect Webview</td></tr><tr><td><code>workspace_id</code></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> that contains the Connect Webview</td></tr><tr><td><code>device_selection_mode</code></td><td>Device selection mode, including <code>none</code>, <code>single</code>, or <code>multiple</code></td></tr><tr><td><code>accepted_providers</code></td><td>List of accepted <a href="list.md#device-provider-keys">device provider keys</a></td></tr><tr><td><code>accepted_devices</code></td><td>List of accepted <a href="../../core-concepts/devices/">devices</a></td></tr><tr><td><code>any_provider_allowed</code></td><td>Indicates whether any provider is allowed</td></tr><tr><td><code>any_device_allowed</code></td><td>Indicates whether any device is allowed</td></tr><tr><td><code>created_at</code></td><td>Date and time at which the Connect Webview was created</td></tr><tr><td><code>login_successful</code></td><td>Indicates whether the user logged in successfully using the Connect Webview</td></tr><tr><td><code>status</code></td><td>Status of the Connect Webview, including <code>pending</code> or <code>authorized</code></td></tr><tr><td><code>custom_redirect_url</code></td><td>If set, the Connect Webview redirects to this URL when the user successfully pairs a device or, if the <code>custom_redirect_failure_url</code> is not set, when an unexpected error occurs</td></tr><tr><td><code>custom_redirect_failure_url</code></td><td>If set, the Connect Webview redirects to this URL when an unexpected error occurs</td></tr><tr><td><code>custom_metadata</code></td><td>Set of up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters<br>For more information, see <a href="../../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md">Attaching Custom Data to the Connect Webview</a>.</td></tr><tr><td><code>automatically_manage_new_devices</code></td><td>Indicates whether Seam should <a href="../../core-concepts/connect-webviews/customizing-connect-webviews.md#automatically_manage_new_devices">import all new devices</a> for the connected account to make these devices available for use and management by the Seam API</td></tr><tr><td><code>wait_for_device_creation</code></td><td>Indicates whether Seam should <a href="../../core-concepts/connect-webviews/customizing-connect-webviews.md#wait_for_device_creation">finish syncing all devices</a> in a newly-connected account before completing the associated Connect Webview</td></tr><tr><td><code>authorized_at</code></td><td>Date and time at which the user authorized (through the Connect Webview) the management of their devices</td></tr><tr><td><code>selected_provider</code></td><td>Selected provider of the Connec Webview, one of <a href="list.md#device-provider-keys">device provider keys</a></td></tr></tbody></table>
66+
<table><thead><tr><th width="310">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>connect_webview_id</code></td><td>ID of the Connect Webview</td></tr><tr><td><code>connected_account_id</code></td><td>ID of the <a href="../connected_accounts/">connected account</a> that was created after the user successfully logged in</td></tr><tr><td><code>url</code></td><td>URL for the Connect Webview</td></tr><tr><td><code>workspace_id</code></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> that contains the Connect Webview</td></tr><tr><td><code>device_selection_mode</code></td><td>Device selection mode, including <code>none</code>, <code>single</code>, or <code>multiple</code></td></tr><tr><td><code>accepted_providers</code></td><td>List of accepted <a href="../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews">device provider keys</a></td></tr><tr><td><code>accepted_devices</code></td><td>List of accepted <a href="../../core-concepts/devices/">devices</a></td></tr><tr><td><code>any_provider_allowed</code></td><td>Indicates whether any provider is allowed</td></tr><tr><td><code>any_device_allowed</code></td><td>Indicates whether any device is allowed</td></tr><tr><td><code>created_at</code></td><td>Date and time at which the Connect Webview was created</td></tr><tr><td><code>login_successful</code></td><td>Indicates whether the user logged in successfully using the Connect Webview</td></tr><tr><td><code>status</code></td><td>Status of the Connect Webview, including <code>pending</code> or <code>authorized</code></td></tr><tr><td><code>custom_redirect_url</code></td><td>If set, the Connect Webview redirects to this URL when the user successfully pairs a device or, if the <code>custom_redirect_failure_url</code> is not set, when an unexpected error occurs</td></tr><tr><td><code>custom_redirect_failure_url</code></td><td>If set, the Connect Webview redirects to this URL when an unexpected error occurs</td></tr><tr><td><code>custom_metadata</code></td><td>Set of up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters<br>For more information, see <a href="../../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md">Attaching Custom Data to the Connect Webview</a>.</td></tr><tr><td><code>automatically_manage_new_devices</code></td><td>Indicates whether Seam should <a href="../../core-concepts/connect-webviews/customizing-connect-webviews.md#automatically_manage_new_devices">import all new devices</a> for the connected account to make these devices available for use and management by the Seam API</td></tr><tr><td><code>wait_for_device_creation</code></td><td>Indicates whether Seam should <a href="../../core-concepts/connect-webviews/customizing-connect-webviews.md#wait_for_device_creation">finish syncing all devices</a> in a newly-connected account before completing the associated Connect Webview</td></tr><tr><td><code>authorized_at</code></td><td>Date and time at which the user authorized (through the Connect Webview) the management of their devices</td></tr><tr><td><code>selected_provider</code></td><td>Selected provider of the Connect Webview, one of the <a href="../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews">device provider keys</a></td></tr></tbody></table>
6767

6868
### Sample Response
6969

0 commit comments

Comments
 (0)