diff --git a/docs/api/_report.md b/docs/api/_report.md index 327adc94..077fc270 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -10,7 +10,6 @@ - `/action_attempts` - `/bridges` - `/client_sessions` -- `/connect_webviews` - `/connected_accounts` - `/devices` - `/devices/simulate` diff --git a/docs/api/connect_webviews/README.md b/docs/api/connect_webviews/README.md new file mode 100644 index 00000000..f99230ab --- /dev/null +++ b/docs/api/connect_webviews/README.md @@ -0,0 +1,237 @@ +# Connect Webviews + +## `connect_webview` + +### `accepted_devices` + +{% hint style="warning" %} +**Deprecated**. Unused. Will be removed. +{% endhint %} + +Format: `List` + +Item format: `String` + +--- + +### `accepted_providers` + +Format: `List` + +Item format: `String` + +--- + +### `any_device_allowed` + +{% hint style="warning" %} +**Deprecated**. Unused. Will be removed. +{% endhint %} + +Format: `Boolean` + +--- + +### `any_provider_allowed` + +Format: `Boolean` + +--- + +### `authorized_at` + +Format: `Datetime` + +--- + +### `automatically_manage_new_devices` + +Format: `Boolean` + +--- + +### `connect_webview_id` + +Format: `UUID` + +--- + +### `connected_account_id` + +Format: `UUID` + +--- + +### `created_at` + +Format: `Datetime` + +--- + +### `custom_metadata` + +Format: `Record` + +--- + +### `custom_redirect_failure_url` + +Format: `String` + +--- + +### `custom_redirect_url` + +Format: `String` + +--- + +### `device_selection_mode` + +Format: `Enum` + +Possible enum values: +- `none` +- `single` +- `multiple` + +--- + +### `login_successful` + +Format: `Boolean` + +--- + +### `selected_provider` + +Format: `String` + +--- + +### `status` + +Format: `Enum` + +Possible enum values: +- `pending` +- `failed` +- `authorized` + +--- + +### `url` + +Format: `String` + +--- + +### `wait_for_device_creation` + +Format: `Boolean` + +--- + +### `workspace_id` + +Format: `UUID` + +--- + +## Endpoints + + +--- + +## Events + +### `connect_webview.login_succeeded` + +A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded. + +
+ +connect_webview_id Format: UUID + +ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). +
+
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connect_webview.login_succeeded` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + +### `connect_webview.login_failed` + +A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed. + +
+ +connect_webview_id Format: UUID + +ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connect_webview.login_failed` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 4b9238aa..a136a21d 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -80,3 +80,8 @@ title: Enrollment Automations resources: - enrollment_automation + +/connect_webviews: + title: Connect Webviews + resources: + - connect_webview diff --git a/src/lib/reference.ts b/src/lib/reference.ts index adae39a5..4984ed22 100644 --- a/src/lib/reference.ts +++ b/src/lib/reference.ts @@ -57,7 +57,8 @@ export const reference = ( !route.path.startsWith('/acs') && !route.path.startsWith('/thermostats') && !route.path.startsWith('/phones') && - !route.path.startsWith('/user_identities') + !route.path.startsWith('/user_identities') && + !route.path.startsWith('/connect_webviews') ) { continue }