diff --git a/docs/api-clients/connect-webviews/README.md b/docs/api-clients/connect-webviews/README.md index 8ba2eaab..f097b5f5 100644 --- a/docs/api-clients/connect-webviews/README.md +++ b/docs/api-clients/connect-webviews/README.md @@ -34,14 +34,16 @@ To enable a user to connect their device account to Seam through your app, you m | **`authorized_at`** | String | Date and time at which the user authorized (through the Connect Webview) the management of their devices | | **`workspace_id`** | String (UUID) | ID of the [workspace](../../core-concepts/workspaces/) that contains the Connect Webview | -### Accepted Provider Category Keys +### Provider Category Keys + +When you [create a Connect Webview](create-a-connect-webview.md), specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of [device provider keys](./#device-provider-keys). | key | Description | | --------------------- | ------------------------------------------------------------------ | | `stable` | Only returns provider integrations marked as stable. | | `consumer_smartlocks` | Only returns provider integrations marked as consumer smart locks. | | `thermostats` | Only returns provider integrations marked as thermostats. | -| `noise_sensors` | Only returns provider instegrations marked as noise sensors. | +| `noise_sensors` | Only returns provider integrations marked as noise sensors. | {% hint style="info" %} To list all providers within a category, use the [List Device Providers](../devices/list-device-providers.md) method with the desired `provider_category` filter. diff --git a/docs/api-clients/connect-webviews/create-a-connect-webview.md b/docs/api-clients/connect-webviews/create-a-connect-webview.md index 71b4a139..e1be4dc4 100644 --- a/docs/api-clients/connect-webviews/create-a-connect-webview.md +++ b/docs/api-clients/connect-webviews/create-a-connect-webview.md @@ -10,70 +10,21 @@ To enable a user to connect their devices or systems to Seam, they must sign in ![This example shows how a Connect Webview looks when you display it to your user.](<../../.gitbook/assets/image (12).png>) -## Create a `connect_webview` - `POST` `https://connect.getseam.com/connect_webviews/create` -#### Request Body +## Request -| Name | Type | Description | -| ------------------------------------------------------ | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `accepted_providers`\* | String\[] |

Array of accepted

device provider keys. See

Device Provider Keys.

| -| `custom_redirect_url` | String | URL to redirect user to after provider login is complete. | -| `custom_redirect_failure_url` |

String
Optional

|

Alternative URL to redirect the user on error. If this is not set, falls back to

custom_redirect_url.

| +### Request Parameters -{% tabs %} -{% tab title="201: Created connect_webview successfully created" %} -```javascript -{ - "connect_webview": { - "connect_webview_id": "123e4567-e89b-12d3-a456-426614174000", - "custom_metadata": {}, - "custom_redirect_url": null, - "custom_redirect_failure_url": null, - "url": "https://connect.getseam.com/v1/connect_webviews/view?connect_webview_id=02454094-1cab-4693-babc-afa9e1c55f09&auth_token=P7XLD4hYXva24WqwSKTC4pKQMP7v3zWUz", - "workspace_id": "84dda4b8-f327-4d97-a720-e0504a13a441", - "device_selection_mode": "none", - "accepted_providers": [ - "smartthings" - ], - "accepted_devices": [], - "any_provider_allowed": false, - "any_device_allowed": null, - "created_at": "2022-02-07T18:33:50.271Z", - "login_successful": false, - "status": "pending" - } -} -``` -{% endtab %} +| Parameter | Type | Description | +| ---------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `provider_category` | String |

Specifies the category of providers to include.
Supported categories:

See Provider Category Keys.

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

String
Optional

| URL to redirect user to after provider login is complete | +| `custom_redirect_failure_url` |

String

Optional

| Alternative URL to redirect the user on error. If this is not set, falls back to `custom_redirect_url` | +| `automatically_manage_new_devices` | Boolean |

Indicates whether newly added devices should appear as managed devices
Default: true

| -{% tab title="400: Bad Request " %} -```javascript -{ - "error": { - "type": "invalid_input", - "message": "Invalid enum value. Expected 'akuvox' | 'august' | 'schlage' | 'smartthings' | 'yale' | 'noiseaware' | 'salto' | 'doorking' | 'salto' | 'genie' | 'linear' | 'seam_relay_admin' for provided \"accepted_providers.0\"", - "validation_errors": { - "_errors": [], - "accepted_providers": { - "0": { - "_errors": [ - "Invalid enum value. Expected 'akuvox' | 'august' | 'schlage' | 'smartthings' | 'yale' | 'noiseaware' | 'salto' | 'doorking' | 'salto' | 'genie' | 'linear' | 'seam_relay_admin'" - ] - }, - "_errors": [] - } - }, - "request_id": "23bc6c4b-286f-4485-9531-a8f3300370cd" - }, - "ok": false -} -``` -{% endtab %} -{% endtabs %} - -### Code Example +### Sample Request {% tabs %} {% tab title="JavaScript" %} @@ -258,21 +209,11 @@ You should make a new`connect_webview`for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users. {% endhint %} -### Parameters - -| `provider_category` | type: string |

Specifies the category of providers to include.
Supported categories:

