@airtop/sdk 0.1.5 → 0.1.7
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/Client.d.ts +3 -3
- package/Client.js +9 -9
- package/README.md +6 -6
- package/api/resources/index.d.ts +3 -3
- package/api/resources/index.js +4 -4
- package/api/resources/profiles/client/Client.js +4 -4
- package/api/resources/sessions/client/Client.js +10 -10
- package/api/resources/windows/client/Client.d.ts +37 -3
- package/api/resources/windows/client/Client.js +206 -19
- package/api/resources/windows/client/requests/CreateWindowInputV1Body.d.ts +1 -1
- package/api/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +25 -0
- package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +23 -0
- package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +29 -0
- package/api/resources/windows/client/requests/WindowLoadUrlV1Body.d.ts +1 -1
- package/api/resources/windows/client/requests/index.d.ts +3 -0
- package/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +3 -2
- package/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -0
- package/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +3 -2
- package/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -0
- package/api/types/ClickConfig.d.ts +8 -0
- package/api/types/CustomProxy.d.ts +1 -1
- package/api/types/Issue.d.ts +2 -0
- package/{dist/api/types/EmptyResponseJson.d.ts → api/types/OperationOutcome.d.ts} +1 -1
- package/api/types/{EmptyResponse.d.ts → OperationOutcomeResponse.d.ts} +3 -3
- package/api/types/PageQueryConfig.d.ts +3 -0
- package/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/api/types/SummaryConfig.d.ts +2 -0
- package/api/types/VisualAnalysisConfig.d.ts +12 -0
- package/api/types/VisualAnalysisConfig.js +5 -0
- package/api/types/VisualAnalysisConfigPartitionDirection.d.ts +12 -0
- package/api/types/VisualAnalysisConfigPartitionDirection.js +11 -0
- package/api/types/VisualAnalysisConfigScope.d.ts +11 -0
- package/api/types/VisualAnalysisConfigScope.js +10 -0
- package/api/types/index.d.ts +6 -4
- package/api/types/index.js +6 -4
- package/dist/Client.d.ts +3 -3
- package/dist/Client.js +9 -9
- package/dist/api/resources/index.d.ts +3 -3
- package/dist/api/resources/index.js +4 -4
- package/dist/api/resources/profiles/client/Client.js +4 -4
- package/dist/api/resources/sessions/client/Client.js +10 -10
- package/dist/api/resources/windows/client/Client.d.ts +37 -3
- package/dist/api/resources/windows/client/Client.js +206 -19
- package/dist/api/resources/windows/client/requests/CreateWindowInputV1Body.d.ts +1 -1
- package/dist/api/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/SessionClickHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/WindowLoadUrlV1Body.d.ts +1 -1
- package/dist/api/resources/windows/client/requests/index.d.ts +3 -0
- package/dist/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +3 -2
- package/dist/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -0
- package/dist/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +3 -2
- package/dist/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -0
- package/dist/api/types/ClickConfig.d.ts +8 -0
- package/dist/api/types/ClickConfig.js +5 -0
- package/dist/api/types/CustomProxy.d.ts +1 -1
- package/dist/api/types/Issue.d.ts +2 -0
- package/{api/types/EmptyResponseJson.d.ts → dist/api/types/OperationOutcome.d.ts} +1 -1
- package/dist/api/types/OperationOutcome.js +5 -0
- package/dist/api/types/{EmptyResponse.d.ts → OperationOutcomeResponse.d.ts} +3 -3
- package/dist/api/types/OperationOutcomeResponse.js +5 -0
- package/dist/api/types/PageQueryConfig.d.ts +3 -0
- package/dist/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/dist/api/types/SummaryConfig.d.ts +2 -0
- package/dist/api/types/VisualAnalysisConfig.d.ts +12 -0
- package/dist/api/types/VisualAnalysisConfig.js +5 -0
- package/dist/api/types/VisualAnalysisConfigPartitionDirection.d.ts +12 -0
- package/dist/api/types/VisualAnalysisConfigPartitionDirection.js +11 -0
- package/dist/api/types/VisualAnalysisConfigScope.d.ts +11 -0
- package/dist/api/types/VisualAnalysisConfigScope.js +10 -0
- package/dist/api/types/index.d.ts +6 -4
- package/dist/api/types/index.js +6 -4
- package/dist/index.d.ts +1 -0
- package/dist/index.js +4 -0
- package/dist/serialization/resources/index.d.ts +3 -3
- package/dist/serialization/resources/index.js +4 -4
- package/dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +17 -0
- package/{serialization/types/EnvelopeStatusDefaultMeta.js → dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js} +9 -6
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +38 -0
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +40 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +3 -0
- package/dist/serialization/resources/windows/client/requests/index.js +7 -1
- package/dist/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
- package/dist/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -1
- package/dist/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
- package/dist/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -1
- package/dist/serialization/types/ClickConfig.d.ts +13 -0
- package/dist/serialization/types/ClickConfig.js +34 -0
- package/dist/serialization/types/Issue.d.ts +1 -0
- package/dist/serialization/types/Issue.js +1 -0
- package/{serialization/types/EmptyResponseJson.d.ts → dist/serialization/types/OperationOutcome.d.ts} +2 -2
- package/{serialization/types/EmptyResponseJson.js → dist/serialization/types/OperationOutcome.js} +2 -2
- package/dist/serialization/types/OperationOutcomeResponse.d.ts +18 -0
- package/dist/serialization/types/{EmptyResponse.js → OperationOutcomeResponse.js} +6 -6
- package/dist/serialization/types/PageQueryConfig.d.ts +2 -0
- package/dist/serialization/types/PageQueryConfig.js +2 -0
- package/dist/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/dist/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/dist/serialization/types/SummaryConfig.d.ts +2 -0
- package/dist/serialization/types/SummaryConfig.js +2 -0
- package/dist/serialization/types/VisualAnalysisConfig.d.ts +16 -0
- package/dist/serialization/types/{EnvelopeStatusDefaultMeta.js → VisualAnalysisConfig.js} +7 -5
- package/dist/serialization/types/VisualAnalysisConfigPartitionDirection.d.ts +10 -0
- package/dist/serialization/types/VisualAnalysisConfigPartitionDirection.js +31 -0
- package/dist/serialization/types/VisualAnalysisConfigScope.d.ts +10 -0
- package/dist/serialization/types/{EnvelopeStatusDefaultMetaStatus.js → VisualAnalysisConfigScope.js} +2 -2
- package/dist/serialization/types/index.d.ts +6 -4
- package/dist/serialization/types/index.js +6 -4
- package/dist/utils/batch-operate/SessionQueue.d.ts +46 -0
- package/dist/utils/batch-operate/SessionQueue.js +223 -0
- package/dist/utils/batch-operate/WindowQueue.d.ts +25 -0
- package/dist/utils/batch-operate/WindowQueue.js +201 -0
- package/dist/utils/batch-operate/batch-util.d.ts +3 -0
- package/dist/utils/batch-operate/batch-util.js +51 -0
- package/dist/utils/batch-operate/helpers.d.ts +2 -0
- package/dist/utils/batch-operate/helpers.js +19 -0
- package/dist/utils/batch-operate/types.d.ts +29 -0
- package/dist/utils/batch-operate/types.js +2 -0
- package/dist/utils/index.d.ts +2 -0
- package/dist/utils/index.js +18 -0
- package/dist/wrapper/AirtopClient.d.ts +3 -0
- package/dist/wrapper/AirtopClient.js +16 -0
- package/index.d.ts +1 -0
- package/index.js +4 -0
- package/package.json +3 -2
- package/reference.md +344 -148
- package/serialization/resources/index.d.ts +3 -3
- package/serialization/resources/index.js +4 -4
- package/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +17 -0
- package/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js +38 -0
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +17 -0
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +38 -0
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +19 -0
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +40 -0
- package/serialization/resources/windows/client/requests/index.d.ts +3 -0
- package/serialization/resources/windows/client/requests/index.js +7 -1
- package/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
- package/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -1
- package/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
- package/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -1
- package/serialization/types/ClickConfig.d.ts +13 -0
- package/serialization/types/ClickConfig.js +34 -0
- package/serialization/types/Issue.d.ts +1 -0
- package/serialization/types/Issue.js +1 -0
- package/{dist/serialization/types/EmptyResponseJson.d.ts → serialization/types/OperationOutcome.d.ts} +2 -2
- package/{dist/serialization/types/EmptyResponseJson.js → serialization/types/OperationOutcome.js} +2 -2
- package/serialization/types/OperationOutcomeResponse.d.ts +18 -0
- package/serialization/types/{EmptyResponse.js → OperationOutcomeResponse.js} +6 -6
- package/serialization/types/PageQueryConfig.d.ts +2 -0
- package/serialization/types/PageQueryConfig.js +2 -0
- package/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/serialization/types/SummaryConfig.d.ts +2 -0
- package/serialization/types/SummaryConfig.js +2 -0
- package/serialization/types/VisualAnalysisConfig.d.ts +16 -0
- package/serialization/types/VisualAnalysisConfig.js +37 -0
- package/serialization/types/VisualAnalysisConfigPartitionDirection.d.ts +10 -0
- package/serialization/types/VisualAnalysisConfigPartitionDirection.js +31 -0
- package/serialization/types/VisualAnalysisConfigScope.d.ts +10 -0
- package/serialization/types/{EnvelopeStatusDefaultMetaStatus.js → VisualAnalysisConfigScope.js} +2 -2
- package/serialization/types/index.d.ts +6 -4
- package/serialization/types/index.js +6 -4
- package/utils/batch-operate/SessionQueue.d.ts +46 -0
- package/utils/batch-operate/SessionQueue.js +223 -0
- package/utils/batch-operate/WindowQueue.d.ts +25 -0
- package/utils/batch-operate/WindowQueue.js +201 -0
- package/utils/batch-operate/batch-util.d.ts +3 -0
- package/utils/batch-operate/batch-util.js +51 -0
- package/utils/batch-operate/helpers.d.ts +2 -0
- package/utils/batch-operate/helpers.js +19 -0
- package/utils/batch-operate/types.d.ts +29 -0
- package/utils/batch-operate/types.js +2 -0
- package/utils/index.d.ts +2 -0
- package/utils/index.js +18 -0
- package/wrapper/AirtopClient.d.ts +3 -0
- package/wrapper/AirtopClient.js +16 -0
- package/api/types/EnvelopeStatusDefaultMeta.d.ts +0 -8
- package/api/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -9
- package/api/types/EnvelopeStatusDefaultMetaStatus.js +0 -11
- package/dist/api/types/EnvelopeStatusDefaultMeta.d.ts +0 -8
- package/dist/api/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -9
- package/dist/api/types/EnvelopeStatusDefaultMetaStatus.js +0 -11
- package/dist/serialization/types/EmptyResponse.d.ts +0 -18
- package/dist/serialization/types/EnvelopeStatusDefaultMeta.d.ts +0 -14
- package/dist/serialization/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -10
- package/serialization/types/EmptyResponse.d.ts +0 -18
- package/serialization/types/EnvelopeStatusDefaultMeta.d.ts +0 -14
- package/serialization/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -10
- /package/api/{types/EmptyResponse.js → resources/windows/client/requests/SessionClickHandlerRequestBody.js} +0 -0
- /package/api/{types/EmptyResponseJson.js → resources/windows/client/requests/SessionHoverHandlerRequestBody.js} +0 -0
- /package/api/{types/EnvelopeStatusDefaultMeta.js → resources/windows/client/requests/SessionTypeHandlerRequestBody.js} +0 -0
- /package/{dist/api/types/EmptyResponse.js → api/types/ClickConfig.js} +0 -0
- /package/{dist/api/types/EmptyResponseJson.js → api/types/OperationOutcome.js} +0 -0
- /package/{dist/api/types/EnvelopeStatusDefaultMeta.js → api/types/OperationOutcomeResponse.js} +0 -0
package/reference.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
# Reference
|
2
2
|
|
3
|
-
##
|
3
|
+
## Windows
|
4
4
|
|
5
|
-
<details><summary><code>client.
|
5
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
6
6
|
<dl>
|
7
7
|
<dd>
|
8
8
|
|
9
|
-
####
|
9
|
+
#### 🔌 Usage
|
10
10
|
|
11
11
|
<dl>
|
12
12
|
<dd>
|
@@ -14,14 +14,16 @@
|
|
14
14
|
<dl>
|
15
15
|
<dd>
|
16
16
|
|
17
|
-
|
17
|
+
```typescript
|
18
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
19
|
+
```
|
18
20
|
|
19
21
|
</dd>
|
20
22
|
</dl>
|
21
23
|
</dd>
|
22
24
|
</dl>
|
23
25
|
|
24
|
-
####
|
26
|
+
#### ⚙️ Parameters
|
25
27
|
|
26
28
|
<dl>
|
27
29
|
<dd>
|
@@ -29,24 +31,15 @@ Get profiles matching by id
|
|
29
31
|
<dl>
|
30
32
|
<dd>
|
31
33
|
|
32
|
-
|
33
|
-
await client.profiles.get();
|
34
|
-
```
|
34
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
35
35
|
|
36
36
|
</dd>
|
37
37
|
</dl>
|
38
|
-
</dd>
|
39
|
-
</dl>
|
40
|
-
|
41
|
-
#### ⚙️ Parameters
|
42
|
-
|
43
|
-
<dl>
|
44
|
-
<dd>
|
45
38
|
|
46
39
|
<dl>
|
47
40
|
<dd>
|
48
41
|
|
49
|
-
**request:** `Airtop.
|
42
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
50
43
|
|
51
44
|
</dd>
|
52
45
|
</dl>
|
@@ -54,7 +47,7 @@ await client.profiles.get();
|
|
54
47
|
<dl>
|
55
48
|
<dd>
|
56
49
|
|
57
|
-
**requestOptions:** `
|
50
|
+
**requestOptions:** `Windows.RequestOptions`
|
58
51
|
|
59
52
|
</dd>
|
60
53
|
</dl>
|
@@ -65,11 +58,11 @@ await client.profiles.get();
|
|
65
58
|
</dl>
|
66
59
|
</details>
|
67
60
|
|
68
|
-
<details><summary><code>client.
|
61
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
|
69
62
|
<dl>
|
70
63
|
<dd>
|
71
64
|
|
72
|
-
####
|
65
|
+
#### 🔌 Usage
|
73
66
|
|
74
67
|
<dl>
|
75
68
|
<dd>
|
@@ -77,14 +70,18 @@ await client.profiles.get();
|
|
77
70
|
<dl>
|
78
71
|
<dd>
|
79
72
|
|
80
|
-
|
73
|
+
```typescript
|
74
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
75
|
+
screenResolution: "1280x720",
|
76
|
+
});
|
77
|
+
```
|
81
78
|
|
82
79
|
</dd>
|
83
80
|
</dl>
|
84
81
|
</dd>
|
85
82
|
</dl>
|
86
83
|
|
87
|
-
####
|
84
|
+
#### ⚙️ Parameters
|
88
85
|
|
89
86
|
<dl>
|
90
87
|
<dd>
|
@@ -92,24 +89,23 @@ Delete profiles matching by id
|
|
92
89
|
<dl>
|
93
90
|
<dd>
|
94
91
|
|
95
|
-
|
96
|
-
await client.profiles.delete();
|
97
|
-
```
|
92
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
98
93
|
|
99
|
-
</dd>
|
100
|
-
</dl>
|
101
94
|
</dd>
|
102
95
|
</dl>
|
103
96
|
|
104
|
-
#### ⚙️ Parameters
|
105
|
-
|
106
97
|
<dl>
|
107
98
|
<dd>
|
108
99
|
|
100
|
+
**windowId:** `string` — ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
|
101
|
+
|
102
|
+
</dd>
|
103
|
+
</dl>
|
104
|
+
|
109
105
|
<dl>
|
110
106
|
<dd>
|
111
107
|
|
112
|
-
**request:** `Airtop.
|
108
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
113
109
|
|
114
110
|
</dd>
|
115
111
|
</dl>
|
@@ -117,7 +113,7 @@ await client.profiles.delete();
|
|
117
113
|
<dl>
|
118
114
|
<dd>
|
119
115
|
|
120
|
-
**requestOptions:** `
|
116
|
+
**requestOptions:** `Windows.RequestOptions`
|
121
117
|
|
122
118
|
</dd>
|
123
119
|
</dl>
|
@@ -128,13 +124,11 @@ await client.profiles.delete();
|
|
128
124
|
</dl>
|
129
125
|
</details>
|
130
126
|
|
131
|
-
|
132
|
-
|
133
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
|
127
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
134
128
|
<dl>
|
135
129
|
<dd>
|
136
130
|
|
137
|
-
####
|
131
|
+
#### 🔌 Usage
|
138
132
|
|
139
133
|
<dl>
|
140
134
|
<dd>
|
@@ -142,14 +136,18 @@ await client.profiles.delete();
|
|
142
136
|
<dl>
|
143
137
|
<dd>
|
144
138
|
|
145
|
-
|
139
|
+
```typescript
|
140
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
141
|
+
url: "https://www.airtop.ai",
|
142
|
+
});
|
143
|
+
```
|
146
144
|
|
147
145
|
</dd>
|
148
146
|
</dl>
|
149
147
|
</dd>
|
150
148
|
</dl>
|
151
149
|
|
152
|
-
####
|
150
|
+
#### ⚙️ Parameters
|
153
151
|
|
154
152
|
<dl>
|
155
153
|
<dd>
|
@@ -157,27 +155,23 @@ Get a list of sessions by ID
|
|
157
155
|
<dl>
|
158
156
|
<dd>
|
159
157
|
|
160
|
-
|
161
|
-
await client.sessions.list({
|
162
|
-
offset: 1,
|
163
|
-
limit: 10,
|
164
|
-
});
|
165
|
-
```
|
158
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
166
159
|
|
167
|
-
</dd>
|
168
|
-
</dl>
|
169
160
|
</dd>
|
170
161
|
</dl>
|
171
162
|
|
172
|
-
#### ⚙️ Parameters
|
173
|
-
|
174
163
|
<dl>
|
175
164
|
<dd>
|
176
165
|
|
166
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
167
|
+
|
168
|
+
</dd>
|
169
|
+
</dl>
|
170
|
+
|
177
171
|
<dl>
|
178
172
|
<dd>
|
179
173
|
|
180
|
-
**request:** `Airtop.
|
174
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
181
175
|
|
182
176
|
</dd>
|
183
177
|
</dl>
|
@@ -185,7 +179,7 @@ await client.sessions.list({
|
|
185
179
|
<dl>
|
186
180
|
<dd>
|
187
181
|
|
188
|
-
**requestOptions:** `
|
182
|
+
**requestOptions:** `Windows.RequestOptions`
|
189
183
|
|
190
184
|
</dd>
|
191
185
|
</dl>
|
@@ -196,7 +190,7 @@ await client.sessions.list({
|
|
196
190
|
</dl>
|
197
191
|
</details>
|
198
192
|
|
199
|
-
<details><summary><code>client.
|
193
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
200
194
|
<dl>
|
201
195
|
<dd>
|
202
196
|
|
@@ -209,7 +203,7 @@ await client.sessions.list({
|
|
209
203
|
<dd>
|
210
204
|
|
211
205
|
```typescript
|
212
|
-
await client.
|
206
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
213
207
|
```
|
214
208
|
|
215
209
|
</dd>
|
@@ -225,7 +219,7 @@ await client.sessions.create();
|
|
225
219
|
<dl>
|
226
220
|
<dd>
|
227
221
|
|
228
|
-
**
|
222
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
229
223
|
|
230
224
|
</dd>
|
231
225
|
</dl>
|
@@ -233,7 +227,15 @@ await client.sessions.create();
|
|
233
227
|
<dl>
|
234
228
|
<dd>
|
235
229
|
|
236
|
-
**
|
230
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
231
|
+
|
232
|
+
</dd>
|
233
|
+
</dl>
|
234
|
+
|
235
|
+
<dl>
|
236
|
+
<dd>
|
237
|
+
|
238
|
+
**requestOptions:** `Windows.RequestOptions`
|
237
239
|
|
238
240
|
</dd>
|
239
241
|
</dl>
|
@@ -244,11 +246,11 @@ await client.sessions.create();
|
|
244
246
|
</dl>
|
245
247
|
</details>
|
246
248
|
|
247
|
-
<details><summary><code>client.
|
249
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
248
250
|
<dl>
|
249
251
|
<dd>
|
250
252
|
|
251
|
-
####
|
253
|
+
#### 🔌 Usage
|
252
254
|
|
253
255
|
<dl>
|
254
256
|
<dd>
|
@@ -256,14 +258,18 @@ await client.sessions.create();
|
|
256
258
|
<dl>
|
257
259
|
<dd>
|
258
260
|
|
259
|
-
|
261
|
+
```typescript
|
262
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
263
|
+
elementDescription: "The login button",
|
264
|
+
});
|
265
|
+
```
|
260
266
|
|
261
267
|
</dd>
|
262
268
|
</dl>
|
263
269
|
</dd>
|
264
270
|
</dl>
|
265
271
|
|
266
|
-
####
|
272
|
+
#### ⚙️ Parameters
|
267
273
|
|
268
274
|
<dl>
|
269
275
|
<dd>
|
@@ -271,61 +277,109 @@ Get a session by ID
|
|
271
277
|
<dl>
|
272
278
|
<dd>
|
273
279
|
|
274
|
-
|
275
|
-
await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
276
|
-
```
|
280
|
+
**sessionId:** `string` — The session id for the window.
|
277
281
|
|
278
282
|
</dd>
|
279
283
|
</dl>
|
284
|
+
|
285
|
+
<dl>
|
286
|
+
<dd>
|
287
|
+
|
288
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
289
|
+
|
280
290
|
</dd>
|
281
291
|
</dl>
|
282
292
|
|
283
|
-
#### ⚙️ Parameters
|
284
|
-
|
285
293
|
<dl>
|
286
294
|
<dd>
|
287
295
|
|
296
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
297
|
+
|
298
|
+
</dd>
|
299
|
+
</dl>
|
300
|
+
|
288
301
|
<dl>
|
289
302
|
<dd>
|
290
303
|
|
291
|
-
**
|
304
|
+
**requestOptions:** `Windows.RequestOptions`
|
305
|
+
|
306
|
+
</dd>
|
307
|
+
</dl>
|
308
|
+
</dd>
|
309
|
+
</dl>
|
292
310
|
|
293
311
|
</dd>
|
294
312
|
</dl>
|
313
|
+
</details>
|
295
314
|
|
315
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
296
316
|
<dl>
|
297
317
|
<dd>
|
298
318
|
|
299
|
-
|
319
|
+
#### 🔌 Usage
|
320
|
+
|
321
|
+
<dl>
|
322
|
+
<dd>
|
323
|
+
|
324
|
+
<dl>
|
325
|
+
<dd>
|
326
|
+
|
327
|
+
```typescript
|
328
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
329
|
+
```
|
300
330
|
|
301
331
|
</dd>
|
302
332
|
</dl>
|
303
333
|
</dd>
|
304
334
|
</dl>
|
305
335
|
|
336
|
+
#### ⚙️ Parameters
|
337
|
+
|
338
|
+
<dl>
|
339
|
+
<dd>
|
340
|
+
|
341
|
+
<dl>
|
342
|
+
<dd>
|
343
|
+
|
344
|
+
**sessionId:** `string` — The session id for the window.
|
345
|
+
|
306
346
|
</dd>
|
307
347
|
</dl>
|
308
|
-
</details>
|
309
348
|
|
310
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">terminate</a>(id) -> void</code></summary>
|
311
349
|
<dl>
|
312
350
|
<dd>
|
313
351
|
|
314
|
-
|
352
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
353
|
+
|
354
|
+
</dd>
|
355
|
+
</dl>
|
315
356
|
|
316
357
|
<dl>
|
317
358
|
<dd>
|
318
359
|
|
360
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
361
|
+
|
362
|
+
</dd>
|
363
|
+
</dl>
|
364
|
+
|
319
365
|
<dl>
|
320
366
|
<dd>
|
321
367
|
|
322
|
-
|
368
|
+
**requestOptions:** `Windows.RequestOptions`
|
323
369
|
|
324
370
|
</dd>
|
325
371
|
</dl>
|
326
372
|
</dd>
|
327
373
|
</dl>
|
328
374
|
|
375
|
+
</dd>
|
376
|
+
</dl>
|
377
|
+
</details>
|
378
|
+
|
379
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
380
|
+
<dl>
|
381
|
+
<dd>
|
382
|
+
|
329
383
|
#### 🔌 Usage
|
330
384
|
|
331
385
|
<dl>
|
@@ -335,7 +389,9 @@ Ends a session by ID. If a given session id does not exist within the organizati
|
|
335
389
|
<dd>
|
336
390
|
|
337
391
|
```typescript
|
338
|
-
await client.
|
392
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
393
|
+
prompt: "What is the main idea of this page?",
|
394
|
+
});
|
339
395
|
```
|
340
396
|
|
341
397
|
</dd>
|
@@ -351,7 +407,7 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
351
407
|
<dl>
|
352
408
|
<dd>
|
353
409
|
|
354
|
-
**
|
410
|
+
**sessionId:** `string` — The session id for the window.
|
355
411
|
|
356
412
|
</dd>
|
357
413
|
</dl>
|
@@ -359,7 +415,23 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
359
415
|
<dl>
|
360
416
|
<dd>
|
361
417
|
|
362
|
-
**
|
418
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
419
|
+
|
420
|
+
</dd>
|
421
|
+
</dl>
|
422
|
+
|
423
|
+
<dl>
|
424
|
+
<dd>
|
425
|
+
|
426
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
427
|
+
|
428
|
+
</dd>
|
429
|
+
</dl>
|
430
|
+
|
431
|
+
<dl>
|
432
|
+
<dd>
|
433
|
+
|
434
|
+
**requestOptions:** `Windows.RequestOptions`
|
363
435
|
|
364
436
|
</dd>
|
365
437
|
</dl>
|
@@ -370,7 +442,7 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
370
442
|
</dl>
|
371
443
|
</details>
|
372
444
|
|
373
|
-
<details><summary><code>client.
|
445
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
374
446
|
<dl>
|
375
447
|
<dd>
|
376
448
|
|
@@ -382,7 +454,7 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
382
454
|
<dl>
|
383
455
|
<dd>
|
384
456
|
|
385
|
-
|
457
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
386
458
|
|
387
459
|
</dd>
|
388
460
|
</dl>
|
@@ -398,7 +470,9 @@ Get a session event stream for a given session ID
|
|
398
470
|
<dd>
|
399
471
|
|
400
472
|
```typescript
|
401
|
-
await client.
|
473
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
474
|
+
prompt: "What is the main idea of this page?",
|
475
|
+
});
|
402
476
|
```
|
403
477
|
|
404
478
|
</dd>
|
@@ -414,7 +488,7 @@ await client.sessions.events("string");
|
|
414
488
|
<dl>
|
415
489
|
<dd>
|
416
490
|
|
417
|
-
**
|
491
|
+
**sessionId:** `string` — The session id for the window.
|
418
492
|
|
419
493
|
</dd>
|
420
494
|
</dl>
|
@@ -422,20 +496,34 @@ await client.sessions.events("string");
|
|
422
496
|
<dl>
|
423
497
|
<dd>
|
424
498
|
|
425
|
-
**
|
499
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
426
500
|
|
427
501
|
</dd>
|
428
502
|
</dl>
|
503
|
+
|
504
|
+
<dl>
|
505
|
+
<dd>
|
506
|
+
|
507
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
508
|
+
|
429
509
|
</dd>
|
430
510
|
</dl>
|
431
511
|
|
512
|
+
<dl>
|
513
|
+
<dd>
|
514
|
+
|
515
|
+
**requestOptions:** `Windows.RequestOptions`
|
516
|
+
|
517
|
+
</dd>
|
518
|
+
</dl>
|
432
519
|
</dd>
|
433
520
|
</dl>
|
434
|
-
</details>
|
435
521
|
|
436
|
-
|
522
|
+
</dd>
|
523
|
+
</dl>
|
524
|
+
</details>
|
437
525
|
|
438
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
526
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
439
527
|
<dl>
|
440
528
|
<dd>
|
441
529
|
|
@@ -448,7 +536,7 @@ await client.sessions.events("string");
|
|
448
536
|
<dd>
|
449
537
|
|
450
538
|
```typescript
|
451
|
-
await client.windows.
|
539
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
452
540
|
```
|
453
541
|
|
454
542
|
</dd>
|
@@ -464,7 +552,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
464
552
|
<dl>
|
465
553
|
<dd>
|
466
554
|
|
467
|
-
**sessionId:** `string` —
|
555
|
+
**sessionId:** `string` — The session id for the window.
|
468
556
|
|
469
557
|
</dd>
|
470
558
|
</dl>
|
@@ -472,7 +560,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
472
560
|
<dl>
|
473
561
|
<dd>
|
474
562
|
|
475
|
-
**
|
563
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
564
|
+
|
565
|
+
</dd>
|
566
|
+
</dl>
|
567
|
+
|
568
|
+
<dl>
|
569
|
+
<dd>
|
570
|
+
|
571
|
+
**request:** `Airtop.ScrapeContentRequest`
|
476
572
|
|
477
573
|
</dd>
|
478
574
|
</dl>
|
@@ -491,10 +587,25 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
491
587
|
</dl>
|
492
588
|
</details>
|
493
589
|
|
494
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
590
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
591
|
+
<dl>
|
592
|
+
<dd>
|
593
|
+
|
594
|
+
#### 📝 Description
|
595
|
+
|
596
|
+
<dl>
|
597
|
+
<dd>
|
598
|
+
|
495
599
|
<dl>
|
496
600
|
<dd>
|
497
601
|
|
602
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
603
|
+
|
604
|
+
</dd>
|
605
|
+
</dl>
|
606
|
+
</dd>
|
607
|
+
</dl>
|
608
|
+
|
498
609
|
#### 🔌 Usage
|
499
610
|
|
500
611
|
<dl>
|
@@ -504,9 +615,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
504
615
|
<dd>
|
505
616
|
|
506
617
|
```typescript
|
507
|
-
await client.windows.
|
508
|
-
screenResolution: "1280x720",
|
509
|
-
});
|
618
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
510
619
|
```
|
511
620
|
|
512
621
|
</dd>
|
@@ -522,7 +631,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
522
631
|
<dl>
|
523
632
|
<dd>
|
524
633
|
|
525
|
-
**sessionId:** `string` —
|
634
|
+
**sessionId:** `string` — The session id for the window.
|
526
635
|
|
527
636
|
</dd>
|
528
637
|
</dl>
|
@@ -530,7 +639,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
530
639
|
<dl>
|
531
640
|
<dd>
|
532
641
|
|
533
|
-
**windowId:** `string` —
|
642
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
534
643
|
|
535
644
|
</dd>
|
536
645
|
</dl>
|
@@ -538,7 +647,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
538
647
|
<dl>
|
539
648
|
<dd>
|
540
649
|
|
541
|
-
**request:** `Airtop.
|
650
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
542
651
|
|
543
652
|
</dd>
|
544
653
|
</dl>
|
@@ -557,7 +666,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
557
666
|
</dl>
|
558
667
|
</details>
|
559
668
|
|
560
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
669
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
561
670
|
<dl>
|
562
671
|
<dd>
|
563
672
|
|
@@ -570,8 +679,8 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
570
679
|
<dd>
|
571
680
|
|
572
681
|
```typescript
|
573
|
-
await client.windows.
|
574
|
-
|
682
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
683
|
+
text: "Example text",
|
575
684
|
});
|
576
685
|
```
|
577
686
|
|
@@ -588,7 +697,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
588
697
|
<dl>
|
589
698
|
<dd>
|
590
699
|
|
591
|
-
**sessionId:** `string` —
|
700
|
+
**sessionId:** `string` — The session id for the window.
|
592
701
|
|
593
702
|
</dd>
|
594
703
|
</dl>
|
@@ -596,7 +705,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
596
705
|
<dl>
|
597
706
|
<dd>
|
598
707
|
|
599
|
-
**windowId:** `string` — Airtop window
|
708
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
600
709
|
|
601
710
|
</dd>
|
602
711
|
</dl>
|
@@ -604,7 +713,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
604
713
|
<dl>
|
605
714
|
<dd>
|
606
715
|
|
607
|
-
**request:** `Airtop.
|
716
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
608
717
|
|
609
718
|
</dd>
|
610
719
|
</dl>
|
@@ -623,11 +732,13 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
623
732
|
</dl>
|
624
733
|
</details>
|
625
734
|
|
626
|
-
|
735
|
+
## Profiles
|
736
|
+
|
737
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">get</a>({ ...params }) -> Airtop.ProfilesResponse</code></summary>
|
627
738
|
<dl>
|
628
739
|
<dd>
|
629
740
|
|
630
|
-
####
|
741
|
+
#### 📝 Description
|
631
742
|
|
632
743
|
<dl>
|
633
744
|
<dd>
|
@@ -635,16 +746,14 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
635
746
|
<dl>
|
636
747
|
<dd>
|
637
748
|
|
638
|
-
|
639
|
-
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
640
|
-
```
|
749
|
+
Get profiles matching by id
|
641
750
|
|
642
751
|
</dd>
|
643
752
|
</dl>
|
644
753
|
</dd>
|
645
754
|
</dl>
|
646
755
|
|
647
|
-
####
|
756
|
+
#### 🔌 Usage
|
648
757
|
|
649
758
|
<dl>
|
650
759
|
<dd>
|
@@ -652,15 +761,24 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
652
761
|
<dl>
|
653
762
|
<dd>
|
654
763
|
|
655
|
-
|
764
|
+
```typescript
|
765
|
+
await client.profiles.get();
|
766
|
+
```
|
656
767
|
|
657
768
|
</dd>
|
658
769
|
</dl>
|
770
|
+
</dd>
|
771
|
+
</dl>
|
772
|
+
|
773
|
+
#### ⚙️ Parameters
|
659
774
|
|
660
775
|
<dl>
|
661
776
|
<dd>
|
662
777
|
|
663
|
-
|
778
|
+
<dl>
|
779
|
+
<dd>
|
780
|
+
|
781
|
+
**request:** `Airtop.ProfilesGetRequest`
|
664
782
|
|
665
783
|
</dd>
|
666
784
|
</dl>
|
@@ -668,7 +786,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
668
786
|
<dl>
|
669
787
|
<dd>
|
670
788
|
|
671
|
-
**requestOptions:** `
|
789
|
+
**requestOptions:** `Profiles.RequestOptions`
|
672
790
|
|
673
791
|
</dd>
|
674
792
|
</dl>
|
@@ -679,11 +797,11 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
679
797
|
</dl>
|
680
798
|
</details>
|
681
799
|
|
682
|
-
<details><summary><code>client.
|
800
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
683
801
|
<dl>
|
684
802
|
<dd>
|
685
803
|
|
686
|
-
####
|
804
|
+
#### 📝 Description
|
687
805
|
|
688
806
|
<dl>
|
689
807
|
<dd>
|
@@ -691,18 +809,14 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
691
809
|
<dl>
|
692
810
|
<dd>
|
693
811
|
|
694
|
-
|
695
|
-
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
696
|
-
prompt: "What is the main idea of this page?",
|
697
|
-
});
|
698
|
-
```
|
812
|
+
Delete profiles matching by id
|
699
813
|
|
700
814
|
</dd>
|
701
815
|
</dl>
|
702
816
|
</dd>
|
703
817
|
</dl>
|
704
818
|
|
705
|
-
####
|
819
|
+
#### 🔌 Usage
|
706
820
|
|
707
821
|
<dl>
|
708
822
|
<dd>
|
@@ -710,23 +824,24 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
710
824
|
<dl>
|
711
825
|
<dd>
|
712
826
|
|
713
|
-
|
827
|
+
```typescript
|
828
|
+
await client.profiles.delete();
|
829
|
+
```
|
714
830
|
|
831
|
+
</dd>
|
832
|
+
</dl>
|
715
833
|
</dd>
|
716
834
|
</dl>
|
717
835
|
|
836
|
+
#### ⚙️ Parameters
|
837
|
+
|
718
838
|
<dl>
|
719
839
|
<dd>
|
720
840
|
|
721
|
-
**windowId:** `string` — The Airtop window id of the browser window to target with an Airtop AI prompt.
|
722
|
-
|
723
|
-
</dd>
|
724
|
-
</dl>
|
725
|
-
|
726
841
|
<dl>
|
727
842
|
<dd>
|
728
843
|
|
729
|
-
**request:** `Airtop.
|
844
|
+
**request:** `Airtop.ProfilesDeleteRequest`
|
730
845
|
|
731
846
|
</dd>
|
732
847
|
</dl>
|
@@ -734,7 +849,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
734
849
|
<dl>
|
735
850
|
<dd>
|
736
851
|
|
737
|
-
**requestOptions:** `
|
852
|
+
**requestOptions:** `Profiles.RequestOptions`
|
738
853
|
|
739
854
|
</dd>
|
740
855
|
</dl>
|
@@ -745,7 +860,9 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
745
860
|
</dl>
|
746
861
|
</details>
|
747
862
|
|
748
|
-
|
863
|
+
## Sessions
|
864
|
+
|
865
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
|
749
866
|
<dl>
|
750
867
|
<dd>
|
751
868
|
|
@@ -757,7 +874,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
757
874
|
<dl>
|
758
875
|
<dd>
|
759
876
|
|
760
|
-
|
877
|
+
Get a list of sessions by ID
|
761
878
|
|
762
879
|
</dd>
|
763
880
|
</dl>
|
@@ -773,8 +890,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
773
890
|
<dd>
|
774
891
|
|
775
892
|
```typescript
|
776
|
-
await client.
|
777
|
-
|
893
|
+
await client.sessions.list({
|
894
|
+
offset: 1,
|
895
|
+
limit: 10,
|
778
896
|
});
|
779
897
|
```
|
780
898
|
|
@@ -791,23 +909,55 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
791
909
|
<dl>
|
792
910
|
<dd>
|
793
911
|
|
794
|
-
**
|
912
|
+
**request:** `Airtop.SessionsListRequest`
|
913
|
+
|
914
|
+
</dd>
|
915
|
+
</dl>
|
916
|
+
|
917
|
+
<dl>
|
918
|
+
<dd>
|
919
|
+
|
920
|
+
**requestOptions:** `Sessions.RequestOptions`
|
921
|
+
|
922
|
+
</dd>
|
923
|
+
</dl>
|
924
|
+
</dd>
|
925
|
+
</dl>
|
795
926
|
|
796
927
|
</dd>
|
797
928
|
</dl>
|
929
|
+
</details>
|
930
|
+
|
931
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">create</a>({ ...params }) -> Airtop.SessionResponse</code></summary>
|
932
|
+
<dl>
|
933
|
+
<dd>
|
934
|
+
|
935
|
+
#### 🔌 Usage
|
936
|
+
|
937
|
+
<dl>
|
938
|
+
<dd>
|
798
939
|
|
799
940
|
<dl>
|
800
941
|
<dd>
|
801
942
|
|
802
|
-
|
943
|
+
```typescript
|
944
|
+
await client.sessions.create();
|
945
|
+
```
|
803
946
|
|
804
947
|
</dd>
|
805
948
|
</dl>
|
949
|
+
</dd>
|
950
|
+
</dl>
|
951
|
+
|
952
|
+
#### ⚙️ Parameters
|
806
953
|
|
807
954
|
<dl>
|
808
955
|
<dd>
|
809
956
|
|
810
|
-
|
957
|
+
<dl>
|
958
|
+
<dd>
|
959
|
+
|
960
|
+
**request:** `Airtop.SessionRestInputV1`
|
811
961
|
|
812
962
|
</dd>
|
813
963
|
</dl>
|
@@ -815,7 +965,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
815
965
|
<dl>
|
816
966
|
<dd>
|
817
967
|
|
818
|
-
**requestOptions:** `
|
968
|
+
**requestOptions:** `Sessions.RequestOptions`
|
819
969
|
|
820
970
|
</dd>
|
821
971
|
</dl>
|
@@ -826,11 +976,11 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
826
976
|
</dl>
|
827
977
|
</details>
|
828
978
|
|
829
|
-
<details><summary><code>client.
|
979
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getInfo</a>(id) -> Airtop.SessionResponse</code></summary>
|
830
980
|
<dl>
|
831
981
|
<dd>
|
832
982
|
|
833
|
-
####
|
983
|
+
#### 📝 Description
|
834
984
|
|
835
985
|
<dl>
|
836
986
|
<dd>
|
@@ -838,16 +988,14 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
838
988
|
<dl>
|
839
989
|
<dd>
|
840
990
|
|
841
|
-
|
842
|
-
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
843
|
-
```
|
991
|
+
Get a session by ID
|
844
992
|
|
845
993
|
</dd>
|
846
994
|
</dl>
|
847
995
|
</dd>
|
848
996
|
</dl>
|
849
997
|
|
850
|
-
####
|
998
|
+
#### 🔌 Usage
|
851
999
|
|
852
1000
|
<dl>
|
853
1001
|
<dd>
|
@@ -855,23 +1003,24 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
855
1003
|
<dl>
|
856
1004
|
<dd>
|
857
1005
|
|
858
|
-
|
1006
|
+
```typescript
|
1007
|
+
await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
1008
|
+
```
|
859
1009
|
|
860
1010
|
</dd>
|
861
1011
|
</dl>
|
1012
|
+
</dd>
|
1013
|
+
</dl>
|
1014
|
+
|
1015
|
+
#### ⚙️ Parameters
|
862
1016
|
|
863
1017
|
<dl>
|
864
1018
|
<dd>
|
865
1019
|
|
866
|
-
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
867
|
-
|
868
|
-
</dd>
|
869
|
-
</dl>
|
870
|
-
|
871
1020
|
<dl>
|
872
1021
|
<dd>
|
873
1022
|
|
874
|
-
**
|
1023
|
+
**id:** `string` — Id of the session to get
|
875
1024
|
|
876
1025
|
</dd>
|
877
1026
|
</dl>
|
@@ -879,7 +1028,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
879
1028
|
<dl>
|
880
1029
|
<dd>
|
881
1030
|
|
882
|
-
**requestOptions:** `
|
1031
|
+
**requestOptions:** `Sessions.RequestOptions`
|
883
1032
|
|
884
1033
|
</dd>
|
885
1034
|
</dl>
|
@@ -890,7 +1039,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
890
1039
|
</dl>
|
891
1040
|
</details>
|
892
1041
|
|
893
|
-
<details><summary><code>client.
|
1042
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">terminate</a>(id) -> void</code></summary>
|
894
1043
|
<dl>
|
895
1044
|
<dd>
|
896
1045
|
|
@@ -902,7 +1051,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
902
1051
|
<dl>
|
903
1052
|
<dd>
|
904
1053
|
|
905
|
-
|
1054
|
+
Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
|
906
1055
|
|
907
1056
|
</dd>
|
908
1057
|
</dl>
|
@@ -918,7 +1067,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
918
1067
|
<dd>
|
919
1068
|
|
920
1069
|
```typescript
|
921
|
-
await client.
|
1070
|
+
await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
922
1071
|
```
|
923
1072
|
|
924
1073
|
</dd>
|
@@ -934,7 +1083,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
934
1083
|
<dl>
|
935
1084
|
<dd>
|
936
1085
|
|
937
|
-
**
|
1086
|
+
**id:** `string` — ID of the session to delete.
|
938
1087
|
|
939
1088
|
</dd>
|
940
1089
|
</dl>
|
@@ -942,23 +1091,70 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
942
1091
|
<dl>
|
943
1092
|
<dd>
|
944
1093
|
|
945
|
-
**
|
1094
|
+
**requestOptions:** `Sessions.RequestOptions`
|
946
1095
|
|
947
1096
|
</dd>
|
948
1097
|
</dl>
|
1098
|
+
</dd>
|
1099
|
+
</dl>
|
1100
|
+
|
1101
|
+
</dd>
|
1102
|
+
</dl>
|
1103
|
+
</details>
|
1104
|
+
|
1105
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">events</a>(id) -> core.Stream<Airtop.SessionsEventsResponse></code></summary>
|
1106
|
+
<dl>
|
1107
|
+
<dd>
|
1108
|
+
|
1109
|
+
#### 📝 Description
|
949
1110
|
|
950
1111
|
<dl>
|
951
1112
|
<dd>
|
952
1113
|
|
953
|
-
|
1114
|
+
<dl>
|
1115
|
+
<dd>
|
954
1116
|
|
1117
|
+
Get a session event stream for a given session ID
|
1118
|
+
|
1119
|
+
</dd>
|
1120
|
+
</dl>
|
955
1121
|
</dd>
|
956
1122
|
</dl>
|
957
1123
|
|
1124
|
+
#### 🔌 Usage
|
1125
|
+
|
958
1126
|
<dl>
|
959
1127
|
<dd>
|
960
1128
|
|
961
|
-
|
1129
|
+
<dl>
|
1130
|
+
<dd>
|
1131
|
+
|
1132
|
+
```typescript
|
1133
|
+
await client.sessions.events("string");
|
1134
|
+
```
|
1135
|
+
|
1136
|
+
</dd>
|
1137
|
+
</dl>
|
1138
|
+
</dd>
|
1139
|
+
</dl>
|
1140
|
+
|
1141
|
+
#### ⚙️ Parameters
|
1142
|
+
|
1143
|
+
<dl>
|
1144
|
+
<dd>
|
1145
|
+
|
1146
|
+
<dl>
|
1147
|
+
<dd>
|
1148
|
+
|
1149
|
+
**id:** `string` — ID of the session to get status info for
|
1150
|
+
|
1151
|
+
</dd>
|
1152
|
+
</dl>
|
1153
|
+
|
1154
|
+
<dl>
|
1155
|
+
<dd>
|
1156
|
+
|
1157
|
+
**requestOptions:** `Sessions.RequestOptions`
|
962
1158
|
|
963
1159
|
</dd>
|
964
1160
|
</dl>
|