Skip to content

Commit dbf6e75

Browse files
seambotseambot
committed
ci: Generate docs
1 parent 4b2fd93 commit dbf6e75

2 files changed

Lines changed: 237 additions & 1 deletion

File tree

‎docs/api/_report.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
- `/action_attempts`
1111
- `/bridges`
1212
- `/client_sessions`
13-
- `/connect_webviews`
1413
- `/connected_accounts`
1514
- `/devices`
1615
- `/devices/simulate`

‎docs/api/connect_webviews/README.md‎

Lines changed: 237 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
1+
# Connect Webviews
2+
3+
## `connect_webview`
4+
5+
### `accepted_devices`
6+
7+
{% hint style="warning" %}
8+
**Deprecated**. Unused. Will be removed.
9+
{% endhint %}
10+
11+
Format: `List`
12+
13+
Item format: `String`
14+
15+
---
16+
17+
### `accepted_providers`
18+
19+
Format: `List`
20+
21+
Item format: `String`
22+
23+
---
24+
25+
### `any_device_allowed`
26+
27+
{% hint style="warning" %}
28+
**Deprecated**. Unused. Will be removed.
29+
{% endhint %}
30+
31+
Format: `Boolean`
32+
33+
---
34+
35+
### `any_provider_allowed`
36+
37+
Format: `Boolean`
38+
39+
---
40+
41+
### `authorized_at`
42+
43+
Format: `Datetime`
44+
45+
---
46+
47+
### `automatically_manage_new_devices`
48+
49+
Format: `Boolean`
50+
51+
---
52+
53+
### `connect_webview_id`
54+
55+
Format: `UUID`
56+
57+
---
58+
59+
### `connected_account_id`
60+
61+
Format: `UUID`
62+
63+
---
64+
65+
### `created_at`
66+
67+
Format: `Datetime`
68+
69+
---
70+
71+
### `custom_metadata`
72+
73+
Format: `Record`
74+
75+
---
76+
77+
### `custom_redirect_failure_url`
78+
79+
Format: `String`
80+
81+
---
82+
83+
### `custom_redirect_url`
84+
85+
Format: `String`
86+
87+
---
88+
89+
### `device_selection_mode`
90+
91+
Format: `Enum`
92+
93+
Possible enum values:
94+
- `none`
95+
- `single`
96+
- `multiple`
97+
98+
---
99+
100+
### `login_successful`
101+
102+
Format: `Boolean`
103+
104+
---
105+
106+
### `selected_provider`
107+
108+
Format: `String`
109+
110+
---
111+
112+
### `status`
113+
114+
Format: `Enum`
115+
116+
Possible enum values:
117+
- `pending`
118+
- `failed`
119+
- `authorized`
120+
121+
---
122+
123+
### `url`
124+
125+
Format: `String`
126+
127+
---
128+
129+
### `wait_for_device_creation`
130+
131+
Format: `Boolean`
132+
133+
---
134+
135+
### `workspace_id`
136+
137+
Format: `UUID`
138+
139+
---
140+
141+
## Endpoints
142+
143+
144+
---
145+
146+
## Events
147+
148+
### `connect_webview.login_succeeded`
149+
150+
A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.
151+
152+
<details>
153+
154+
<summary><code>connect_webview_id</code> Format: <code>UUID</code></summary>
155+
156+
ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).
157+
</details>
158+
<details>
159+
160+
<summary><code>connected_account_id</code> Format: <code>UUID</code></summary>
161+
162+
ID of the [connected account](../../core-concepts/connected-accounts/README.md).
163+
</details>
164+
<details>
165+
166+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
167+
168+
Date and time at which the event was created.
169+
</details>
170+
<details>
171+
172+
<summary><code>event_id</code> Format: <code>UUID</code></summary>
173+
174+
ID of the event.
175+
</details>
176+
<details>
177+
178+
<summary><code>event_type</code> Format: <code>Enum</code></summary>
179+
180+
Value: `connect_webview.login_succeeded`
181+
</details>
182+
<details>
183+
184+
<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
185+
186+
Date and time at which the event occurred.
187+
</details>
188+
<details>
189+
190+
<summary><code>workspace_id</code> Format: <code>UUID</code></summary>
191+
192+
ID of the [workspace](../../core-concepts/workspaces/README.md).
193+
</details>
194+
---
195+
196+
### `connect_webview.login_failed`
197+
198+
A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.
199+
200+
<details>
201+
202+
<summary><code>connect_webview_id</code> Format: <code>UUID</code></summary>
203+
204+
ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).
205+
</details>
206+
<details>
207+
208+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
209+
210+
Date and time at which the event was created.
211+
</details>
212+
<details>
213+
214+
<summary><code>event_id</code> Format: <code>UUID</code></summary>
215+
216+
ID of the event.
217+
</details>
218+
<details>
219+
220+
<summary><code>event_type</code> Format: <code>Enum</code></summary>
221+
222+
Value: `connect_webview.login_failed`
223+
</details>
224+
<details>
225+
226+
<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
227+
228+
Date and time at which the event occurred.
229+
</details>
230+
<details>
231+
232+
<summary><code>workspace_id</code> Format: <code>UUID</code></summary>
233+
234+
ID of the [workspace](../../core-concepts/workspaces/README.md).
235+
</details>
236+
---
237+

0 commit comments

Comments
 (0)