See Accepted Provider Category Keys.

| -| ---------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accepted_providers` | type: string\[] | Array of accepted **device provider keys** and an alternative to `provider_category`. This lets you explicitly specified accepted providers (e.g. "august"). See [Device Provider Keys](./#device-provider-keys). | -| `custom_redirect_url` |

type: string
Optional

| URL to redirect user to after provider login is complete | -| `custom_redirect_failure_url` |

type: string

Optional

| Alternative URL to redirect the user on error. If this is not set, falls back to `custom_redirect_url` | -| `device_selection_mode` | type: 'none' | 'multiple' | -| `automatically_manage_new_devices` | type: 'boolean' |

Indicates whether newly added devices should appear as managed devices
Default: true

| - -### Response +## Response This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. -#### JSON format +### Sample Response {% tabs %} {% tab title="JSON" %} diff --git a/docs/api-clients/devices/README.md b/docs/api-clients/devices/README.md index 05c083f9..e78f7805 100644 --- a/docs/api-clients/devices/README.md +++ b/docs/api-clients/devices/README.md @@ -116,18 +116,24 @@ On some account types, Seam provides additional information about the manufactur Seam maintains a list of device providers that you can access using the [List Device Providers](list-device-providers.md) endpoint. -The [Device Provider](./#device-provider) object includes the following information: +The `device_provider` object includes the following information: -
PropertyTypeDescription
device_provider_nameString

Name of the device provider.

For example: august

display_nameString

Formatted version of the device_provider_name.

For example: August

image_urlStringImage URL for the provider logo.
provider_categoriesArray

Array of associated categories for the provider.

Supported categories:

  • stable
  • consumer_smartlocks
  • thermostats
  • noise_sensors
+
PropertyTypeDescription
device_provider_nameString

Name of the device provider.

For example: august

display_nameString

Formatted version of the device_provider_name.

For example: August

image_urlStringImage URL for the provider logo.
provider_categoriesArray

Array of associated categories for the provider.

Supported categories:

  • stable
  • consumer_smartlocks
  • thermostats
  • noise_sensors
can_remotely_unlockBooleanIndicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.
can_remotely_lockBooleanIndicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesBooleanIndicates whether at least one supported device from the provider can program online access codes. See Capability Flags.
can_program_offline_access_codesBooleanIndicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.
-The following example shows a device provider object: +The following example shows a `device_provider` object: -```javascript +```json { - "device_provider_name": "august", - "display_name": "August", - "image_url": "https://connect.getseam.com/assets/images/logos/august_logo_square.png", - "provider_categories": ["stable"] + "device_provider_name": "august", + "display_name": "August", + "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/august_logo_square.png&q=75&w=128", + "provider_categories": [ + "stable", + "consumer_smartlocks" + ], + "can_remotely_lock": true, + "can_remotely_unlock": true, + "can_program_online_access_codes": true } ``` diff --git a/docs/api-clients/devices/list-device-providers.md b/docs/api-clients/devices/list-device-providers.md index ed09ae7a..299fbd2f 100644 --- a/docs/api-clients/devices/list-device-providers.md +++ b/docs/api-clients/devices/list-device-providers.md @@ -23,7 +23,9 @@ To filter the list of returned device providers by a specific device provider ca {% tabs %} {% tab title="Python" %} ```python -pprint(seam.devices.list_device_providers(provider_category="stable")) +seam.devices.list_device_providers( + provider_category="stable" +) ``` {% endtab %} @@ -33,7 +35,7 @@ pprint(seam.devices.list_device_providers(provider_category="stable")) curl -X 'GET' \ 'https://connect.getseam.com/devices/list_device_providers' \ -H 'accept: application/json' \ - -H 'Authorization: Bearer ${API_KEY}' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "provider_category": "stable" @@ -43,138 +45,64 @@ curl -X 'GET' \ {% tab title="JavaScript" %} ```javascript -console.log(await seam.devices.listDeviceProviders({provider_category: "stable"})) +await seam.devices.listDeviceProviders({ + provider_category: "stable" +}) ``` {% endtab %} {% tab title="Ruby" %} ```ruby -puts client.devices.list_device_providers(provider_category: "stable").inspect +client.devices.list_device_providers( + provider_category: "stable" +) ``` {% endtab %} {% tab title="C#" %} ```csharp -var deviceProviders = seam.Devices.ListDeviceProviders(providerCategory: Seam.Api.Devices.ListDeviceProvidersRequest.ProviderCategoryEnum.Stable); -foreach (var deviceProvider in deviceProviders) -{ - Console.WriteLine(deviceProvider); -} +seam.Devices.ListDeviceProviders( + providerCategory: Seam.Api.Devices.ListDeviceProvidersRequest.ProviderCategoryEnum.Stable +); ``` {% endtab %} {% tab title="Java" %} ```java -var deviceProviders = seam.devices() - .listDeviceProviders(DevicesListDeviceProvidersRequest.builder() - .providerCategory(DevicesListDeviceProvidersRequestProviderCategory.STABLE) - .build()); -System.out.println(deviceProviders); +seam.devices().listDeviceProviders(DevicesListDeviceProvidersRequest.builder() + .providerCategory(DevicesListDeviceProvidersRequestProviderCategory.STABLE) + .build() +); ``` {% endtab %} {% endtabs %} ## Response -Returns an `device_providers` array, in which each returned device provider (`device_provider`) contains the following properties: +Returns an `device_providers` array, in which each returned `device_provider` contains the following properties: -
PropertyDescription
device_provider_nameName of the device provider.
display_nameDisplay name that corresponds to the device provider type.
image_urlImage URL for the device provider.
provider_categoriesList of provider categories for the device provider.
- -This response also includes a Boolean `ok` status indicator. +
PropertyDescription
device_provider_nameName of the device provider.
display_nameDisplay name that corresponds to the device provider type.
image_urlImage URL for the device provider.
provider_categoriesList of provider categories for the device provider.
can_remotely_unlockIndicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.
can_remotely_lockIndicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesIndicates whether at least one supported device from the provider can program online access codes. See Capability Flags.
can_program_offline_access_codesIndicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.
### Sample Response {% tabs %} {% tab title="Python" %} ``` -[{'device_provider_name': 'august', - 'display_name': 'August', - 'image_url': 'https://connect.getseam.com/assets/images/logos/august_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'avigilon_alta', - 'display_name': 'Avigilon Alta', - 'image_url': 'https://connect.getseam.com/assets/images/logos/avigilon_alta_logo_openpath_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'brivo', - 'display_name': 'Brivo', - 'image_url': 'https://connect.getseam.com/assets/images/logos/brivo_logo_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'controlbyweb', - 'display_name': 'ControlByWeb', - 'image_url': 'https://connect.getseam.com/assets/images/logos/controlbyweb_logo_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'dormakaba_oracode', - 'display_name': 'Dormakaba Oracode', - 'image_url': 'https://connect.getseam.com/assets/images/logos/dormakaba_logo_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'ecobee', - 'display_name': 'Ecobee', - 'image_url': 'https://connect.getseam.com/assets/images/logos/ecobee_logo_square.png', - 'provider_categories': ['stable', 'thermostats']}, - {'device_provider_name': 'four_suites', - 'display_name': '4SUITES', - 'image_url': 'https://connect.getseam.com/assets/images/logos/four_suites_logo_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'igloohome', - 'display_name': 'Igloo Home', - 'image_url': 'https://connect.getseam.com/assets/images/logos/igloohome_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'kwikset', - 'display_name': 'Kwikset', - 'image_url': 'https://connect.getseam.com/assets/images/logos/kwikset_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'lockly', - 'display_name': 'Lockly', - 'image_url': 'https://connect.getseam.com/assets/images/logos/lockly_logo_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'minut', - 'display_name': 'Minut', - 'image_url': 'https://connect.getseam.com/assets/images/logos/minut_logo_wordmark.png', - 'provider_categories': ['stable', 'noise_sensors']}, - {'device_provider_name': 'my_2n', - 'display_name': 'My2N', - 'image_url': 'https://connect.getseam.com/assets/images/logos/2n_logo_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'nest', - 'display_name': 'Google Nest Thermostats', - 'image_url': 'https://connect.getseam.com/assets/images/logos/nest_logo_square.png', - 'provider_categories': ['stable', 'thermostats']}, - {'device_provider_name': 'noiseaware', - 'display_name': 'Noiseaware', - 'image_url': 'https://connect.getseam.com/assets/images/logos/noiseaware_logo_square.png', - 'provider_categories': ['stable', 'noise_sensors']}, - {'device_provider_name': 'nuki', - 'display_name': 'Nuki', - 'image_url': 'https://connect.getseam.com/assets/images/logos/nuki_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'salto', - 'display_name': 'Salto', - 'image_url': 'https://connect.getseam.com/assets/images/logos/salto_logo_square.png', - 'provider_categories': ['stable']}, - {'device_provider_name': 'schlage', - 'display_name': 'Schlage', - 'image_url': 'https://connect.getseam.com/assets/images/logos/schlage_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'smartthings', - 'display_name': 'SmartThings', - 'image_url': 'https://connect.getseam.com/assets/images/logos/smartthings_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'tedee', - 'display_name': 'Tedee', - 'image_url': 'https://connect.getseam.com/assets/images/logos/tedee.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'ttlock', - 'display_name': 'TTLock', - 'image_url': 'https://connect.getseam.com/assets/images/logos/ttlock_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'wyze', - 'display_name': 'Wyze', - 'image_url': 'https://connect.getseam.com/assets/images/logos/wyze_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}, - {'device_provider_name': 'yale', - 'display_name': 'Yale', - 'image_url': 'https://connect.getseam.com/assets/images/logos/yale_logo_square.png', - 'provider_categories': ['stable', 'consumer_smartlocks']}] +[ + DeviceProvider( + device_provider_name='august', + display_name='August', + image_url=/https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/august_logo_square.png&q=75&w=128', + provider_categories=[ + 'stable', + 'consumer_smartlocks' + ], + can_remotely_lock=True, + can_remotely_unlock=True, + can_program_online_access_codes=True + ), + ... +] ``` {% endtab %} @@ -185,193 +113,16 @@ This response also includes a Boolean `ok` status indicator. { "device_provider_name": "august", "display_name": "August", - "image_url": "https://connect.getseam.com/assets/images/logos/august_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "avigilon_alta", - "display_name": "Avigilon Alta", - "image_url": "https://connect.getseam.com/assets/images/logos/avigilon_alta_logo_openpath_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "brivo", - "display_name": "Brivo", - "image_url": "https://connect.getseam.com/assets/images/logos/brivo_logo_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "controlbyweb", - "display_name": "ControlByWeb", - "image_url": "https://connect.getseam.com/assets/images/logos/controlbyweb_logo_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "dormakaba_oracode", - "display_name": "Dormakaba Oracode", - "image_url": "https://connect.getseam.com/assets/images/logos/dormakaba_logo_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "ecobee", - "display_name": "Ecobee", - "image_url": "https://connect.getseam.com/assets/images/logos/ecobee_logo_square.png", - "provider_categories": [ - "stable", - "thermostats" - ] - }, - { - "device_provider_name": "four_suites", - "display_name": "4SUITES", - "image_url": "https://connect.getseam.com/assets/images/logos/four_suites_logo_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "igloohome", - "display_name": "Igloo Home", - "image_url": "https://connect.getseam.com/assets/images/logos/igloohome_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "kwikset", - "display_name": "Kwikset", - "image_url": "https://connect.getseam.com/assets/images/logos/kwikset_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "lockly", - "display_name": "Lockly", - "image_url": "https://connect.getseam.com/assets/images/logos/lockly_logo_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "minut", - "display_name": "Minut", - "image_url": "https://connect.getseam.com/assets/images/logos/minut_logo_wordmark.png", - "provider_categories": [ - "stable", - "noise_sensors" - ] - }, - { - "device_provider_name": "my_2n", - "display_name": "My2N", - "image_url": "https://connect.getseam.com/assets/images/logos/2n_logo_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "nest", - "display_name": "Google Nest Thermostats", - "image_url": "https://connect.getseam.com/assets/images/logos/nest_logo_square.png", - "provider_categories": [ - "stable", - "thermostats" - ] - }, - { - "device_provider_name": "noiseaware", - "display_name": "Noiseaware", - "image_url": "https://connect.getseam.com/assets/images/logos/noiseaware_logo_square.png", - "provider_categories": [ - "stable", - "noise_sensors" - ] - }, - { - "device_provider_name": "nuki", - "display_name": "Nuki", - "image_url": "https://connect.getseam.com/assets/images/logos/nuki_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "salto", - "display_name": "Salto", - "image_url": "https://connect.getseam.com/assets/images/logos/salto_logo_square.png", - "provider_categories": [ - "stable" - ] - }, - { - "device_provider_name": "schlage", - "display_name": "Schlage", - "image_url": "https://connect.getseam.com/assets/images/logos/schlage_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "smartthings", - "display_name": "SmartThings", - "image_url": "https://connect.getseam.com/assets/images/logos/smartthings_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "tedee", - "display_name": "Tedee", - "image_url": "https://connect.getseam.com/assets/images/logos/tedee.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "ttlock", - "display_name": "TTLock", - "image_url": "https://connect.getseam.com/assets/images/logos/ttlock_logo_square.png", + "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/august_logo_square.png&q=75&w=128", "provider_categories": [ "stable", "consumer_smartlocks" - ] + ], + "can_remotely_lock": true, + "can_remotely_unlock": true, + "can_program_online_access_codes": true }, - { - "device_provider_name": "wyze", - "display_name": "Wyze", - "image_url": "https://connect.getseam.com/assets/images/logos/wyze_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - }, - { - "device_provider_name": "yale", - "display_name": "Yale", - "image_url": "https://connect.getseam.com/assets/images/logos/yale_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] - } + ... ], "ok": true } @@ -384,230 +135,37 @@ This response also includes a Boolean `ok` status indicator. { device_provider_name: 'august', display_name: 'August', - image_url: 'https://connect.getseam.com/assets/images/logos/august_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'avigilon_alta', - display_name: 'Avigilon Alta', - image_url: 'https://connect.getseam.com/assets/images/logos/avigilon_alta_logo_openpath_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'brivo', - display_name: 'Brivo', - image_url: 'https://connect.getseam.com/assets/images/logos/brivo_logo_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'controlbyweb', - display_name: 'ControlByWeb', - image_url: 'https://connect.getseam.com/assets/images/logos/controlbyweb_logo_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'dormakaba_oracode', - display_name: 'Dormakaba Oracode', - image_url: 'https://connect.getseam.com/assets/images/logos/dormakaba_logo_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'ecobee', - display_name: 'Ecobee', - image_url: 'https://connect.getseam.com/assets/images/logos/ecobee_logo_square.png', - provider_categories: [ 'stable', 'thermostats' ] - }, - { - device_provider_name: 'four_suites', - display_name: '4SUITES', - image_url: 'https://connect.getseam.com/assets/images/logos/four_suites_logo_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'igloohome', - display_name: 'Igloo Home', - image_url: 'https://connect.getseam.com/assets/images/logos/igloohome_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'kwikset', - display_name: 'Kwikset', - image_url: 'https://connect.getseam.com/assets/images/logos/kwikset_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'lockly', - display_name: 'Lockly', - image_url: 'https://connect.getseam.com/assets/images/logos/lockly_logo_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'minut', - display_name: 'Minut', - image_url: 'https://connect.getseam.com/assets/images/logos/minut_logo_wordmark.png', - provider_categories: [ 'stable', 'noise_sensors' ] - }, - { - device_provider_name: 'my_2n', - display_name: 'My2N', - image_url: 'https://connect.getseam.com/assets/images/logos/2n_logo_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'nest', - display_name: 'Google Nest Thermostats', - image_url: 'https://connect.getseam.com/assets/images/logos/nest_logo_square.png', - provider_categories: [ 'stable', 'thermostats' ] - }, - { - device_provider_name: 'noiseaware', - display_name: 'Noiseaware', - image_url: 'https://connect.getseam.com/assets/images/logos/noiseaware_logo_square.png', - provider_categories: [ 'stable', 'noise_sensors' ] - }, - { - device_provider_name: 'nuki', - display_name: 'Nuki', - image_url: 'https://connect.getseam.com/assets/images/logos/nuki_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'salto', - display_name: 'Salto', - image_url: 'https://connect.getseam.com/assets/images/logos/salto_logo_square.png', - provider_categories: [ 'stable' ] - }, - { - device_provider_name: 'schlage', - display_name: 'Schlage', - image_url: 'https://connect.getseam.com/assets/images/logos/schlage_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'smartthings', - display_name: 'SmartThings', - image_url: 'https://connect.getseam.com/assets/images/logos/smartthings_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'tedee', - display_name: 'Tedee', - image_url: 'https://connect.getseam.com/assets/images/logos/tedee.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'ttlock', - display_name: 'TTLock', - image_url: 'https://connect.getseam.com/assets/images/logos/ttlock_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'wyze', - display_name: 'Wyze', - image_url: 'https://connect.getseam.com/assets/images/logos/wyze_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - }, - { - device_provider_name: 'yale', - display_name: 'Yale', - image_url: 'https://connect.getseam.com/assets/images/logos/yale_logo_square.png', - provider_categories: [ 'stable', 'consumer_smartlocks' ] - } + image_url: 'https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/august_logo_square.png&q=75&w=128', + provider_categories: [ + 'stable', + 'consumer_smartlocks' + ], + 'can_remotely_lock': true, + 'can_remotely_unlock': true, + 'can_program_online_access_codes': true + }, + ... ] ``` {% endtab %} {% tab title="Ruby" %} ``` -[, , , , , , , , , , , , , , , , , , , , , ] +[ + , + ... +] ``` {% endtab %} @@ -616,308 +174,36 @@ This response also includes a Boolean `ok` status indicator. { "device_provider_name": "august", "display_name": "August", - "image_url": "https://connect.getseam.com/assets/images/logos/august_logo_square.png", + "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/august_logo_square.png&q=75&w=128", "provider_categories": [ "stable", "consumer_smartlocks" - ] -} -{ - "device_provider_name": "avigilon_alta", - "display_name": "Avigilon Alta", - "image_url": "https://connect.getseam.com/assets/images/logos/avigilon_alta_logo_openpath_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "brivo", - "display_name": "Brivo", - "image_url": "https://connect.getseam.com/assets/images/logos/brivo_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "controlbyweb", - "display_name": "ControlByWeb", - "image_url": "https://connect.getseam.com/assets/images/logos/controlbyweb_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "dormakaba_oracode", - "display_name": "Dormakaba Oracode", - "image_url": "https://connect.getseam.com/assets/images/logos/dormakaba_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "ecobee", - "display_name": "Ecobee", - "image_url": "https://connect.getseam.com/assets/images/logos/ecobee_logo_square.png", - "provider_categories": [ - "stable", - "thermostats" - ] -} -{ - "device_provider_name": "four_suites", - "display_name": "4SUITES", - "image_url": "https://connect.getseam.com/assets/images/logos/four_suites_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "igloohome", - "display_name": "Igloo Home", - "image_url": "https://connect.getseam.com/assets/images/logos/igloohome_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] -} -{ - "device_provider_name": "kwikset", - "display_name": "Kwikset", - "image_url": "https://connect.getseam.com/assets/images/logos/kwikset_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] -} -{ - "device_provider_name": "lockly", - "display_name": "Lockly", - "image_url": "https://connect.getseam.com/assets/images/logos/lockly_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "minut", - "display_name": "Minut", - "image_url": "https://connect.getseam.com/assets/images/logos/minut_logo_wordmark.png", - "provider_categories": [ - "stable", - "noise_sensors" - ] -} -{ - "device_provider_name": "my_2n", - "display_name": "My2N", - "image_url": "https://connect.getseam.com/assets/images/logos/2n_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "nest", - "display_name": "Google Nest Thermostats", - "image_url": "https://connect.getseam.com/assets/images/logos/nest_logo_square.png", - "provider_categories": [ - "stable", - "thermostats" - ] -}, -{ - "device_provider_name": "noiseaware", - "display_name": "Noiseaware", - "image_url": "https://connect.getseam.com/assets/images/logos/noiseaware_logo_square.png", - "provider_categories": [ - "stable", - "noise_sensors" - ] -} -{ - "device_provider_name": "nuki", - "display_name": "Nuki", - "image_url": "https://connect.getseam.com/assets/images/logos/nuki_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] -} -{ - "device_provider_name": "salto", - "display_name": "Salto", - "image_url": "https://connect.getseam.com/assets/images/logos/salto_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "schlage", - "display_name": "Schlage", - "image_url": "https://connect.getseam.com/assets/images/logos/schlage_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] -} -{ - "device_provider_name": "smartthings", - "display_name": "SmartThings", - "image_url": "https://connect.getseam.com/assets/images/logos/smartthings_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] -} -{ - "device_provider_name": "tedee", - "display_name": "Tedee", - "image_url": "https://connect.getseam.com/assets/images/logos/tedee.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] -} -{ - "device_provider_name": "ttlock", - "display_name": "TTLock", - "image_url": "https://connect.getseam.com/assets/images/logos/ttlock_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] -} -{ - "device_provider_name": "wyze", - "display_name": "Wyze", - "image_url": "https://connect.getseam.com/assets/images/logos/wyze_logo_square.png", - "provider_categories": [ - "stable" - ] -} -{ - "device_provider_name": "yale", - "display_name": "Yale", - "image_url": "https://connect.getseam.com/assets/images/logos/yale_logo_square.png", - "provider_categories": [ - "stable", - "consumer_smartlocks" - ] + ], + "can_remotely_lock": true, + "can_remotely_unlock": true, + "can_program_online_access_codes": true } +... ``` {% endtab %} {% tab title="Java" %} ```json -[{ - "device_provider_name" : "august", - "display_name" : "August", - "image_url" : "https://connect.getseam.com/assets/images/logos/august_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "avigilon_alta", - "display_name" : "Avigilon Alta", - "image_url" : "https://connect.getseam.com/assets/images/logos/avigilon_alta_logo_openpath_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "brivo", - "display_name" : "Brivo", - "image_url" : "https://connect.getseam.com/assets/images/logos/brivo_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "controlbyweb", - "display_name" : "ControlByWeb", - "image_url" : "https://connect.getseam.com/assets/images/logos/controlbyweb_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "dormakaba_oracode", - "display_name" : "Dormakaba Oracode", - "image_url" : "https://connect.getseam.com/assets/images/logos/dormakaba_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "ecobee", - "display_name" : "Ecobee", - "image_url" : "https://connect.getseam.com/assets/images/logos/ecobee_logo_square.png", - "provider_categories" : [ "stable", "thermostats" ] -}, { - "device_provider_name" : "four_suites", - "display_name" : "4SUITES", - "image_url" : "https://connect.getseam.com/assets/images/logos/four_suites_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "igloohome", - "display_name" : "Igloo Home", - "image_url" : "https://connect.getseam.com/assets/images/logos/igloohome_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "kwikset", - "display_name" : "Kwikset", - "image_url" : "https://connect.getseam.com/assets/images/logos/kwikset_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "lockly", - "display_name" : "Lockly", - "image_url" : "https://connect.getseam.com/assets/images/logos/lockly_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "minut", - "display_name" : "Minut", - "image_url" : "https://connect.getseam.com/assets/images/logos/minut_logo_wordmark.png", - "provider_categories" : [ "stable", "noise_sensors" ] -}, { - "device_provider_name" : "my_2n", - "display_name" : "My2N", - "image_url" : "https://connect.getseam.com/assets/images/logos/2n_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name": "nest", - "display_name": "Google Nest Thermostats", - "image_url": "https://connect.getseam.com/assets/images/logos/nest_logo_square.png", - "provider_categories": [ "stable", "thermostats" ] -}, { - "device_provider_name" : "noiseaware", - "display_name" : "Noiseaware", - "image_url" : "https://connect.getseam.com/assets/images/logos/noiseaware_logo_square.png", - "provider_categories" : [ "stable", "noise_sensors" ] -}, { - "device_provider_name" : "nuki", - "display_name" : "Nuki", - "image_url" : "https://connect.getseam.com/assets/images/logos/nuki_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "salto", - "display_name" : "Salto", - "image_url" : "https://connect.getseam.com/assets/images/logos/salto_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "schlage", - "display_name" : "Schlage", - "image_url" : "https://connect.getseam.com/assets/images/logos/schlage_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "smartthings", - "display_name" : "SmartThings", - "image_url" : "https://connect.getseam.com/assets/images/logos/smartthings_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "tedee", - "display_name" : "Tedee", - "image_url" : "https://connect.getseam.com/assets/images/logos/tedee.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "ttlock", - "display_name" : "TTLock", - "image_url" : "https://connect.getseam.com/assets/images/logos/ttlock_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}, { - "device_provider_name" : "wyze", - "display_name" : "Wyze", - "image_url" : "https://connect.getseam.com/assets/images/logos/wyze_logo_square.png", - "provider_categories" : [ "stable" ] -}, { - "device_provider_name" : "yale", - "display_name" : "Yale", - "image_url" : "https://connect.getseam.com/assets/images/logos/yale_logo_square.png", - "provider_categories" : [ "stable", "consumer_smartlocks" ] -}] +[ + { + "device_provider_name": "august", + "display_name": "August", + "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/august_logo_square.png&q=75&w=128", + "provider_categories": [ + "stable", + "consumer_smartlocks" + ], + "can_remotely_lock": true, + "can_remotely_unlock": true, + "can_program_online_access_codes": true + }, + ... +] ``` {% endtab %} {% endtabs %} diff --git a/docs/capability-guides/device-and-system-capabilities.md b/docs/capability-guides/device-and-system-capabilities.md index 7b4d8fb1..559873d7 100644 --- a/docs/capability-guides/device-and-system-capabilities.md +++ b/docs/capability-guides/device-and-system-capabilities.md @@ -24,9 +24,11 @@ Reasons why a capability flag might be `false` could include that the device is Seam recommends adding capability checks before performing specific actions in your app. For example, before performing a [remote unlock](../products/smart-locks/lock-and-unlock.md#unlocking-a-door) operation, you can check to make sure that the target device supports remote unlocking. For details and code samples, see the corresponding [capability guides](broken-reference). -
PropertyTypeDescription
device.can_remotely_unlockBoolean
Optional		Indicates whether the device can perform a remote unlock operation.
device.can_remotely_lockBoolean
Optional		Indicates whether the device can perform a remote lock operation.
device.can_program_online_access_codesBoolean
Optional		Indicates whether the device can program online access codes.
If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online.
device.can_program_offline_access_codesBoolean
Optional		Indicates whether the device can program offline access codes.
When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device.
- +{% hint style="info" %} +In addition to viewing the capabilities for a specific device, you can also view the capabilities for a provider using [List Device Providers](../api-clients/devices/list-device-providers.md). If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. +{% endhint %} +
PropertyTypeDescription
device.can_remotely_unlockBoolean
Optional		Indicates whether the device can perform a remote unlock operation.
device.can_remotely_lockBoolean
Optional		Indicates whether the device can perform a remote lock operation.
device.can_program_online_access_codesBoolean
Optional		Indicates whether the device can program online access codes.
If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online.
device.can_program_offline_access_codesBoolean
Optional		Indicates whether the device can program offline access codes.
When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device.
{% hint style="info" %} Seam is actively developing additional capability flags to provide you with even more robust capability checking abilities for your app. If you would like us to add a specific capability flag, contact [support@seam.co](mailto:support@seam.co). diff --git a/docs/core-concepts/connect-webviews/customizing-connect-webviews.md b/docs/core-concepts/connect-webviews/customizing-connect-webviews.md index 805d5560..b17aeda6 100644 --- a/docs/core-concepts/connect-webviews/customizing-connect-webviews.md +++ b/docs/core-concepts/connect-webviews/customizing-connect-webviews.md @@ -39,14 +39,12 @@ It is important to note that any changes you make to the customization features ## Customize the Brands to Display in Your Connect Webviews -You can customize the brands that a Connect Webview should display. You specify the brands to display when you are creating the Connect Webview. Consequently, you can customize this list of brands to display for each of your Connect Webviews. +When you create a Connect Webview, you can customize the providers—that is, the brands—that it displays. In the [Create Connect Webview](../../api-clients/connect-webviews/create-a-connect-webview.md) request, include the desired set of [device provider keys](../../api-clients/connect-webviews/#device-provider-keys) in the `accepted_providers` parameter. -To display a subset of providers in your Connect Webview, include the desired `accepted_providers` in the [Create Connect Webview](../../api-clients/connect-webviews/create-a-connect-webview.md) command. In this parameter, specify a list of accepted providers (brands) to display. - -For a complete list of available providers, see [Device Provider Keys](../../api-clients/connect-webviews/#device-provider-keys). +To help you decide which providers to include in a Connect Webview, you can use the [List Device Providers](../../api-clients/devices/list-device-providers.md) method to learn about each provider. The information that this method returns for each [provider](../../api-clients/devices/#device-providers) includes a set of [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. For more information, see [Device Providers](../../api-clients/devices/#device-providers). {% hint style="info" %} -If you omit this parameter, the Connect Webview displays all of the stable providers that Seam supports, by default. For more information, see [Accepted Provider Category Keys](../../api-clients/connect-webviews/#accepted-provider-category-keys). +If you omit the `accepted_providers` parameter, the Connect Webview displays all of the stable providers that Seam supports, by default. For more information about provider categories, see [Provider Category Keys](../../api-clients/connect-webviews/#provider-category-keys). {% endhint %} For example, the following Connect Webview creation request specifies that the Connect Webview should only display August and Schlage: @@ -56,24 +54,24 @@ For example, the following Connect Webview creation request specifies that the C **Request:** ```python -created_connect_webview = seam.connect_webviews.create( +seam.connect_webviews.create( accepted_providers = ["august", "schlage"] ) - -pprint(created_connect_webview) ``` **Response:** ``` -ConnectWebview(workspace_id='398d80b7-3f96-47c2-b85a-6f8ba21d07be', - connect_webview_id='1139e5a5-4bfd-4c78-9a89-83a439ad538e', - status='pending', - url='https://connect.getseam.com/connect_webviews/view?connect_webview_id=1139e5a5-4bfd-4c78-9a89-83a439ad538e&auth_token=5g6Nt1sunJamS1huj7pwztKaMaBpvKhLc', - ... - accepted_providers=['august', 'schlage'], - ... - ) +ConnectWebview( + connect_webview_id='1139e5a5-4bfd-4c78-9a89-83a439ad538e', + status='pending', + url='https://connect.getseam.com/connect_webviews/view?connect_webview_id=1139e5a5-4bfd-4c78-9a89-83a439ad538e&auth_token=5g6Nt1sunJamS1huj7pwztKaMaBpvKhLc', + accepted_providers=[ + 'august', + 'schlage' + ], + ... + ) ``` {% endtab %} @@ -88,7 +86,8 @@ curl -X 'POST' \ -H 'Content-Type: application/json' \ -d '{ "accepted_providers": [ - "august", "schlage" + "august", + "schlage" ] }' ``` @@ -98,9 +97,9 @@ curl -X 'POST' \ ```json { "connect_webview": { - "url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=f5fa50b8-b7e3-45ed-b636-354c17df5d8a&auth_token=6w2tZqeYN4xEYcMf8ySsGgpwFAQgET6Lb", + "connect_webview_id": "1139e5a5-4bfd-4c78-9a89-83a439ad538e", "status": "pending", - ... + "url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=f5fa50b8-b7e3-45ed-b636-354c17df5d8a&auth_token=6w2tZqeYN4xEYcMf8ySsGgpwFAQgET6Lb", "accepted_providers": [ "august", "schlage" @@ -116,22 +115,22 @@ curl -X 'POST' \ **Request:** ```javascript -const createdConnectWebview = await seam.connectWebviews.create({ +await seam.connectWebviews.create({ accepted_providers: ["august", "schlage"] }) - -console.log(createdConnectWebview) ``` **Response:** ```json { - url: 'https://connect.getseam.com/connect_webviews/view?connect_webview_id=8cf491d8-cf67-4ad0-907d-3a8ae3764019&auth_token=C4vLHdKqpMavg6HYBbejQkE1dZ8KDcetS', + connect_webview_id: '1139e5a5-4bfd-4c78-9a89-83a439ad538e', status: 'pending', - workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be', - ... - accepted_providers: [ 'august', 'schlage' ], + url: 'https://connect.getseam.com/connect_webviews/view?connect_webview_id=8cf491d8-cf67-4ad0-907d-3a8ae3764019&auth_token=C4vLHdKqpMavg6HYBbejQkE1dZ8KDcetS', + accepted_providers: [ + 'august', + 'schlage' + ], ... } ``` @@ -141,24 +140,24 @@ console.log(createdConnectWebview) **Request:** ```ruby -created_connect_webview = client.connect_webviews.create( +client.connect_webviews.create( accepted_providers: ["august", "schlage"] ) - -puts created_connect_webview.inspect ``` **Response:** ``` +> ``` {% endtab %} @@ -171,20 +170,18 @@ List acceptedProvi Seam.Api.ConnectWebviews.CreateRequest.AcceptedProvidersEnum.Schlage }; -var createdConnectWebview = seam.ConnectWebviews.Create( +seam.ConnectWebviews.Create( acceptedProviders: acceptedProviders ); - -Console.WriteLine(createdConnectWebview); ``` **Response:** -``` +```json { "connect_webview_id": "f69fa3b8-c89d-4fd4-b6fc-feb456d07234", + "status": "pending", "url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=f69fa3b8-c89d-4fd4-b6fc-feb456d07234&auth_token=MCh7Vm2fnvyiPhtjB8Lemqr93aeHXhJhM", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "accepted_providers": [ "august", "schlage" @@ -198,12 +195,11 @@ Console.WriteLine(createdConnectWebview); **Request:** ```java -ConnectWebview createdConnectWebview = seam.connectWebviews().create(ConnectWebviewsCreateRequest.builder() - .acceptedProviders(List.of( - AcceptedProvider.AUGUST, - AcceptedProvider.SCHLAGE)) - .build()); -System.out.println(createdConnectWebview); +seam.connectWebviews().create(ConnectWebviewsCreateRequest.builder() + .acceptedProviders(List.of( + AcceptedProvider.AUGUST, + AcceptedProvider.SCHLAGE)) + .build()); ``` **Response:** @@ -211,10 +207,12 @@ System.out.println(createdConnectWebview); ```json { "connect_webview_id" : "172c1d65-8904-4d43-9eee-099780ba6558", + "status": "pending", "url" : "https://connect.getseam.com/connect_webviews/view?connect_webview_id=172c1d65-8904-4d43-9eee-099780ba6558&auth_token=7hpz4wGsaphJmBcs2TKr4H3ZkGgmqpPma", - "workspace_id" : "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - ... - "accepted_providers" : [ "august", "schlage" ], + "accepted_providers" : [ + "august", + "schlage" + ], ... } ```