@airtop/sdk 0.1.12 → 0.1.14
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/profiles/client/Client.d.ts +0 -10
- package/api/resources/profiles/client/Client.js +2 -82
- package/api/resources/profiles/client/requests/index.d.ts +0 -1
- package/api/resources/sessions/client/Client.js +12 -12
- 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 +32 -0
- package/api/resources/windows/client/Client.js +109 -24
- package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +1 -1
- package/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +21 -0
- package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +5 -1
- package/api/resources/windows/client/requests/index.d.ts +1 -0
- package/api/types/ClickConfig.d.ts +2 -0
- package/api/types/ClickConfigClickType.d.ts +12 -0
- package/api/types/ClickConfigClickType.js +11 -0
- package/api/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
- package/api/types/MicroInteractionConfig.d.ts +10 -0
- package/api/types/ScreenshotConfig.d.ts +13 -0
- package/api/types/ScreenshotMetadata.d.ts +7 -0
- package/api/types/ScreenshotRequestConfig.d.ts +8 -0
- package/api/types/VisualAnalysisConfig.d.ts +5 -1
- package/api/types/VisualAnalysisConfigScope.d.ts +4 -2
- package/api/types/VisualAnalysisConfigScope.js +2 -0
- package/api/types/index.d.ts +5 -2
- package/api/types/index.js +5 -2
- package/dist/api/resources/profiles/client/Client.d.ts +0 -10
- package/dist/api/resources/profiles/client/Client.js +2 -82
- package/dist/api/resources/profiles/client/requests/index.d.ts +0 -1
- package/dist/api/resources/sessions/client/Client.js +12 -12
- 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 +32 -0
- package/dist/api/resources/windows/client/Client.js +109 -24
- package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +1 -1
- package/dist/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +21 -0
- package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +5 -1
- package/dist/api/resources/windows/client/requests/index.d.ts +1 -0
- package/dist/api/types/ClickConfig.d.ts +2 -0
- package/dist/api/types/ClickConfigClickType.d.ts +12 -0
- package/dist/api/types/ClickConfigClickType.js +11 -0
- package/dist/api/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
- package/dist/api/types/MicroInteractionConfig.d.ts +10 -0
- package/dist/api/types/MicroInteractionConfig.js +5 -0
- package/dist/api/types/ScreenshotConfig.d.ts +13 -0
- package/dist/api/types/ScreenshotConfig.js +5 -0
- package/dist/api/types/ScreenshotMetadata.d.ts +7 -0
- package/dist/api/types/ScreenshotMetadata.js +5 -0
- package/dist/api/types/ScreenshotRequestConfig.d.ts +8 -0
- package/dist/api/types/ScreenshotRequestConfig.js +5 -0
- package/dist/api/types/VisualAnalysisConfig.d.ts +5 -1
- package/dist/api/types/VisualAnalysisConfigScope.d.ts +4 -2
- package/dist/api/types/VisualAnalysisConfigScope.js +2 -0
- package/dist/api/types/index.d.ts +5 -2
- package/dist/api/types/index.js +5 -2
- 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/SessionHoverHandlerRequestBody.d.ts +2 -2
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +2 -2
- package/dist/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +16 -0
- package/dist/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +37 -0
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +4 -2
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +4 -2
- package/dist/serialization/resources/windows/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/windows/client/requests/index.js +3 -1
- package/dist/serialization/types/ClickConfig.d.ts +2 -0
- package/dist/serialization/types/ClickConfig.js +2 -0
- package/dist/serialization/types/ClickConfigClickType.d.ts +10 -0
- package/dist/serialization/types/ClickConfigClickType.js +31 -0
- package/dist/serialization/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
- package/dist/serialization/types/ExternalSessionAiResponseMetadata.js +2 -0
- package/dist/serialization/types/MicroInteractionConfig.d.ts +15 -0
- package/dist/serialization/types/{ProfilesResponse.js → MicroInteractionConfig.js} +6 -9
- package/dist/serialization/types/ScreenshotConfig.d.ts +15 -0
- package/{serialization/types/ProfilesResponse.js → dist/serialization/types/ScreenshotConfig.js} +6 -9
- package/dist/serialization/types/ScreenshotMetadata.d.ts +12 -0
- package/dist/serialization/types/{ExternalProfileV1.js → ScreenshotMetadata.js} +3 -5
- package/dist/serialization/types/ScreenshotRequestConfig.d.ts +13 -0
- package/{serialization/types/ExternalProfileV1.js → dist/serialization/types/ScreenshotRequestConfig.js} +4 -5
- package/dist/serialization/types/VisualAnalysisConfig.d.ts +2 -0
- package/dist/serialization/types/VisualAnalysisConfig.js +2 -0
- package/dist/serialization/types/VisualAnalysisConfigScope.d.ts +1 -1
- package/dist/serialization/types/VisualAnalysisConfigScope.js +1 -1
- package/dist/serialization/types/index.d.ts +5 -2
- package/dist/serialization/types/index.js +5 -2
- package/package.json +1 -1
- package/reference.md +184 -18
- 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/SessionHoverHandlerRequestBody.d.ts +2 -2
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +2 -2
- package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +16 -0
- package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +37 -0
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +4 -2
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +4 -2
- package/serialization/resources/windows/client/requests/index.d.ts +1 -0
- package/serialization/resources/windows/client/requests/index.js +3 -1
- package/serialization/types/ClickConfig.d.ts +2 -0
- package/serialization/types/ClickConfig.js +2 -0
- package/serialization/types/ClickConfigClickType.d.ts +10 -0
- package/serialization/types/ClickConfigClickType.js +31 -0
- package/serialization/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
- package/serialization/types/ExternalSessionAiResponseMetadata.js +2 -0
- package/serialization/types/MicroInteractionConfig.d.ts +15 -0
- package/serialization/types/MicroInteractionConfig.js +36 -0
- package/serialization/types/ScreenshotConfig.d.ts +15 -0
- package/serialization/types/ScreenshotConfig.js +36 -0
- package/serialization/types/ScreenshotMetadata.d.ts +12 -0
- package/serialization/types/ScreenshotMetadata.js +33 -0
- package/serialization/types/ScreenshotRequestConfig.d.ts +13 -0
- package/serialization/types/ScreenshotRequestConfig.js +34 -0
- package/serialization/types/VisualAnalysisConfig.d.ts +2 -0
- package/serialization/types/VisualAnalysisConfig.js +2 -0
- package/serialization/types/VisualAnalysisConfigScope.d.ts +1 -1
- package/serialization/types/VisualAnalysisConfigScope.js +1 -1
- package/serialization/types/index.d.ts +5 -2
- package/serialization/types/index.js +5 -2
- package/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +0 -17
- package/api/types/ExternalProfileV1.d.ts +0 -11
- package/api/types/ProfilesResponse.d.ts +0 -10
- package/dist/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +0 -17
- package/dist/api/types/ExternalProfileV1.d.ts +0 -11
- package/dist/api/types/ProfilesResponse.d.ts +0 -10
- package/dist/serialization/types/ExternalProfileV1.d.ts +0 -14
- package/dist/serialization/types/ProfilesResponse.d.ts +0 -18
- package/serialization/types/ExternalProfileV1.d.ts +0 -14
- package/serialization/types/ProfilesResponse.d.ts +0 -18
- /package/api/resources/{profiles/client/requests/ProfilesGetRequest.js → windows/client/requests/SessionScreenshotHandlerRequestBody.js} +0 -0
- /package/api/types/{ExternalProfileV1.js → MicroInteractionConfig.js} +0 -0
- /package/api/types/{ProfilesResponse.js → ScreenshotConfig.js} +0 -0
- /package/{dist/api/resources/profiles/client/requests/ProfilesGetRequest.js → api/types/ScreenshotMetadata.js} +0 -0
- /package/{dist/api/types/ExternalProfileV1.js → api/types/ScreenshotRequestConfig.js} +0 -0
- /package/dist/api/{types/ProfilesResponse.js → resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js} +0 -0
package/reference.md
CHANGED
@@ -6,6 +6,21 @@
|
|
6
6
|
<dl>
|
7
7
|
<dd>
|
8
8
|
|
9
|
+
#### 📝 Description
|
10
|
+
|
11
|
+
<dl>
|
12
|
+
<dd>
|
13
|
+
|
14
|
+
<dl>
|
15
|
+
<dd>
|
16
|
+
|
17
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
18
|
+
|
19
|
+
</dd>
|
20
|
+
</dl>
|
21
|
+
</dd>
|
22
|
+
</dl>
|
23
|
+
|
9
24
|
#### 🔌 Usage
|
10
25
|
|
11
26
|
<dl>
|
@@ -62,6 +77,21 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
62
77
|
<dl>
|
63
78
|
<dd>
|
64
79
|
|
80
|
+
#### 📝 Description
|
81
|
+
|
82
|
+
<dl>
|
83
|
+
<dd>
|
84
|
+
|
85
|
+
<dl>
|
86
|
+
<dd>
|
87
|
+
|
88
|
+
Get information about a browser window in a session, including the live view url.
|
89
|
+
|
90
|
+
</dd>
|
91
|
+
</dl>
|
92
|
+
</dd>
|
93
|
+
</dl>
|
94
|
+
|
65
95
|
#### 🔌 Usage
|
66
96
|
|
67
97
|
<dl>
|
@@ -128,6 +158,21 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
128
158
|
<dl>
|
129
159
|
<dd>
|
130
160
|
|
161
|
+
#### 📝 Description
|
162
|
+
|
163
|
+
<dl>
|
164
|
+
<dd>
|
165
|
+
|
166
|
+
<dl>
|
167
|
+
<dd>
|
168
|
+
|
169
|
+
Loads a specified url on a given window
|
170
|
+
|
171
|
+
</dd>
|
172
|
+
</dl>
|
173
|
+
</dd>
|
174
|
+
</dl>
|
175
|
+
|
131
176
|
#### 🔌 Usage
|
132
177
|
|
133
178
|
<dl>
|
@@ -194,6 +239,21 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
194
239
|
<dl>
|
195
240
|
<dd>
|
196
241
|
|
242
|
+
#### 📝 Description
|
243
|
+
|
244
|
+
<dl>
|
245
|
+
<dd>
|
246
|
+
|
247
|
+
<dl>
|
248
|
+
<dd>
|
249
|
+
|
250
|
+
Closes a browser window in a session
|
251
|
+
|
252
|
+
</dd>
|
253
|
+
</dl>
|
254
|
+
</dd>
|
255
|
+
</dl>
|
256
|
+
|
197
257
|
#### 🔌 Usage
|
198
258
|
|
199
259
|
<dl>
|
@@ -250,6 +310,21 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
250
310
|
<dl>
|
251
311
|
<dd>
|
252
312
|
|
313
|
+
#### 📝 Description
|
314
|
+
|
315
|
+
<dl>
|
316
|
+
<dd>
|
317
|
+
|
318
|
+
<dl>
|
319
|
+
<dd>
|
320
|
+
|
321
|
+
Execute a click interaction in a specific browser window
|
322
|
+
|
323
|
+
</dd>
|
324
|
+
</dl>
|
325
|
+
</dd>
|
326
|
+
</dl>
|
327
|
+
|
253
328
|
#### 🔌 Usage
|
254
329
|
|
255
330
|
<dl>
|
@@ -316,6 +391,21 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
316
391
|
<dl>
|
317
392
|
<dd>
|
318
393
|
|
394
|
+
#### 📝 Description
|
395
|
+
|
396
|
+
<dl>
|
397
|
+
<dd>
|
398
|
+
|
399
|
+
<dl>
|
400
|
+
<dd>
|
401
|
+
|
402
|
+
Execute a hover interaction in a specific browser window
|
403
|
+
|
404
|
+
</dd>
|
405
|
+
</dl>
|
406
|
+
</dd>
|
407
|
+
</dl>
|
408
|
+
|
319
409
|
#### 🔌 Usage
|
320
410
|
|
321
411
|
<dl>
|
@@ -380,6 +470,21 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
380
470
|
<dl>
|
381
471
|
<dd>
|
382
472
|
|
473
|
+
#### 📝 Description
|
474
|
+
|
475
|
+
<dl>
|
476
|
+
<dd>
|
477
|
+
|
478
|
+
<dl>
|
479
|
+
<dd>
|
480
|
+
|
481
|
+
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?).
|
482
|
+
|
483
|
+
</dd>
|
484
|
+
</dl>
|
485
|
+
</dd>
|
486
|
+
</dl>
|
487
|
+
|
383
488
|
#### 🔌 Usage
|
384
489
|
|
385
490
|
<dl>
|
@@ -446,6 +551,21 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
446
551
|
<dl>
|
447
552
|
<dd>
|
448
553
|
|
554
|
+
#### 📝 Description
|
555
|
+
|
556
|
+
<dl>
|
557
|
+
<dd>
|
558
|
+
|
559
|
+
<dl>
|
560
|
+
<dd>
|
561
|
+
|
562
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
563
|
+
|
564
|
+
</dd>
|
565
|
+
</dl>
|
566
|
+
</dd>
|
567
|
+
</dl>
|
568
|
+
|
449
569
|
#### 🔌 Usage
|
450
570
|
|
451
571
|
<dl>
|
@@ -594,6 +714,21 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
594
714
|
<dl>
|
595
715
|
<dd>
|
596
716
|
|
717
|
+
#### 📝 Description
|
718
|
+
|
719
|
+
<dl>
|
720
|
+
<dd>
|
721
|
+
|
722
|
+
<dl>
|
723
|
+
<dd>
|
724
|
+
|
725
|
+
Scrape a window and return the content as markdown
|
726
|
+
|
727
|
+
</dd>
|
728
|
+
</dl>
|
729
|
+
</dd>
|
730
|
+
</dl>
|
731
|
+
|
597
732
|
#### 🔌 Usage
|
598
733
|
|
599
734
|
<dl>
|
@@ -654,7 +789,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
654
789
|
</dl>
|
655
790
|
</details>
|
656
791
|
|
657
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
792
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
658
793
|
<dl>
|
659
794
|
<dd>
|
660
795
|
|
@@ -666,7 +801,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
666
801
|
<dl>
|
667
802
|
<dd>
|
668
803
|
|
669
|
-
|
804
|
+
Take a screenshot of a browser window
|
670
805
|
|
671
806
|
</dd>
|
672
807
|
</dl>
|
@@ -682,7 +817,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
682
817
|
<dd>
|
683
818
|
|
684
819
|
```typescript
|
685
|
-
await client.windows.
|
820
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
686
821
|
```
|
687
822
|
|
688
823
|
</dd>
|
@@ -706,7 +841,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
706
841
|
<dl>
|
707
842
|
<dd>
|
708
843
|
|
709
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
844
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
710
845
|
|
711
846
|
</dd>
|
712
847
|
</dl>
|
@@ -714,7 +849,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
714
849
|
<dl>
|
715
850
|
<dd>
|
716
851
|
|
717
|
-
**request:** `Airtop.
|
852
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
718
853
|
|
719
854
|
</dd>
|
720
855
|
</dl>
|
@@ -733,10 +868,25 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
733
868
|
</dl>
|
734
869
|
</details>
|
735
870
|
|
736
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
871
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
872
|
+
<dl>
|
873
|
+
<dd>
|
874
|
+
|
875
|
+
#### 📝 Description
|
876
|
+
|
877
|
+
<dl>
|
878
|
+
<dd>
|
879
|
+
|
737
880
|
<dl>
|
738
881
|
<dd>
|
739
882
|
|
883
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
884
|
+
|
885
|
+
</dd>
|
886
|
+
</dl>
|
887
|
+
</dd>
|
888
|
+
</dl>
|
889
|
+
|
740
890
|
#### 🔌 Usage
|
741
891
|
|
742
892
|
<dl>
|
@@ -746,9 +896,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
746
896
|
<dd>
|
747
897
|
|
748
898
|
```typescript
|
749
|
-
await client.windows.
|
750
|
-
text: "Example text",
|
751
|
-
});
|
899
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
752
900
|
```
|
753
901
|
|
754
902
|
</dd>
|
@@ -772,7 +920,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
772
920
|
<dl>
|
773
921
|
<dd>
|
774
922
|
|
775
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
923
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
776
924
|
|
777
925
|
</dd>
|
778
926
|
</dl>
|
@@ -780,7 +928,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
780
928
|
<dl>
|
781
929
|
<dd>
|
782
930
|
|
783
|
-
**request:** `Airtop.
|
931
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
784
932
|
|
785
933
|
</dd>
|
786
934
|
</dl>
|
@@ -799,9 +947,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
799
947
|
</dl>
|
800
948
|
</details>
|
801
949
|
|
802
|
-
|
803
|
-
|
804
|
-
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">get</a>({ ...params }) -> Airtop.ProfilesResponse</code></summary>
|
950
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
805
951
|
<dl>
|
806
952
|
<dd>
|
807
953
|
|
@@ -813,7 +959,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
813
959
|
<dl>
|
814
960
|
<dd>
|
815
961
|
|
816
|
-
|
962
|
+
Execute a type interaction in a specific browser window
|
817
963
|
|
818
964
|
</dd>
|
819
965
|
</dl>
|
@@ -829,7 +975,9 @@ Get profiles matching by id
|
|
829
975
|
<dd>
|
830
976
|
|
831
977
|
```typescript
|
832
|
-
await client.
|
978
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
979
|
+
text: "Example text",
|
980
|
+
});
|
833
981
|
```
|
834
982
|
|
835
983
|
</dd>
|
@@ -845,7 +993,7 @@ await client.profiles.get();
|
|
845
993
|
<dl>
|
846
994
|
<dd>
|
847
995
|
|
848
|
-
**
|
996
|
+
**sessionId:** `string` — The session id for the window.
|
849
997
|
|
850
998
|
</dd>
|
851
999
|
</dl>
|
@@ -853,7 +1001,23 @@ await client.profiles.get();
|
|
853
1001
|
<dl>
|
854
1002
|
<dd>
|
855
1003
|
|
856
|
-
**
|
1004
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1005
|
+
|
1006
|
+
</dd>
|
1007
|
+
</dl>
|
1008
|
+
|
1009
|
+
<dl>
|
1010
|
+
<dd>
|
1011
|
+
|
1012
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
1013
|
+
|
1014
|
+
</dd>
|
1015
|
+
</dl>
|
1016
|
+
|
1017
|
+
<dl>
|
1018
|
+
<dd>
|
1019
|
+
|
1020
|
+
**requestOptions:** `Windows.RequestOptions`
|
857
1021
|
|
858
1022
|
</dd>
|
859
1023
|
</dl>
|
@@ -864,6 +1028,8 @@ await client.profiles.get();
|
|
864
1028
|
</dl>
|
865
1029
|
</details>
|
866
1030
|
|
1031
|
+
## Profiles
|
1032
|
+
|
867
1033
|
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
868
1034
|
<dl>
|
869
1035
|
<dd>
|
@@ -4,13 +4,16 @@
|
|
4
4
|
import * as serializers from "../../../index";
|
5
5
|
import * as Airtop from "../../../../api/index";
|
6
6
|
import * as core from "../../../../core";
|
7
|
+
import { SessionsEventsResponseSessionEvent } from "./SessionsEventsResponseSessionEvent";
|
7
8
|
import { SessionsEventsResponseStatus } from "./SessionsEventsResponseStatus";
|
8
9
|
import { SessionsEventsResponseError } from "./SessionsEventsResponseError";
|
9
10
|
import { SessionsEventsResponseWindowEvent } from "./SessionsEventsResponseWindowEvent";
|
10
|
-
import { SessionsEventsResponseSessionEvent } from "./SessionsEventsResponseSessionEvent";
|
11
11
|
export declare const SessionsEventsResponse: core.serialization.Schema<serializers.SessionsEventsResponse.Raw, Airtop.SessionsEventsResponse>;
|
12
12
|
export declare namespace SessionsEventsResponse {
|
13
|
-
type Raw = SessionsEventsResponse.
|
13
|
+
type Raw = SessionsEventsResponse.SessionEvent | SessionsEventsResponse.Status | SessionsEventsResponse.Error | SessionsEventsResponse.WindowEvent;
|
14
|
+
interface SessionEvent extends SessionsEventsResponseSessionEvent.Raw {
|
15
|
+
event: "sessionEvent";
|
16
|
+
}
|
14
17
|
interface Status extends SessionsEventsResponseStatus.Raw {
|
15
18
|
event: "status";
|
16
19
|
}
|
@@ -20,7 +23,4 @@ export declare namespace SessionsEventsResponse {
|
|
20
23
|
interface WindowEvent extends SessionsEventsResponseWindowEvent.Raw {
|
21
24
|
event: "windowEvent";
|
22
25
|
}
|
23
|
-
interface SessionEvent extends SessionsEventsResponseSessionEvent.Raw {
|
24
|
-
event: "sessionEvent";
|
25
|
-
}
|
26
26
|
}
|
@@ -28,16 +28,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
29
29
|
exports.SessionsEventsResponse = void 0;
|
30
30
|
const core = __importStar(require("../../../../core"));
|
31
|
+
const SessionsEventsResponseSessionEvent_1 = require("./SessionsEventsResponseSessionEvent");
|
31
32
|
const SessionsEventsResponseStatus_1 = require("./SessionsEventsResponseStatus");
|
32
33
|
const SessionsEventsResponseError_1 = require("./SessionsEventsResponseError");
|
33
34
|
const SessionsEventsResponseWindowEvent_1 = require("./SessionsEventsResponseWindowEvent");
|
34
|
-
const SessionsEventsResponseSessionEvent_1 = require("./SessionsEventsResponseSessionEvent");
|
35
35
|
exports.SessionsEventsResponse = core.serialization
|
36
36
|
.union("event", {
|
37
|
+
sessionEvent: SessionsEventsResponseSessionEvent_1.SessionsEventsResponseSessionEvent,
|
37
38
|
status: SessionsEventsResponseStatus_1.SessionsEventsResponseStatus,
|
38
39
|
error: SessionsEventsResponseError_1.SessionsEventsResponseError,
|
39
40
|
windowEvent: SessionsEventsResponseWindowEvent_1.SessionsEventsResponseWindowEvent,
|
40
|
-
sessionEvent: SessionsEventsResponseSessionEvent_1.SessionsEventsResponseSessionEvent,
|
41
41
|
})
|
42
42
|
.transform({
|
43
43
|
transform: (value) => value,
|
@@ -1,6 +1,6 @@
|
|
1
1
|
export * from "./SessionsListRequestStatus";
|
2
|
+
export * from "./SessionsEventsResponseSessionEvent";
|
2
3
|
export * from "./SessionsEventsResponseStatus";
|
3
4
|
export * from "./SessionsEventsResponseError";
|
4
5
|
export * from "./SessionsEventsResponseWindowEvent";
|
5
|
-
export * from "./SessionsEventsResponseSessionEvent";
|
6
6
|
export * from "./SessionsEventsResponse";
|
@@ -15,8 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
15
|
};
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
17
17
|
__exportStar(require("./SessionsListRequestStatus"), exports);
|
18
|
+
__exportStar(require("./SessionsEventsResponseSessionEvent"), exports);
|
18
19
|
__exportStar(require("./SessionsEventsResponseStatus"), exports);
|
19
20
|
__exportStar(require("./SessionsEventsResponseError"), exports);
|
20
21
|
__exportStar(require("./SessionsEventsResponseWindowEvent"), exports);
|
21
|
-
__exportStar(require("./SessionsEventsResponseSessionEvent"), exports);
|
22
22
|
__exportStar(require("./SessionsEventsResponse"), exports);
|
@@ -4,12 +4,12 @@
|
|
4
4
|
import * as serializers from "../../../../index";
|
5
5
|
import * as Airtop from "../../../../../api/index";
|
6
6
|
import * as core from "../../../../../core";
|
7
|
-
import {
|
7
|
+
import { MicroInteractionConfig } from "../../../../types/MicroInteractionConfig";
|
8
8
|
export declare const SessionHoverHandlerRequestBody: core.serialization.Schema<serializers.SessionHoverHandlerRequestBody.Raw, Airtop.SessionHoverHandlerRequestBody>;
|
9
9
|
export declare namespace SessionHoverHandlerRequestBody {
|
10
10
|
interface Raw {
|
11
11
|
clientRequestId?: string | null;
|
12
|
-
configuration?:
|
12
|
+
configuration?: MicroInteractionConfig.Raw | null;
|
13
13
|
costThresholdCredits?: number | null;
|
14
14
|
elementDescription?: string | null;
|
15
15
|
timeThresholdSeconds?: number | null;
|
@@ -28,10 +28,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
29
29
|
exports.SessionHoverHandlerRequestBody = void 0;
|
30
30
|
const core = __importStar(require("../../../../../core"));
|
31
|
-
const
|
31
|
+
const MicroInteractionConfig_1 = require("../../../../types/MicroInteractionConfig");
|
32
32
|
exports.SessionHoverHandlerRequestBody = core.serialization.object({
|
33
33
|
clientRequestId: core.serialization.string().optional(),
|
34
|
-
configuration:
|
34
|
+
configuration: MicroInteractionConfig_1.MicroInteractionConfig.optional(),
|
35
35
|
costThresholdCredits: core.serialization.number().optional(),
|
36
36
|
elementDescription: core.serialization.string().optional(),
|
37
37
|
timeThresholdSeconds: core.serialization.number().optional(),
|
package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
/**
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
3
|
+
*/
|
4
|
+
import * as serializers from "../../../../index";
|
5
|
+
import * as Airtop from "../../../../../api/index";
|
6
|
+
import * as core from "../../../../../core";
|
7
|
+
import { ScreenshotRequestConfig } from "../../../../types/ScreenshotRequestConfig";
|
8
|
+
export declare const SessionScreenshotHandlerRequestBody: core.serialization.Schema<serializers.SessionScreenshotHandlerRequestBody.Raw, Airtop.SessionScreenshotHandlerRequestBody>;
|
9
|
+
export declare namespace SessionScreenshotHandlerRequestBody {
|
10
|
+
interface Raw {
|
11
|
+
clientRequestId?: string | null;
|
12
|
+
configuration?: ScreenshotRequestConfig.Raw | null;
|
13
|
+
costThresholdCredits?: number | null;
|
14
|
+
timeThresholdSeconds?: number | null;
|
15
|
+
}
|
16
|
+
}
|
package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
"use strict";
|
2
|
+
/**
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
4
|
+
*/
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
6
|
+
if (k2 === undefined) k2 = k;
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
10
|
+
}
|
11
|
+
Object.defineProperty(o, k2, desc);
|
12
|
+
}) : (function(o, m, k, k2) {
|
13
|
+
if (k2 === undefined) k2 = k;
|
14
|
+
o[k2] = m[k];
|
15
|
+
}));
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
18
|
+
}) : function(o, v) {
|
19
|
+
o["default"] = v;
|
20
|
+
});
|
21
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
22
|
+
if (mod && mod.__esModule) return mod;
|
23
|
+
var result = {};
|
24
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
25
|
+
__setModuleDefault(result, mod);
|
26
|
+
return result;
|
27
|
+
};
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
29
|
+
exports.SessionScreenshotHandlerRequestBody = void 0;
|
30
|
+
const core = __importStar(require("../../../../../core"));
|
31
|
+
const ScreenshotRequestConfig_1 = require("../../../../types/ScreenshotRequestConfig");
|
32
|
+
exports.SessionScreenshotHandlerRequestBody = core.serialization.object({
|
33
|
+
clientRequestId: core.serialization.string().optional(),
|
34
|
+
configuration: ScreenshotRequestConfig_1.ScreenshotRequestConfig.optional(),
|
35
|
+
costThresholdCredits: core.serialization.number().optional(),
|
36
|
+
timeThresholdSeconds: core.serialization.number().optional(),
|
37
|
+
});
|
@@ -4,15 +4,17 @@
|
|
4
4
|
import * as serializers from "../../../../index";
|
5
5
|
import * as Airtop from "../../../../../api/index";
|
6
6
|
import * as core from "../../../../../core";
|
7
|
-
import {
|
7
|
+
import { MicroInteractionConfig } from "../../../../types/MicroInteractionConfig";
|
8
8
|
export declare const SessionTypeHandlerRequestBody: core.serialization.Schema<serializers.SessionTypeHandlerRequestBody.Raw, Airtop.SessionTypeHandlerRequestBody>;
|
9
9
|
export declare namespace SessionTypeHandlerRequestBody {
|
10
10
|
interface Raw {
|
11
|
+
clearInputField?: boolean | null;
|
11
12
|
clientRequestId?: string | null;
|
12
|
-
configuration?:
|
13
|
+
configuration?: MicroInteractionConfig.Raw | null;
|
13
14
|
costThresholdCredits?: number | null;
|
14
15
|
elementDescription?: string | null;
|
15
16
|
pressEnterKey?: boolean | null;
|
17
|
+
pressTabKey?: boolean | null;
|
16
18
|
text: string;
|
17
19
|
timeThresholdSeconds?: number | null;
|
18
20
|
waitForNavigation?: boolean | null;
|
@@ -28,13 +28,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
29
29
|
exports.SessionTypeHandlerRequestBody = void 0;
|
30
30
|
const core = __importStar(require("../../../../../core"));
|
31
|
-
const
|
31
|
+
const MicroInteractionConfig_1 = require("../../../../types/MicroInteractionConfig");
|
32
32
|
exports.SessionTypeHandlerRequestBody = core.serialization.object({
|
33
|
+
clearInputField: core.serialization.boolean().optional(),
|
33
34
|
clientRequestId: core.serialization.string().optional(),
|
34
|
-
configuration:
|
35
|
+
configuration: MicroInteractionConfig_1.MicroInteractionConfig.optional(),
|
35
36
|
costThresholdCredits: core.serialization.number().optional(),
|
36
37
|
elementDescription: core.serialization.string().optional(),
|
37
38
|
pressEnterKey: core.serialization.boolean().optional(),
|
39
|
+
pressTabKey: core.serialization.boolean().optional(),
|
38
40
|
text: core.serialization.string(),
|
39
41
|
timeThresholdSeconds: core.serialization.number().optional(),
|
40
42
|
waitForNavigation: core.serialization.boolean().optional(),
|
@@ -4,5 +4,6 @@ export { SessionClickHandlerRequestBody } from "./SessionClickHandlerRequestBody
|
|
4
4
|
export { SessionHoverHandlerRequestBody } from "./SessionHoverHandlerRequestBody";
|
5
5
|
export { SessionPaginatedExtractionHandlerRequestBody } from "./SessionPaginatedExtractionHandlerRequestBody";
|
6
6
|
export { ScrapeContentRequest } from "./ScrapeContentRequest";
|
7
|
+
export { SessionScreenshotHandlerRequestBody } from "./SessionScreenshotHandlerRequestBody";
|
7
8
|
export { SessionSummaryHandlerRequestBody } from "./SessionSummaryHandlerRequestBody";
|
8
9
|
export { SessionTypeHandlerRequestBody } from "./SessionTypeHandlerRequestBody";
|
@@ -1,6 +1,6 @@
|
|
1
1
|
"use strict";
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
3
|
-
exports.SessionTypeHandlerRequestBody = exports.SessionSummaryHandlerRequestBody = exports.ScrapeContentRequest = exports.SessionPaginatedExtractionHandlerRequestBody = exports.SessionHoverHandlerRequestBody = exports.SessionClickHandlerRequestBody = exports.WindowLoadUrlV1Body = exports.CreateWindowInputV1Body = void 0;
|
3
|
+
exports.SessionTypeHandlerRequestBody = exports.SessionSummaryHandlerRequestBody = exports.SessionScreenshotHandlerRequestBody = exports.ScrapeContentRequest = exports.SessionPaginatedExtractionHandlerRequestBody = exports.SessionHoverHandlerRequestBody = exports.SessionClickHandlerRequestBody = exports.WindowLoadUrlV1Body = exports.CreateWindowInputV1Body = void 0;
|
4
4
|
var CreateWindowInputV1Body_1 = require("./CreateWindowInputV1Body");
|
5
5
|
Object.defineProperty(exports, "CreateWindowInputV1Body", { enumerable: true, get: function () { return CreateWindowInputV1Body_1.CreateWindowInputV1Body; } });
|
6
6
|
var WindowLoadUrlV1Body_1 = require("./WindowLoadUrlV1Body");
|
@@ -13,6 +13,8 @@ var SessionPaginatedExtractionHandlerRequestBody_1 = require("./SessionPaginated
|
|
13
13
|
Object.defineProperty(exports, "SessionPaginatedExtractionHandlerRequestBody", { enumerable: true, get: function () { return SessionPaginatedExtractionHandlerRequestBody_1.SessionPaginatedExtractionHandlerRequestBody; } });
|
14
14
|
var ScrapeContentRequest_1 = require("./ScrapeContentRequest");
|
15
15
|
Object.defineProperty(exports, "ScrapeContentRequest", { enumerable: true, get: function () { return ScrapeContentRequest_1.ScrapeContentRequest; } });
|
16
|
+
var SessionScreenshotHandlerRequestBody_1 = require("./SessionScreenshotHandlerRequestBody");
|
17
|
+
Object.defineProperty(exports, "SessionScreenshotHandlerRequestBody", { enumerable: true, get: function () { return SessionScreenshotHandlerRequestBody_1.SessionScreenshotHandlerRequestBody; } });
|
16
18
|
var SessionSummaryHandlerRequestBody_1 = require("./SessionSummaryHandlerRequestBody");
|
17
19
|
Object.defineProperty(exports, "SessionSummaryHandlerRequestBody", { enumerable: true, get: function () { return SessionSummaryHandlerRequestBody_1.SessionSummaryHandlerRequestBody; } });
|
18
20
|
var SessionTypeHandlerRequestBody_1 = require("./SessionTypeHandlerRequestBody");
|
@@ -4,11 +4,13 @@
|
|
4
4
|
import * as serializers from "../index";
|
5
5
|
import * as Airtop from "../../api/index";
|
6
6
|
import * as core from "../../core";
|
7
|
+
import { ClickConfigClickType } from "./ClickConfigClickType";
|
7
8
|
import { VisualAnalysisConfig } from "./VisualAnalysisConfig";
|
8
9
|
import { BrowserWaitNavigationConfig } from "./BrowserWaitNavigationConfig";
|
9
10
|
export declare const ClickConfig: core.serialization.ObjectSchema<serializers.ClickConfig.Raw, Airtop.ClickConfig>;
|
10
11
|
export declare namespace ClickConfig {
|
11
12
|
interface Raw {
|
13
|
+
clickType?: ClickConfigClickType.Raw | null;
|
12
14
|
visualAnalysis?: VisualAnalysisConfig.Raw | null;
|
13
15
|
waitForNavigationConfig?: BrowserWaitNavigationConfig.Raw | null;
|
14
16
|
}
|
@@ -28,9 +28,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
29
29
|
exports.ClickConfig = void 0;
|
30
30
|
const core = __importStar(require("../../core"));
|
31
|
+
const ClickConfigClickType_1 = require("./ClickConfigClickType");
|
31
32
|
const VisualAnalysisConfig_1 = require("./VisualAnalysisConfig");
|
32
33
|
const BrowserWaitNavigationConfig_1 = require("./BrowserWaitNavigationConfig");
|
33
34
|
exports.ClickConfig = core.serialization.object({
|
35
|
+
clickType: ClickConfigClickType_1.ClickConfigClickType.optional(),
|
34
36
|
visualAnalysis: VisualAnalysisConfig_1.VisualAnalysisConfig.optional(),
|
35
37
|
waitForNavigationConfig: BrowserWaitNavigationConfig_1.BrowserWaitNavigationConfig.optional(),
|
36
38
|
});
|
@@ -0,0 +1,10 @@
|
|
1
|
+
/**
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
3
|
+
*/
|
4
|
+
import * as serializers from "../index";
|
5
|
+
import * as Airtop from "../../api/index";
|
6
|
+
import * as core from "../../core";
|
7
|
+
export declare const ClickConfigClickType: core.serialization.Schema<serializers.ClickConfigClickType.Raw, Airtop.ClickConfigClickType>;
|
8
|
+
export declare namespace ClickConfigClickType {
|
9
|
+
type Raw = "click" | "doubleClick" | "rightClick";
|
10
|
+
}
|
@@ -0,0 +1,31 @@
|
|
1
|
+
"use strict";
|
2
|
+
/**
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
4
|
+
*/
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
6
|
+
if (k2 === undefined) k2 = k;
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
10
|
+
}
|
11
|
+
Object.defineProperty(o, k2, desc);
|
12
|
+
}) : (function(o, m, k, k2) {
|
13
|
+
if (k2 === undefined) k2 = k;
|
14
|
+
o[k2] = m[k];
|
15
|
+
}));
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
18
|
+
}) : function(o, v) {
|
19
|
+
o["default"] = v;
|
20
|
+
});
|
21
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
22
|
+
if (mod && mod.__esModule) return mod;
|
23
|
+
var result = {};
|
24
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
25
|
+
__setModuleDefault(result, mod);
|
26
|
+
return result;
|
27
|
+
};
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
29
|
+
exports.ClickConfigClickType = void 0;
|
30
|
+
const core = __importStar(require("../../core"));
|
31
|
+
exports.ClickConfigClickType = core.serialization.enum_(["click", "doubleClick", "rightClick"]);
|