@airtop/sdk 0.1.35-beta0 → 0.1.36-beta0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api/resources/automations/client/Client.d.ts +8 -8
- package/api/resources/automations/client/Client.js +12 -12
- package/api/resources/files/client/Client.js +4 -4
- package/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +2 -0
- package/api/resources/profiles/client/Client.js +1 -1
- package/api/resources/requests/client/Client.js +1 -1
- package/api/resources/sessions/client/Client.d.ts +0 -10
- package/api/resources/sessions/client/Client.js +6 -52
- package/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
- package/api/resources/sessions/types/index.d.ts +1 -1
- package/api/resources/sessions/types/index.js +1 -1
- package/api/resources/windows/client/Client.d.ts +52 -0
- package/api/resources/windows/client/Client.js +250 -26
- package/api/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/AsyncFillFormRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/CreateFormFillerRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/CreateFormFillerRequest.js +5 -0
- package/api/resources/windows/client/requests/FillFormRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/FillFormRequest.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +4 -0
- package/api/types/index.d.ts +0 -11
- package/api/types/index.js +0 -11
- package/dist/api/resources/automations/client/Client.d.ts +8 -8
- package/dist/api/resources/automations/client/Client.js +12 -12
- package/dist/api/resources/files/client/Client.js +4 -4
- package/dist/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +2 -0
- package/dist/api/resources/profiles/client/Client.js +1 -1
- package/dist/api/resources/requests/client/Client.js +1 -1
- package/dist/api/resources/sessions/client/Client.d.ts +0 -10
- package/dist/api/resources/sessions/client/Client.js +6 -52
- package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
- package/dist/api/resources/sessions/types/index.d.ts +1 -1
- package/dist/api/resources/sessions/types/index.js +1 -1
- package/dist/api/resources/windows/client/Client.d.ts +52 -0
- package/dist/api/resources/windows/client/Client.js +250 -26
- package/dist/api/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/AsyncCreateFormFillerRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncFillFormRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncFillFormRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/CreateFormFillerRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/CreateFormFillerRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/FillFormRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/FillFormRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +4 -0
- package/dist/api/types/index.d.ts +0 -11
- package/dist/api/types/index.js +0 -11
- package/dist/serialization/resources/files/client/requests/CreateFileRestInputV1.d.ts +1 -0
- package/dist/serialization/resources/files/client/requests/CreateFileRestInputV1.js +1 -0
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
- package/dist/serialization/resources/sessions/types/index.d.ts +1 -1
- package/dist/serialization/resources/sessions/types/index.js +1 -1
- package/dist/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFillFormRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFillFormRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/CreateFormFillerRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/CreateFormFillerRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/FillFormRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/FillFormRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +4 -0
- package/dist/serialization/resources/windows/client/requests/index.js +9 -1
- package/dist/serialization/types/index.d.ts +0 -11
- package/dist/serialization/types/index.js +0 -11
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AirtopClient.d.ts +2 -1
- package/dist/wrapper/AirtopClient.js +6 -3
- package/dist/wrapper/AirtopWindows.d.ts +1 -1
- package/package.json +2 -3
- package/reference.md +253 -395
- package/serialization/resources/files/client/requests/CreateFileRestInputV1.d.ts +1 -0
- package/serialization/resources/files/client/requests/CreateFileRestInputV1.js +1 -0
- package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
- package/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
- package/serialization/resources/sessions/types/index.d.ts +1 -1
- package/serialization/resources/sessions/types/index.js +1 -1
- package/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncFillFormRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncFillFormRequest.js +49 -0
- package/serialization/resources/windows/client/requests/CreateFormFillerRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/CreateFormFillerRequest.js +49 -0
- package/serialization/resources/windows/client/requests/FillFormRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/FillFormRequest.js +49 -0
- package/serialization/resources/windows/client/requests/index.d.ts +4 -0
- package/serialization/resources/windows/client/requests/index.js +9 -1
- package/serialization/types/index.d.ts +0 -11
- package/serialization/types/index.js +0 -11
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AirtopClient.d.ts +2 -1
- package/wrapper/AirtopClient.js +6 -3
- package/wrapper/AirtopWindows.d.ts +1 -1
- package/api/types/ExtensionConfigurationOutput.d.ts +0 -13
- package/dist/api/types/ExtensionConfigurationOutput.d.ts +0 -13
- /package/api/{types/ExtensionConfigurationOutput.js → resources/windows/client/requests/AsyncCreateFormFillerRequest.js} +0 -0
- /package/{dist/api/types/ExtensionConfigurationOutput.js → api/resources/windows/client/requests/AsyncFillFormRequest.js} +0 -0
package/reference.md
CHANGED
@@ -165,6 +165,88 @@ await client.windows.asyncCreateAutomation(
|
|
165
165
|
</dl>
|
166
166
|
</details>
|
167
167
|
|
168
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
169
|
+
<dl>
|
170
|
+
<dd>
|
171
|
+
|
172
|
+
#### 📝 Description
|
173
|
+
|
174
|
+
<dl>
|
175
|
+
<dd>
|
176
|
+
|
177
|
+
<dl>
|
178
|
+
<dd>
|
179
|
+
|
180
|
+
Create a form filler automation asynchronously
|
181
|
+
|
182
|
+
</dd>
|
183
|
+
</dl>
|
184
|
+
</dd>
|
185
|
+
</dl>
|
186
|
+
|
187
|
+
#### 🔌 Usage
|
188
|
+
|
189
|
+
<dl>
|
190
|
+
<dd>
|
191
|
+
|
192
|
+
<dl>
|
193
|
+
<dd>
|
194
|
+
|
195
|
+
```typescript
|
196
|
+
await client.windows.asyncCreateFormFiller(
|
197
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
198
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
199
|
+
);
|
200
|
+
```
|
201
|
+
|
202
|
+
</dd>
|
203
|
+
</dl>
|
204
|
+
</dd>
|
205
|
+
</dl>
|
206
|
+
|
207
|
+
#### ⚙️ Parameters
|
208
|
+
|
209
|
+
<dl>
|
210
|
+
<dd>
|
211
|
+
|
212
|
+
<dl>
|
213
|
+
<dd>
|
214
|
+
|
215
|
+
**sessionId:** `string` — The session id for the window.
|
216
|
+
|
217
|
+
</dd>
|
218
|
+
</dl>
|
219
|
+
|
220
|
+
<dl>
|
221
|
+
<dd>
|
222
|
+
|
223
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
224
|
+
|
225
|
+
</dd>
|
226
|
+
</dl>
|
227
|
+
|
228
|
+
<dl>
|
229
|
+
<dd>
|
230
|
+
|
231
|
+
**request:** `Airtop.AsyncCreateFormFillerRequest`
|
232
|
+
|
233
|
+
</dd>
|
234
|
+
</dl>
|
235
|
+
|
236
|
+
<dl>
|
237
|
+
<dd>
|
238
|
+
|
239
|
+
**requestOptions:** `Windows.RequestOptions`
|
240
|
+
|
241
|
+
</dd>
|
242
|
+
</dl>
|
243
|
+
</dd>
|
244
|
+
</dl>
|
245
|
+
|
246
|
+
</dd>
|
247
|
+
</dl>
|
248
|
+
</details>
|
249
|
+
|
168
250
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
169
251
|
<dl>
|
170
252
|
<dd>
|
@@ -250,6 +332,87 @@ await client.windows.asyncExecuteAutomation(
|
|
250
332
|
</dl>
|
251
333
|
</details>
|
252
334
|
|
335
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
336
|
+
<dl>
|
337
|
+
<dd>
|
338
|
+
|
339
|
+
#### 📝 Description
|
340
|
+
|
341
|
+
<dl>
|
342
|
+
<dd>
|
343
|
+
|
344
|
+
<dl>
|
345
|
+
<dd>
|
346
|
+
|
347
|
+
Fill a form of a browser window asynchronously using a form-filler automation
|
348
|
+
|
349
|
+
</dd>
|
350
|
+
</dl>
|
351
|
+
</dd>
|
352
|
+
</dl>
|
353
|
+
|
354
|
+
#### 🔌 Usage
|
355
|
+
|
356
|
+
<dl>
|
357
|
+
<dd>
|
358
|
+
|
359
|
+
<dl>
|
360
|
+
<dd>
|
361
|
+
|
362
|
+
```typescript
|
363
|
+
await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
364
|
+
automationId: "automationId",
|
365
|
+
});
|
366
|
+
```
|
367
|
+
|
368
|
+
</dd>
|
369
|
+
</dl>
|
370
|
+
</dd>
|
371
|
+
</dl>
|
372
|
+
|
373
|
+
#### ⚙️ Parameters
|
374
|
+
|
375
|
+
<dl>
|
376
|
+
<dd>
|
377
|
+
|
378
|
+
<dl>
|
379
|
+
<dd>
|
380
|
+
|
381
|
+
**sessionId:** `string` — The session id for the window.
|
382
|
+
|
383
|
+
</dd>
|
384
|
+
</dl>
|
385
|
+
|
386
|
+
<dl>
|
387
|
+
<dd>
|
388
|
+
|
389
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
390
|
+
|
391
|
+
</dd>
|
392
|
+
</dl>
|
393
|
+
|
394
|
+
<dl>
|
395
|
+
<dd>
|
396
|
+
|
397
|
+
**request:** `Airtop.AsyncFillFormRequest`
|
398
|
+
|
399
|
+
</dd>
|
400
|
+
</dl>
|
401
|
+
|
402
|
+
<dl>
|
403
|
+
<dd>
|
404
|
+
|
405
|
+
**requestOptions:** `Windows.RequestOptions`
|
406
|
+
|
407
|
+
</dd>
|
408
|
+
</dl>
|
409
|
+
</dd>
|
410
|
+
</dl>
|
411
|
+
|
412
|
+
</dd>
|
413
|
+
</dl>
|
414
|
+
</details>
|
415
|
+
|
253
416
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
254
417
|
<dl>
|
255
418
|
<dd>
|
@@ -1215,7 +1378,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1215
1378
|
</dl>
|
1216
1379
|
</details>
|
1217
1380
|
|
1218
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1381
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1219
1382
|
<dl>
|
1220
1383
|
<dd>
|
1221
1384
|
|
@@ -1227,7 +1390,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1227
1390
|
<dl>
|
1228
1391
|
<dd>
|
1229
1392
|
|
1230
|
-
|
1393
|
+
Create a form-filler automation synchronously for the form loaded in the browser window
|
1231
1394
|
|
1232
1395
|
</dd>
|
1233
1396
|
</dl>
|
@@ -1243,9 +1406,7 @@ Execute a hover interaction in a specific browser window
|
|
1243
1406
|
<dd>
|
1244
1407
|
|
1245
1408
|
```typescript
|
1246
|
-
await client.windows.
|
1247
|
-
elementDescription: "The search box input in the top right corner",
|
1248
|
-
});
|
1409
|
+
await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1249
1410
|
```
|
1250
1411
|
|
1251
1412
|
</dd>
|
@@ -1277,7 +1438,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1277
1438
|
<dl>
|
1278
1439
|
<dd>
|
1279
1440
|
|
1280
|
-
**request:** `Airtop.
|
1441
|
+
**request:** `Airtop.CreateFormFillerRequest`
|
1281
1442
|
|
1282
1443
|
</dd>
|
1283
1444
|
</dl>
|
@@ -1296,10 +1457,25 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1296
1457
|
</dl>
|
1297
1458
|
</details>
|
1298
1459
|
|
1299
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1460
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1461
|
+
<dl>
|
1462
|
+
<dd>
|
1463
|
+
|
1464
|
+
#### 📝 Description
|
1465
|
+
|
1466
|
+
<dl>
|
1467
|
+
<dd>
|
1468
|
+
|
1300
1469
|
<dl>
|
1301
1470
|
<dd>
|
1302
1471
|
|
1472
|
+
Fill a form of a browser window synchronously using a form-filler automation
|
1473
|
+
|
1474
|
+
</dd>
|
1475
|
+
</dl>
|
1476
|
+
</dd>
|
1477
|
+
</dl>
|
1478
|
+
|
1303
1479
|
#### 🔌 Usage
|
1304
1480
|
|
1305
1481
|
<dl>
|
@@ -1309,8 +1485,8 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1309
1485
|
<dd>
|
1310
1486
|
|
1311
1487
|
```typescript
|
1312
|
-
await client.windows.
|
1313
|
-
|
1488
|
+
await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1489
|
+
automationId: "automationId",
|
1314
1490
|
});
|
1315
1491
|
```
|
1316
1492
|
|
@@ -1343,7 +1519,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1343
1519
|
<dl>
|
1344
1520
|
<dd>
|
1345
1521
|
|
1346
|
-
**request:** `Airtop.
|
1522
|
+
**request:** `Airtop.FillFormRequest`
|
1347
1523
|
|
1348
1524
|
</dd>
|
1349
1525
|
</dl>
|
@@ -1362,7 +1538,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1362
1538
|
</dl>
|
1363
1539
|
</details>
|
1364
1540
|
|
1365
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1541
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1366
1542
|
<dl>
|
1367
1543
|
<dd>
|
1368
1544
|
|
@@ -1374,7 +1550,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1374
1550
|
<dl>
|
1375
1551
|
<dd>
|
1376
1552
|
|
1377
|
-
|
1553
|
+
Execute a hover interaction in a specific browser window
|
1378
1554
|
|
1379
1555
|
</dd>
|
1380
1556
|
</dl>
|
@@ -1390,8 +1566,8 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
1390
1566
|
<dd>
|
1391
1567
|
|
1392
1568
|
```typescript
|
1393
|
-
await client.windows.
|
1394
|
-
|
1569
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1570
|
+
elementDescription: "The search box input in the top right corner",
|
1395
1571
|
});
|
1396
1572
|
```
|
1397
1573
|
|
@@ -1424,7 +1600,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1424
1600
|
<dl>
|
1425
1601
|
<dd>
|
1426
1602
|
|
1427
|
-
**request:** `Airtop.
|
1603
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
1428
1604
|
|
1429
1605
|
</dd>
|
1430
1606
|
</dl>
|
@@ -1443,25 +1619,10 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1443
1619
|
</dl>
|
1444
1620
|
</details>
|
1445
1621
|
|
1446
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1447
|
-
<dl>
|
1448
|
-
<dd>
|
1449
|
-
|
1450
|
-
#### 📝 Description
|
1451
|
-
|
1452
|
-
<dl>
|
1453
|
-
<dd>
|
1454
|
-
|
1622
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1455
1623
|
<dl>
|
1456
1624
|
<dd>
|
1457
1625
|
|
1458
|
-
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
1459
|
-
|
1460
|
-
</dd>
|
1461
|
-
</dl>
|
1462
|
-
</dd>
|
1463
|
-
</dl>
|
1464
|
-
|
1465
1626
|
#### 🔌 Usage
|
1466
1627
|
|
1467
1628
|
<dl>
|
@@ -1471,13 +1632,9 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
1471
1632
|
<dd>
|
1472
1633
|
|
1473
1634
|
```typescript
|
1474
|
-
await client.windows.
|
1475
|
-
"
|
1476
|
-
|
1477
|
-
{
|
1478
|
-
prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
|
1479
|
-
},
|
1480
|
-
);
|
1635
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1636
|
+
condition: "Determine if the user appears to be signed in to the website",
|
1637
|
+
});
|
1481
1638
|
```
|
1482
1639
|
|
1483
1640
|
</dd>
|
@@ -1509,7 +1666,7 @@ await client.windows.paginatedExtraction(
|
|
1509
1666
|
<dl>
|
1510
1667
|
<dd>
|
1511
1668
|
|
1512
|
-
**request:** `Airtop.
|
1669
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
1513
1670
|
|
1514
1671
|
</dd>
|
1515
1672
|
</dl>
|
@@ -1528,7 +1685,7 @@ await client.windows.paginatedExtraction(
|
|
1528
1685
|
</dl>
|
1529
1686
|
</details>
|
1530
1687
|
|
1531
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1688
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1532
1689
|
<dl>
|
1533
1690
|
<dd>
|
1534
1691
|
|
@@ -1540,7 +1697,7 @@ await client.windows.paginatedExtraction(
|
|
1540
1697
|
<dl>
|
1541
1698
|
<dd>
|
1542
1699
|
|
1543
|
-
|
1700
|
+
Submit a prompt that queries the content of a specific browser window. You may extract content from the page, or ask a question about the page and allow the AI to answer it (ex. Is the user logged in?).
|
1544
1701
|
|
1545
1702
|
</dd>
|
1546
1703
|
</dl>
|
@@ -1556,7 +1713,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
1556
1713
|
<dd>
|
1557
1714
|
|
1558
1715
|
```typescript
|
1559
|
-
await client.windows.
|
1716
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1560
1717
|
prompt: "What is the main idea of this page?",
|
1561
1718
|
});
|
1562
1719
|
```
|
@@ -1609,7 +1766,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1609
1766
|
</dl>
|
1610
1767
|
</details>
|
1611
1768
|
|
1612
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1769
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1613
1770
|
<dl>
|
1614
1771
|
<dd>
|
1615
1772
|
|
@@ -1621,7 +1778,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1621
1778
|
<dl>
|
1622
1779
|
<dd>
|
1623
1780
|
|
1624
|
-
|
1781
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
1625
1782
|
|
1626
1783
|
</dd>
|
1627
1784
|
</dl>
|
@@ -1637,7 +1794,13 @@ Scrape a window and return the content as markdown
|
|
1637
1794
|
<dd>
|
1638
1795
|
|
1639
1796
|
```typescript
|
1640
|
-
await client.windows.
|
1797
|
+
await client.windows.paginatedExtraction(
|
1798
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1799
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
1800
|
+
{
|
1801
|
+
prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
|
1802
|
+
},
|
1803
|
+
);
|
1641
1804
|
```
|
1642
1805
|
|
1643
1806
|
</dd>
|
@@ -1661,7 +1824,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1661
1824
|
<dl>
|
1662
1825
|
<dd>
|
1663
1826
|
|
1664
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
1827
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1665
1828
|
|
1666
1829
|
</dd>
|
1667
1830
|
</dl>
|
@@ -1669,7 +1832,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1669
1832
|
<dl>
|
1670
1833
|
<dd>
|
1671
1834
|
|
1672
|
-
**request:** `Airtop.
|
1835
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
1673
1836
|
|
1674
1837
|
</dd>
|
1675
1838
|
</dl>
|
@@ -1688,7 +1851,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1688
1851
|
</dl>
|
1689
1852
|
</details>
|
1690
1853
|
|
1691
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1854
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1692
1855
|
<dl>
|
1693
1856
|
<dd>
|
1694
1857
|
|
@@ -1700,7 +1863,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1700
1863
|
<dl>
|
1701
1864
|
<dd>
|
1702
1865
|
|
1703
|
-
|
1866
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
1704
1867
|
|
1705
1868
|
</dd>
|
1706
1869
|
</dl>
|
@@ -1716,7 +1879,9 @@ Take a screenshot of a browser window
|
|
1716
1879
|
<dd>
|
1717
1880
|
|
1718
1881
|
```typescript
|
1719
|
-
await client.windows.
|
1882
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1883
|
+
prompt: "What is the main idea of this page?",
|
1884
|
+
});
|
1720
1885
|
```
|
1721
1886
|
|
1722
1887
|
</dd>
|
@@ -1748,7 +1913,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1748
1913
|
<dl>
|
1749
1914
|
<dd>
|
1750
1915
|
|
1751
|
-
**request:** `Airtop.
|
1916
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
1752
1917
|
|
1753
1918
|
</dd>
|
1754
1919
|
</dl>
|
@@ -1767,7 +1932,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1767
1932
|
</dl>
|
1768
1933
|
</details>
|
1769
1934
|
|
1770
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1935
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
1771
1936
|
<dl>
|
1772
1937
|
<dd>
|
1773
1938
|
|
@@ -1779,7 +1944,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1779
1944
|
<dl>
|
1780
1945
|
<dd>
|
1781
1946
|
|
1782
|
-
|
1947
|
+
Scrape a window and return the content as markdown
|
1783
1948
|
|
1784
1949
|
</dd>
|
1785
1950
|
</dl>
|
@@ -1795,7 +1960,7 @@ Execute a scroll interaction in a specific browser window
|
|
1795
1960
|
<dd>
|
1796
1961
|
|
1797
1962
|
```typescript
|
1798
|
-
await client.windows.
|
1963
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1799
1964
|
```
|
1800
1965
|
|
1801
1966
|
</dd>
|
@@ -1819,7 +1984,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1819
1984
|
<dl>
|
1820
1985
|
<dd>
|
1821
1986
|
|
1822
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
1987
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
1823
1988
|
|
1824
1989
|
</dd>
|
1825
1990
|
</dl>
|
@@ -1827,7 +1992,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1827
1992
|
<dl>
|
1828
1993
|
<dd>
|
1829
1994
|
|
1830
|
-
**request:** `Airtop.
|
1995
|
+
**request:** `Airtop.ScrapeContentRequest`
|
1831
1996
|
|
1832
1997
|
</dd>
|
1833
1998
|
</dl>
|
@@ -1846,7 +2011,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1846
2011
|
</dl>
|
1847
2012
|
</details>
|
1848
2013
|
|
1849
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2014
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1850
2015
|
<dl>
|
1851
2016
|
<dd>
|
1852
2017
|
|
@@ -1858,7 +2023,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1858
2023
|
<dl>
|
1859
2024
|
<dd>
|
1860
2025
|
|
1861
|
-
|
2026
|
+
Take a screenshot of a browser window
|
1862
2027
|
|
1863
2028
|
</dd>
|
1864
2029
|
</dl>
|
@@ -1874,7 +2039,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
1874
2039
|
<dd>
|
1875
2040
|
|
1876
2041
|
```typescript
|
1877
|
-
await client.windows.
|
2042
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1878
2043
|
```
|
1879
2044
|
|
1880
2045
|
</dd>
|
@@ -1898,7 +2063,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1898
2063
|
<dl>
|
1899
2064
|
<dd>
|
1900
2065
|
|
1901
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
2066
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1902
2067
|
|
1903
2068
|
</dd>
|
1904
2069
|
</dl>
|
@@ -1906,7 +2071,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1906
2071
|
<dl>
|
1907
2072
|
<dd>
|
1908
2073
|
|
1909
|
-
**request:** `Airtop.
|
2074
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
1910
2075
|
|
1911
2076
|
</dd>
|
1912
2077
|
</dl>
|
@@ -1925,7 +2090,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1925
2090
|
</dl>
|
1926
2091
|
</details>
|
1927
2092
|
|
1928
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2093
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1929
2094
|
<dl>
|
1930
2095
|
<dd>
|
1931
2096
|
|
@@ -1937,7 +2102,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1937
2102
|
<dl>
|
1938
2103
|
<dd>
|
1939
2104
|
|
1940
|
-
Execute a
|
2105
|
+
Execute a scroll interaction in a specific browser window
|
1941
2106
|
|
1942
2107
|
</dd>
|
1943
2108
|
</dl>
|
@@ -1953,9 +2118,7 @@ Execute a type interaction in a specific browser window
|
|
1953
2118
|
<dd>
|
1954
2119
|
|
1955
2120
|
```typescript
|
1956
|
-
await client.windows.
|
1957
|
-
text: "Example text",
|
1958
|
-
});
|
2121
|
+
await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1959
2122
|
```
|
1960
2123
|
|
1961
2124
|
</dd>
|
@@ -1987,7 +2150,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1987
2150
|
<dl>
|
1988
2151
|
<dd>
|
1989
2152
|
|
1990
|
-
**request:** `Airtop.
|
2153
|
+
**request:** `Airtop.SessionScrollHandlerRequestBody`
|
1991
2154
|
|
1992
2155
|
</dd>
|
1993
2156
|
</dl>
|
@@ -2006,131 +2169,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
2006
2169
|
</dl>
|
2007
2170
|
</details>
|
2008
2171
|
|
2009
|
-
|
2010
|
-
|
2011
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">listAutomations</a>() -> Airtop.ListAutomationsOutput</code></summary>
|
2012
|
-
<dl>
|
2013
|
-
<dd>
|
2014
|
-
|
2015
|
-
#### 📝 Description
|
2016
|
-
|
2017
|
-
<dl>
|
2018
|
-
<dd>
|
2019
|
-
|
2020
|
-
<dl>
|
2021
|
-
<dd>
|
2022
|
-
|
2023
|
-
List all automations for a given organization
|
2024
|
-
|
2025
|
-
</dd>
|
2026
|
-
</dl>
|
2027
|
-
</dd>
|
2028
|
-
</dl>
|
2029
|
-
|
2030
|
-
#### 🔌 Usage
|
2031
|
-
|
2032
|
-
<dl>
|
2033
|
-
<dd>
|
2034
|
-
|
2035
|
-
<dl>
|
2036
|
-
<dd>
|
2037
|
-
|
2038
|
-
```typescript
|
2039
|
-
await client.automations.listAutomations();
|
2040
|
-
```
|
2041
|
-
|
2042
|
-
</dd>
|
2043
|
-
</dl>
|
2044
|
-
</dd>
|
2045
|
-
</dl>
|
2046
|
-
|
2047
|
-
#### ⚙️ Parameters
|
2048
|
-
|
2049
|
-
<dl>
|
2050
|
-
<dd>
|
2051
|
-
|
2052
|
-
<dl>
|
2053
|
-
<dd>
|
2054
|
-
|
2055
|
-
**requestOptions:** `Automations.RequestOptions`
|
2056
|
-
|
2057
|
-
</dd>
|
2058
|
-
</dl>
|
2059
|
-
</dd>
|
2060
|
-
</dl>
|
2061
|
-
|
2062
|
-
</dd>
|
2063
|
-
</dl>
|
2064
|
-
</details>
|
2065
|
-
|
2066
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">updateAutomationDescription</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
|
2067
|
-
<dl>
|
2068
|
-
<dd>
|
2069
|
-
|
2070
|
-
#### 📝 Description
|
2071
|
-
|
2072
|
-
<dl>
|
2073
|
-
<dd>
|
2074
|
-
|
2075
|
-
<dl>
|
2076
|
-
<dd>
|
2077
|
-
|
2078
|
-
Update the description of a specific automation
|
2079
|
-
|
2080
|
-
</dd>
|
2081
|
-
</dl>
|
2082
|
-
</dd>
|
2083
|
-
</dl>
|
2084
|
-
|
2085
|
-
#### 🔌 Usage
|
2086
|
-
|
2087
|
-
<dl>
|
2088
|
-
<dd>
|
2089
|
-
|
2090
|
-
<dl>
|
2091
|
-
<dd>
|
2092
|
-
|
2093
|
-
```typescript
|
2094
|
-
await client.automations.updateAutomationDescription({
|
2095
|
-
description: "description",
|
2096
|
-
id: "id",
|
2097
|
-
orgId: "orgId",
|
2098
|
-
});
|
2099
|
-
```
|
2100
|
-
|
2101
|
-
</dd>
|
2102
|
-
</dl>
|
2103
|
-
</dd>
|
2104
|
-
</dl>
|
2105
|
-
|
2106
|
-
#### ⚙️ Parameters
|
2107
|
-
|
2108
|
-
<dl>
|
2109
|
-
<dd>
|
2110
|
-
|
2111
|
-
<dl>
|
2112
|
-
<dd>
|
2113
|
-
|
2114
|
-
**request:** `Airtop.UpdateAutomationDescriptionInputBody`
|
2115
|
-
|
2116
|
-
</dd>
|
2117
|
-
</dl>
|
2118
|
-
|
2119
|
-
<dl>
|
2120
|
-
<dd>
|
2121
|
-
|
2122
|
-
**requestOptions:** `Automations.RequestOptions`
|
2123
|
-
|
2124
|
-
</dd>
|
2125
|
-
</dl>
|
2126
|
-
</dd>
|
2127
|
-
</dl>
|
2128
|
-
|
2129
|
-
</dd>
|
2130
|
-
</dl>
|
2131
|
-
</details>
|
2132
|
-
|
2133
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">getAutomation</a>(automationId) -> Airtop.AutomationOutput</code></summary>
|
2172
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2134
2173
|
<dl>
|
2135
2174
|
<dd>
|
2136
2175
|
|
@@ -2142,7 +2181,7 @@ await client.automations.updateAutomationDescription({
|
|
2142
2181
|
<dl>
|
2143
2182
|
<dd>
|
2144
2183
|
|
2145
|
-
|
2184
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
2146
2185
|
|
2147
2186
|
</dd>
|
2148
2187
|
</dl>
|
@@ -2158,7 +2197,7 @@ Get a specific automation by ID
|
|
2158
2197
|
<dd>
|
2159
2198
|
|
2160
2199
|
```typescript
|
2161
|
-
await client.
|
2200
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2162
2201
|
```
|
2163
2202
|
|
2164
2203
|
</dd>
|
@@ -2174,70 +2213,23 @@ await client.automations.getAutomation("automationId");
|
|
2174
2213
|
<dl>
|
2175
2214
|
<dd>
|
2176
2215
|
|
2177
|
-
**
|
2178
|
-
|
2179
|
-
</dd>
|
2180
|
-
</dl>
|
2181
|
-
|
2182
|
-
<dl>
|
2183
|
-
<dd>
|
2184
|
-
|
2185
|
-
**requestOptions:** `Automations.RequestOptions`
|
2186
|
-
|
2187
|
-
</dd>
|
2188
|
-
</dl>
|
2189
|
-
</dd>
|
2190
|
-
</dl>
|
2191
|
-
|
2192
|
-
</dd>
|
2193
|
-
</dl>
|
2194
|
-
</details>
|
2195
|
-
|
2196
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">deleteAutomation</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
|
2197
|
-
<dl>
|
2198
|
-
<dd>
|
2199
|
-
|
2200
|
-
#### 📝 Description
|
2201
|
-
|
2202
|
-
<dl>
|
2203
|
-
<dd>
|
2204
|
-
|
2205
|
-
<dl>
|
2206
|
-
<dd>
|
2207
|
-
|
2208
|
-
Delete a specific automation
|
2216
|
+
**sessionId:** `string` — The session id for the window.
|
2209
2217
|
|
2210
2218
|
</dd>
|
2211
2219
|
</dl>
|
2212
|
-
</dd>
|
2213
|
-
</dl>
|
2214
|
-
|
2215
|
-
#### 🔌 Usage
|
2216
|
-
|
2217
|
-
<dl>
|
2218
|
-
<dd>
|
2219
2220
|
|
2220
2221
|
<dl>
|
2221
2222
|
<dd>
|
2222
2223
|
|
2223
|
-
|
2224
|
-
await client.automations.deleteAutomation("automationId");
|
2225
|
-
```
|
2224
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
2226
2225
|
|
2227
|
-
</dd>
|
2228
|
-
</dl>
|
2229
2226
|
</dd>
|
2230
2227
|
</dl>
|
2231
2228
|
|
2232
|
-
#### ⚙️ Parameters
|
2233
|
-
|
2234
2229
|
<dl>
|
2235
2230
|
<dd>
|
2236
2231
|
|
2237
|
-
|
2238
|
-
<dd>
|
2239
|
-
|
2240
|
-
**automationId:** `string` — ID of the automation to delete
|
2232
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
2241
2233
|
|
2242
2234
|
</dd>
|
2243
2235
|
</dl>
|
@@ -2245,7 +2237,7 @@ await client.automations.deleteAutomation("automationId");
|
|
2245
2237
|
<dl>
|
2246
2238
|
<dd>
|
2247
2239
|
|
2248
|
-
**requestOptions:** `
|
2240
|
+
**requestOptions:** `Windows.RequestOptions`
|
2249
2241
|
|
2250
2242
|
</dd>
|
2251
2243
|
</dl>
|
@@ -2256,9 +2248,7 @@ await client.automations.deleteAutomation("automationId");
|
|
2256
2248
|
</dl>
|
2257
2249
|
</details>
|
2258
2250
|
|
2259
|
-
|
2260
|
-
|
2261
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">list</a>({ ...params }) -> Airtop.FilesResponse</code></summary>
|
2251
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2262
2252
|
<dl>
|
2263
2253
|
<dd>
|
2264
2254
|
|
@@ -2270,64 +2260,13 @@ await client.automations.deleteAutomation("automationId");
|
|
2270
2260
|
<dl>
|
2271
2261
|
<dd>
|
2272
2262
|
|
2273
|
-
|
2274
|
-
|
2275
|
-
</dd>
|
2276
|
-
</dl>
|
2277
|
-
</dd>
|
2278
|
-
</dl>
|
2279
|
-
|
2280
|
-
#### 🔌 Usage
|
2281
|
-
|
2282
|
-
<dl>
|
2283
|
-
<dd>
|
2284
|
-
|
2285
|
-
<dl>
|
2286
|
-
<dd>
|
2287
|
-
|
2288
|
-
```typescript
|
2289
|
-
await client.files.list({
|
2290
|
-
offset: 1,
|
2291
|
-
limit: 10,
|
2292
|
-
});
|
2293
|
-
```
|
2294
|
-
|
2295
|
-
</dd>
|
2296
|
-
</dl>
|
2297
|
-
</dd>
|
2298
|
-
</dl>
|
2299
|
-
|
2300
|
-
#### ⚙️ Parameters
|
2301
|
-
|
2302
|
-
<dl>
|
2303
|
-
<dd>
|
2304
|
-
|
2305
|
-
<dl>
|
2306
|
-
<dd>
|
2307
|
-
|
2308
|
-
**request:** `Airtop.FilesListRequest`
|
2309
|
-
|
2310
|
-
</dd>
|
2311
|
-
</dl>
|
2312
|
-
|
2313
|
-
<dl>
|
2314
|
-
<dd>
|
2315
|
-
|
2316
|
-
**requestOptions:** `Files.RequestOptions`
|
2263
|
+
Execute a type interaction in a specific browser window
|
2317
2264
|
|
2318
2265
|
</dd>
|
2319
2266
|
</dl>
|
2320
2267
|
</dd>
|
2321
2268
|
</dl>
|
2322
2269
|
|
2323
|
-
</dd>
|
2324
|
-
</dl>
|
2325
|
-
</details>
|
2326
|
-
|
2327
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">create</a>({ ...params }) -> Airtop.EnvelopeCreateFileV1EnvelopeDefaultMeta</code></summary>
|
2328
|
-
<dl>
|
2329
|
-
<dd>
|
2330
|
-
|
2331
2270
|
#### 🔌 Usage
|
2332
2271
|
|
2333
2272
|
<dl>
|
@@ -2337,8 +2276,8 @@ await client.files.list({
|
|
2337
2276
|
<dd>
|
2338
2277
|
|
2339
2278
|
```typescript
|
2340
|
-
await client.
|
2341
|
-
|
2279
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2280
|
+
text: "Example text",
|
2342
2281
|
});
|
2343
2282
|
```
|
2344
2283
|
|
@@ -2355,103 +2294,23 @@ await client.files.create({
|
|
2355
2294
|
<dl>
|
2356
2295
|
<dd>
|
2357
2296
|
|
2358
|
-
**
|
2359
|
-
|
2360
|
-
</dd>
|
2361
|
-
</dl>
|
2362
|
-
|
2363
|
-
<dl>
|
2364
|
-
<dd>
|
2365
|
-
|
2366
|
-
**requestOptions:** `Files.RequestOptions`
|
2367
|
-
|
2368
|
-
</dd>
|
2369
|
-
</dl>
|
2370
|
-
</dd>
|
2371
|
-
</dl>
|
2372
|
-
|
2373
|
-
</dd>
|
2374
|
-
</dl>
|
2375
|
-
</details>
|
2376
|
-
|
2377
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">get</a>(id) -> Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta</code></summary>
|
2378
|
-
<dl>
|
2379
|
-
<dd>
|
2380
|
-
|
2381
|
-
#### 🔌 Usage
|
2382
|
-
|
2383
|
-
<dl>
|
2384
|
-
<dd>
|
2385
|
-
|
2386
|
-
<dl>
|
2387
|
-
<dd>
|
2388
|
-
|
2389
|
-
```typescript
|
2390
|
-
await client.files.get("id");
|
2391
|
-
```
|
2392
|
-
|
2393
|
-
</dd>
|
2394
|
-
</dl>
|
2395
|
-
</dd>
|
2396
|
-
</dl>
|
2397
|
-
|
2398
|
-
#### ⚙️ Parameters
|
2399
|
-
|
2400
|
-
<dl>
|
2401
|
-
<dd>
|
2402
|
-
|
2403
|
-
<dl>
|
2404
|
-
<dd>
|
2405
|
-
|
2406
|
-
**id:** `string` — ID of the file
|
2407
|
-
|
2408
|
-
</dd>
|
2409
|
-
</dl>
|
2410
|
-
|
2411
|
-
<dl>
|
2412
|
-
<dd>
|
2413
|
-
|
2414
|
-
**requestOptions:** `Files.RequestOptions`
|
2297
|
+
**sessionId:** `string` — The session id for the window.
|
2415
2298
|
|
2416
|
-
</dd>
|
2417
|
-
</dl>
|
2418
2299
|
</dd>
|
2419
2300
|
</dl>
|
2420
2301
|
|
2421
|
-
</dd>
|
2422
|
-
</dl>
|
2423
|
-
</details>
|
2424
|
-
|
2425
|
-
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> void</code></summary>
|
2426
2302
|
<dl>
|
2427
2303
|
<dd>
|
2428
2304
|
|
2429
|
-
|
2430
|
-
|
2431
|
-
<dl>
|
2432
|
-
<dd>
|
2433
|
-
|
2434
|
-
<dl>
|
2435
|
-
<dd>
|
2436
|
-
|
2437
|
-
```typescript
|
2438
|
-
await client.files.delete("id");
|
2439
|
-
```
|
2305
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
2440
2306
|
|
2441
|
-
</dd>
|
2442
|
-
</dl>
|
2443
2307
|
</dd>
|
2444
2308
|
</dl>
|
2445
2309
|
|
2446
|
-
#### ⚙️ Parameters
|
2447
|
-
|
2448
|
-
<dl>
|
2449
|
-
<dd>
|
2450
|
-
|
2451
2310
|
<dl>
|
2452
2311
|
<dd>
|
2453
2312
|
|
2454
|
-
**
|
2313
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
2455
2314
|
|
2456
2315
|
</dd>
|
2457
2316
|
</dl>
|
@@ -2459,7 +2318,7 @@ await client.files.delete("id");
|
|
2459
2318
|
<dl>
|
2460
2319
|
<dd>
|
2461
2320
|
|
2462
|
-
**requestOptions:** `
|
2321
|
+
**requestOptions:** `Windows.RequestOptions`
|
2463
2322
|
|
2464
2323
|
</dd>
|
2465
2324
|
</dl>
|
@@ -2472,7 +2331,7 @@ await client.files.delete("id");
|
|
2472
2331
|
|
2473
2332
|
## Automations
|
2474
2333
|
|
2475
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">
|
2334
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">list</a>() -> Airtop.ListAutomationsOutput</code></summary>
|
2476
2335
|
<dl>
|
2477
2336
|
<dd>
|
2478
2337
|
|
@@ -2500,7 +2359,7 @@ List all automations for a given organization
|
|
2500
2359
|
<dd>
|
2501
2360
|
|
2502
2361
|
```typescript
|
2503
|
-
await client.automations.
|
2362
|
+
await client.automations.list();
|
2504
2363
|
```
|
2505
2364
|
|
2506
2365
|
</dd>
|
@@ -2527,7 +2386,7 @@ await client.automations.listAutomations();
|
|
2527
2386
|
</dl>
|
2528
2387
|
</details>
|
2529
2388
|
|
2530
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">
|
2389
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">update</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
|
2531
2390
|
<dl>
|
2532
2391
|
<dd>
|
2533
2392
|
|
@@ -2555,7 +2414,7 @@ Update the description of a specific automation
|
|
2555
2414
|
<dd>
|
2556
2415
|
|
2557
2416
|
```typescript
|
2558
|
-
await client.automations.
|
2417
|
+
await client.automations.update({
|
2559
2418
|
description: "description",
|
2560
2419
|
id: "id",
|
2561
2420
|
orgId: "orgId",
|
@@ -2594,7 +2453,7 @@ await client.automations.updateAutomationDescription({
|
|
2594
2453
|
</dl>
|
2595
2454
|
</details>
|
2596
2455
|
|
2597
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">
|
2456
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">get</a>(automationId) -> Airtop.AutomationOutput</code></summary>
|
2598
2457
|
<dl>
|
2599
2458
|
<dd>
|
2600
2459
|
|
@@ -2622,7 +2481,7 @@ Get a specific automation by ID
|
|
2622
2481
|
<dd>
|
2623
2482
|
|
2624
2483
|
```typescript
|
2625
|
-
await client.automations.
|
2484
|
+
await client.automations.get("automationId");
|
2626
2485
|
```
|
2627
2486
|
|
2628
2487
|
</dd>
|
@@ -2657,7 +2516,7 @@ await client.automations.getAutomation("automationId");
|
|
2657
2516
|
</dl>
|
2658
2517
|
</details>
|
2659
2518
|
|
2660
|
-
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">
|
2519
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">delete</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
|
2661
2520
|
<dl>
|
2662
2521
|
<dd>
|
2663
2522
|
|
@@ -2685,7 +2544,7 @@ Delete a specific automation
|
|
2685
2544
|
<dd>
|
2686
2545
|
|
2687
2546
|
```typescript
|
2688
|
-
await client.automations.
|
2547
|
+
await client.automations.delete("automationId");
|
2689
2548
|
```
|
2690
2549
|
|
2691
2550
|
</dd>
|
@@ -3063,7 +2922,6 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
|
3063
2922
|
<dl>
|
3064
2923
|
<dd>
|
3065
2924
|
|
3066
|
-
Get a paginated list of sessions filtered by ID or status
|
3067
2925
|
Get a paginated list of sessions filtered by ID or status
|
3068
2926
|
|
3069
2927
|
</dd>
|