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