@airtop/sdk 0.1.13 → 0.1.15-beta0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (271) hide show
  1. package/Client.d.ts +3 -0
  2. package/Client.js +7 -2
  3. package/README.md +8 -6
  4. package/api/resources/index.d.ts +1 -0
  5. package/api/resources/index.js +2 -1
  6. package/api/resources/profiles/client/Client.d.ts +0 -10
  7. package/api/resources/profiles/client/Client.js +2 -82
  8. package/api/resources/profiles/client/requests/index.d.ts +0 -1
  9. package/api/resources/requests/client/Client.d.ts +34 -0
  10. package/api/resources/requests/client/Client.js +115 -0
  11. package/api/resources/requests/client/index.d.ts +1 -0
  12. package/api/resources/requests/client/index.js +2 -0
  13. package/api/resources/requests/index.d.ts +1 -0
  14. package/api/resources/requests/index.js +17 -0
  15. package/api/resources/sessions/client/Client.js +12 -12
  16. package/api/resources/windows/client/Client.d.ts +148 -0
  17. package/api/resources/windows/client/Client.js +737 -24
  18. package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
  19. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +25 -0
  20. package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
  21. package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
  22. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +25 -0
  23. package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
  24. package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
  25. package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
  26. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
  27. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
  28. package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
  29. package/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
  30. package/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +25 -0
  31. package/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +5 -0
  32. package/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +21 -0
  33. package/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +5 -0
  34. package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +4 -0
  35. package/api/resources/windows/client/requests/index.d.ts +11 -0
  36. package/api/types/AsyncConfig.d.ts +7 -0
  37. package/api/types/AsyncConfig.js +5 -0
  38. package/api/types/{ProfilesResponse.d.ts → AsyncSessionAiResponseEnvelope.d.ts} +2 -3
  39. package/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
  40. package/api/types/BrowserWaitSelectorConfig.d.ts +11 -0
  41. package/api/types/BrowserWaitSelectorConfig.js +5 -0
  42. package/api/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  43. package/api/types/IntervalMonitorConfig.d.ts +9 -0
  44. package/api/types/IntervalMonitorConfig.js +5 -0
  45. package/api/types/MonitorConfig.d.ts +14 -0
  46. package/api/types/MonitorConfig.js +5 -0
  47. package/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +12 -0
  48. package/api/types/MonitorConfigIncludeVisualAnalysis.js +11 -0
  49. package/api/types/MonitorConfigMonitorType.d.ts +11 -0
  50. package/api/types/MonitorConfigMonitorType.js +10 -0
  51. package/api/types/RequestStatusResponse.d.ts +8 -0
  52. package/api/types/RequestStatusResponse.js +5 -0
  53. package/api/types/ScreenshotConfig.d.ts +13 -0
  54. package/api/types/ScreenshotConfig.js +5 -0
  55. package/api/types/ScreenshotMetadata.d.ts +7 -0
  56. package/api/types/ScreenshotMetadata.js +5 -0
  57. package/api/types/ScreenshotRequestConfig.d.ts +8 -0
  58. package/api/types/ScreenshotRequestConfig.js +5 -0
  59. package/api/types/VisualAnalysisConfig.d.ts +5 -1
  60. package/api/types/VisualAnalysisConfigScope.d.ts +4 -2
  61. package/api/types/VisualAnalysisConfigScope.js +2 -0
  62. package/api/types/index.d.ts +11 -2
  63. package/api/types/index.js +11 -2
  64. package/dist/Client.d.ts +3 -0
  65. package/dist/Client.js +7 -2
  66. package/dist/api/resources/index.d.ts +1 -0
  67. package/dist/api/resources/index.js +2 -1
  68. package/dist/api/resources/profiles/client/Client.d.ts +0 -10
  69. package/dist/api/resources/profiles/client/Client.js +2 -82
  70. package/dist/api/resources/profiles/client/requests/index.d.ts +0 -1
  71. package/dist/api/resources/requests/client/Client.d.ts +34 -0
  72. package/dist/api/resources/requests/client/Client.js +115 -0
  73. package/dist/api/resources/requests/client/index.d.ts +1 -0
  74. package/dist/api/resources/requests/client/index.js +2 -0
  75. package/dist/api/resources/requests/index.d.ts +1 -0
  76. package/dist/api/resources/requests/index.js +17 -0
  77. package/dist/api/resources/sessions/client/Client.js +12 -12
  78. package/dist/api/resources/windows/client/Client.d.ts +148 -0
  79. package/dist/api/resources/windows/client/Client.js +737 -24
  80. package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
  81. package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
  82. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +25 -0
  83. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
  84. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
  85. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
  86. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
  87. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
  88. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +25 -0
  89. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
  90. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
  91. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
  92. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
  93. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
  94. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
  95. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
  96. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
  97. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
  98. package/dist/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +25 -0
  99. package/dist/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +5 -0
  100. package/dist/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +21 -0
  101. package/dist/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +5 -0
  102. package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +4 -0
  103. package/dist/api/resources/windows/client/requests/index.d.ts +11 -0
  104. package/dist/api/types/AsyncConfig.d.ts +7 -0
  105. package/dist/api/types/AsyncConfig.js +5 -0
  106. package/dist/api/types/{ProfilesResponse.d.ts → AsyncSessionAiResponseEnvelope.d.ts} +2 -3
  107. package/dist/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
  108. package/dist/api/types/BrowserWaitSelectorConfig.d.ts +11 -0
  109. package/dist/api/types/BrowserWaitSelectorConfig.js +5 -0
  110. package/dist/api/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  111. package/dist/api/types/IntervalMonitorConfig.d.ts +9 -0
  112. package/dist/api/types/IntervalMonitorConfig.js +5 -0
  113. package/dist/api/types/MonitorConfig.d.ts +14 -0
  114. package/dist/api/types/MonitorConfig.js +5 -0
  115. package/dist/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +12 -0
  116. package/dist/api/types/MonitorConfigIncludeVisualAnalysis.js +11 -0
  117. package/dist/api/types/MonitorConfigMonitorType.d.ts +11 -0
  118. package/dist/api/types/MonitorConfigMonitorType.js +10 -0
  119. package/dist/api/types/RequestStatusResponse.d.ts +8 -0
  120. package/dist/api/types/RequestStatusResponse.js +5 -0
  121. package/dist/api/types/ScreenshotConfig.d.ts +13 -0
  122. package/dist/api/types/ScreenshotConfig.js +5 -0
  123. package/dist/api/types/ScreenshotMetadata.d.ts +7 -0
  124. package/dist/api/types/ScreenshotMetadata.js +5 -0
  125. package/dist/api/types/ScreenshotRequestConfig.d.ts +8 -0
  126. package/dist/api/types/ScreenshotRequestConfig.js +5 -0
  127. package/dist/api/types/VisualAnalysisConfig.d.ts +5 -1
  128. package/dist/api/types/VisualAnalysisConfigScope.d.ts +4 -2
  129. package/dist/api/types/VisualAnalysisConfigScope.js +2 -0
  130. package/dist/api/types/index.d.ts +11 -2
  131. package/dist/api/types/index.js +11 -2
  132. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
  133. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
  134. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
  135. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
  136. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +20 -0
  137. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +41 -0
  138. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
  139. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
  140. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
  141. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
  142. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
  143. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
  144. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
  145. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
  146. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
  147. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
  148. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
  149. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
  150. package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +18 -0
  151. package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +39 -0
  152. package/dist/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +16 -0
  153. package/dist/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +37 -0
  154. package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +2 -0
  155. package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +2 -0
  156. package/dist/serialization/resources/windows/client/requests/index.d.ts +11 -0
  157. package/dist/serialization/resources/windows/client/requests/index.js +23 -1
  158. package/dist/serialization/types/AsyncConfig.d.ts +12 -0
  159. package/dist/serialization/types/{ExternalProfileV1.js → AsyncConfig.js} +3 -5
  160. package/dist/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
  161. package/dist/serialization/types/{ProfilesResponse.js → AsyncSessionAiResponseEnvelope.js} +3 -6
  162. package/dist/serialization/types/BrowserWaitSelectorConfig.d.ts +14 -0
  163. package/dist/serialization/types/BrowserWaitSelectorConfig.js +35 -0
  164. package/dist/serialization/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  165. package/dist/serialization/types/ExternalSessionAiResponseMetadata.js +2 -0
  166. package/dist/serialization/types/IntervalMonitorConfig.d.ts +13 -0
  167. package/{serialization/types/ExternalProfileV1.js → dist/serialization/types/IntervalMonitorConfig.js} +4 -5
  168. package/dist/serialization/types/MonitorConfig.d.ts +19 -0
  169. package/dist/serialization/types/MonitorConfig.js +40 -0
  170. package/dist/serialization/types/MonitorConfigIncludeVisualAnalysis.d.ts +10 -0
  171. package/dist/serialization/types/MonitorConfigIncludeVisualAnalysis.js +31 -0
  172. package/dist/serialization/types/MonitorConfigMonitorType.d.ts +10 -0
  173. package/dist/serialization/types/MonitorConfigMonitorType.js +31 -0
  174. package/dist/serialization/types/RequestStatusResponse.d.ts +13 -0
  175. package/dist/serialization/types/RequestStatusResponse.js +34 -0
  176. package/dist/serialization/types/ScreenshotConfig.d.ts +15 -0
  177. package/dist/serialization/types/ScreenshotConfig.js +36 -0
  178. package/dist/serialization/types/ScreenshotMetadata.d.ts +12 -0
  179. package/dist/serialization/types/ScreenshotMetadata.js +33 -0
  180. package/dist/serialization/types/ScreenshotRequestConfig.d.ts +13 -0
  181. package/dist/serialization/types/ScreenshotRequestConfig.js +34 -0
  182. package/dist/serialization/types/VisualAnalysisConfig.d.ts +2 -0
  183. package/dist/serialization/types/VisualAnalysisConfig.js +2 -0
  184. package/dist/serialization/types/VisualAnalysisConfigScope.d.ts +1 -1
  185. package/dist/serialization/types/VisualAnalysisConfigScope.js +1 -1
  186. package/dist/serialization/types/index.d.ts +11 -2
  187. package/dist/serialization/types/index.js +11 -2
  188. package/dist/utils/index.d.ts +1 -0
  189. package/dist/utils/index.js +1 -0
  190. package/dist/utils/process-screenshots.d.ts +10 -0
  191. package/dist/utils/process-screenshots.js +59 -0
  192. package/dist/wrapper/AirtopWindows.d.ts +10 -0
  193. package/dist/wrapper/AirtopWindows.js +17 -0
  194. package/package.json +1 -1
  195. package/reference.md +982 -48
  196. package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
  197. package/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
  198. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
  199. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
  200. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +20 -0
  201. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +41 -0
  202. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
  203. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
  204. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
  205. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
  206. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
  207. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
  208. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
  209. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
  210. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
  211. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
  212. package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
  213. package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
  214. package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +18 -0
  215. package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +39 -0
  216. package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +16 -0
  217. package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +37 -0
  218. package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +2 -0
  219. package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +2 -0
  220. package/serialization/resources/windows/client/requests/index.d.ts +11 -0
  221. package/serialization/resources/windows/client/requests/index.js +23 -1
  222. package/serialization/types/AsyncConfig.d.ts +12 -0
  223. package/serialization/types/AsyncConfig.js +33 -0
  224. package/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
  225. package/serialization/types/{ProfilesResponse.js → AsyncSessionAiResponseEnvelope.js} +3 -6
  226. package/serialization/types/BrowserWaitSelectorConfig.d.ts +14 -0
  227. package/serialization/types/BrowserWaitSelectorConfig.js +35 -0
  228. package/serialization/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  229. package/serialization/types/ExternalSessionAiResponseMetadata.js +2 -0
  230. package/serialization/types/IntervalMonitorConfig.d.ts +13 -0
  231. package/serialization/types/IntervalMonitorConfig.js +34 -0
  232. package/serialization/types/MonitorConfig.d.ts +19 -0
  233. package/serialization/types/MonitorConfig.js +40 -0
  234. package/serialization/types/MonitorConfigIncludeVisualAnalysis.d.ts +10 -0
  235. package/serialization/types/MonitorConfigIncludeVisualAnalysis.js +31 -0
  236. package/serialization/types/MonitorConfigMonitorType.d.ts +10 -0
  237. package/serialization/types/MonitorConfigMonitorType.js +31 -0
  238. package/serialization/types/RequestStatusResponse.d.ts +13 -0
  239. package/serialization/types/RequestStatusResponse.js +34 -0
  240. package/serialization/types/ScreenshotConfig.d.ts +15 -0
  241. package/serialization/types/ScreenshotConfig.js +36 -0
  242. package/serialization/types/ScreenshotMetadata.d.ts +12 -0
  243. package/serialization/types/ScreenshotMetadata.js +33 -0
  244. package/serialization/types/ScreenshotRequestConfig.d.ts +13 -0
  245. package/serialization/types/ScreenshotRequestConfig.js +34 -0
  246. package/serialization/types/VisualAnalysisConfig.d.ts +2 -0
  247. package/serialization/types/VisualAnalysisConfig.js +2 -0
  248. package/serialization/types/VisualAnalysisConfigScope.d.ts +1 -1
  249. package/serialization/types/VisualAnalysisConfigScope.js +1 -1
  250. package/serialization/types/index.d.ts +11 -2
  251. package/serialization/types/index.js +11 -2
  252. package/utils/index.d.ts +1 -0
  253. package/utils/index.js +1 -0
  254. package/utils/process-screenshots.d.ts +10 -0
  255. package/utils/process-screenshots.js +59 -0
  256. package/wrapper/AirtopWindows.d.ts +10 -0
  257. package/wrapper/AirtopWindows.js +17 -0
  258. package/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +0 -17
  259. package/api/types/ExternalProfileV1.d.ts +0 -11
  260. package/dist/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +0 -17
  261. package/dist/api/types/ExternalProfileV1.d.ts +0 -11
  262. package/dist/serialization/types/ExternalProfileV1.d.ts +0 -14
  263. package/dist/serialization/types/ProfilesResponse.d.ts +0 -18
  264. package/serialization/types/ExternalProfileV1.d.ts +0 -14
  265. package/serialization/types/ProfilesResponse.d.ts +0 -18
  266. /package/api/resources/{profiles/client/requests/ProfilesGetRequest.js → windows/client/requests/AsyncClickRequest.js} +0 -0
  267. /package/api/{types/ExternalProfileV1.js → resources/windows/client/requests/AsyncHoverRequest.js} +0 -0
  268. /package/api/{types/ProfilesResponse.js → resources/windows/client/requests/AsyncMonitorRequest.js} +0 -0
  269. /package/{dist/api/resources/profiles/client/requests/ProfilesGetRequest.js → api/resources/windows/client/requests/AsyncPageQueryRequest.js} +0 -0
  270. /package/{dist/api/types/ExternalProfileV1.js → api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js} +0 -0
  271. /package/{dist/api/types/ProfilesResponse.js → api/resources/windows/client/requests/AsyncPromptContentRequest.js} +0 -0
package/reference.md CHANGED
@@ -2,10 +2,679 @@
2
2
 
3
3
  ## Windows
4
4
 
5
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncClick</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
6
+ <dl>
7
+ <dd>
8
+
9
+ #### 📝 Description
10
+
11
+ <dl>
12
+ <dd>
13
+
14
+ <dl>
15
+ <dd>
16
+
17
+ Execute a click interaction in a specific browser window asynchronously
18
+
19
+ </dd>
20
+ </dl>
21
+ </dd>
22
+ </dl>
23
+
24
+ #### 🔌 Usage
25
+
26
+ <dl>
27
+ <dd>
28
+
29
+ <dl>
30
+ <dd>
31
+
32
+ ```typescript
33
+ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
34
+ elementDescription: "The login button",
35
+ });
36
+ ```
37
+
38
+ </dd>
39
+ </dl>
40
+ </dd>
41
+ </dl>
42
+
43
+ #### ⚙️ Parameters
44
+
45
+ <dl>
46
+ <dd>
47
+
48
+ <dl>
49
+ <dd>
50
+
51
+ **sessionId:** `string` — The session id for the window.
52
+
53
+ </dd>
54
+ </dl>
55
+
56
+ <dl>
57
+ <dd>
58
+
59
+ **windowId:** `string` — The Airtop window id of the browser window.
60
+
61
+ </dd>
62
+ </dl>
63
+
64
+ <dl>
65
+ <dd>
66
+
67
+ **request:** `Airtop.AsyncClickRequest`
68
+
69
+ </dd>
70
+ </dl>
71
+
72
+ <dl>
73
+ <dd>
74
+
75
+ **requestOptions:** `Windows.RequestOptions`
76
+
77
+ </dd>
78
+ </dl>
79
+ </dd>
80
+ </dl>
81
+
82
+ </dd>
83
+ </dl>
84
+ </details>
85
+
86
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
87
+ <dl>
88
+ <dd>
89
+
90
+ #### 🔌 Usage
91
+
92
+ <dl>
93
+ <dd>
94
+
95
+ <dl>
96
+ <dd>
97
+
98
+ ```typescript
99
+ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
100
+ ```
101
+
102
+ </dd>
103
+ </dl>
104
+ </dd>
105
+ </dl>
106
+
107
+ #### ⚙️ Parameters
108
+
109
+ <dl>
110
+ <dd>
111
+
112
+ <dl>
113
+ <dd>
114
+
115
+ **sessionId:** `string` — The session id for the window.
116
+
117
+ </dd>
118
+ </dl>
119
+
120
+ <dl>
121
+ <dd>
122
+
123
+ **windowId:** `string` — The Airtop window id of the browser window.
124
+
125
+ </dd>
126
+ </dl>
127
+
128
+ <dl>
129
+ <dd>
130
+
131
+ **request:** `Airtop.AsyncHoverRequest`
132
+
133
+ </dd>
134
+ </dl>
135
+
136
+ <dl>
137
+ <dd>
138
+
139
+ **requestOptions:** `Windows.RequestOptions`
140
+
141
+ </dd>
142
+ </dl>
143
+ </dd>
144
+ </dl>
145
+
146
+ </dd>
147
+ </dl>
148
+ </details>
149
+
150
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
151
+ <dl>
152
+ <dd>
153
+
154
+ #### 🔌 Usage
155
+
156
+ <dl>
157
+ <dd>
158
+
159
+ <dl>
160
+ <dd>
161
+
162
+ ```typescript
163
+ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
164
+ ```
165
+
166
+ </dd>
167
+ </dl>
168
+ </dd>
169
+ </dl>
170
+
171
+ #### ⚙️ Parameters
172
+
173
+ <dl>
174
+ <dd>
175
+
176
+ <dl>
177
+ <dd>
178
+
179
+ **sessionId:** `string` — The session id for the window.
180
+
181
+ </dd>
182
+ </dl>
183
+
184
+ <dl>
185
+ <dd>
186
+
187
+ **windowId:** `string` — The Airtop window id of the browser window.
188
+
189
+ </dd>
190
+ </dl>
191
+
192
+ <dl>
193
+ <dd>
194
+
195
+ **request:** `Airtop.AsyncMonitorRequest`
196
+
197
+ </dd>
198
+ </dl>
199
+
200
+ <dl>
201
+ <dd>
202
+
203
+ **requestOptions:** `Windows.RequestOptions`
204
+
205
+ </dd>
206
+ </dl>
207
+ </dd>
208
+ </dl>
209
+
210
+ </dd>
211
+ </dl>
212
+ </details>
213
+
214
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
215
+ <dl>
216
+ <dd>
217
+
218
+ #### 🔌 Usage
219
+
220
+ <dl>
221
+ <dd>
222
+
223
+ <dl>
224
+ <dd>
225
+
226
+ ```typescript
227
+ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
228
+ prompt: "What is the main idea of this page?",
229
+ });
230
+ ```
231
+
232
+ </dd>
233
+ </dl>
234
+ </dd>
235
+ </dl>
236
+
237
+ #### ⚙️ Parameters
238
+
239
+ <dl>
240
+ <dd>
241
+
242
+ <dl>
243
+ <dd>
244
+
245
+ **sessionId:** `string` — The session id for the window.
246
+
247
+ </dd>
248
+ </dl>
249
+
250
+ <dl>
251
+ <dd>
252
+
253
+ **windowId:** `string` — The Airtop window id of the browser window.
254
+
255
+ </dd>
256
+ </dl>
257
+
258
+ <dl>
259
+ <dd>
260
+
261
+ **request:** `Airtop.AsyncPageQueryRequest`
262
+
263
+ </dd>
264
+ </dl>
265
+
266
+ <dl>
267
+ <dd>
268
+
269
+ **requestOptions:** `Windows.RequestOptions`
270
+
271
+ </dd>
272
+ </dl>
273
+ </dd>
274
+ </dl>
275
+
276
+ </dd>
277
+ </dl>
278
+ </details>
279
+
280
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
281
+ <dl>
282
+ <dd>
283
+
284
+ #### 🔌 Usage
285
+
286
+ <dl>
287
+ <dd>
288
+
289
+ <dl>
290
+ <dd>
291
+
292
+ ```typescript
293
+ await client.windows.asyncPaginatedExtraction(
294
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
295
+ "0334da2a-91b0-42c5-6156-76a5eba87430"
296
+ );
297
+ ```
298
+
299
+ </dd>
300
+ </dl>
301
+ </dd>
302
+ </dl>
303
+
304
+ #### ⚙️ Parameters
305
+
306
+ <dl>
307
+ <dd>
308
+
309
+ <dl>
310
+ <dd>
311
+
312
+ **sessionId:** `string` — The session id for the window.
313
+
314
+ </dd>
315
+ </dl>
316
+
317
+ <dl>
318
+ <dd>
319
+
320
+ **windowId:** `string` — The Airtop window id of the browser window.
321
+
322
+ </dd>
323
+ </dl>
324
+
325
+ <dl>
326
+ <dd>
327
+
328
+ **request:** `Airtop.AsyncPaginatedExtractionRequest`
329
+
330
+ </dd>
331
+ </dl>
332
+
333
+ <dl>
334
+ <dd>
335
+
336
+ **requestOptions:** `Windows.RequestOptions`
337
+
338
+ </dd>
339
+ </dl>
340
+ </dd>
341
+ </dl>
342
+
343
+ </dd>
344
+ </dl>
345
+ </details>
346
+
347
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
348
+ <dl>
349
+ <dd>
350
+
351
+ #### 📝 Description
352
+
353
+ <dl>
354
+ <dd>
355
+
356
+ <dl>
357
+ <dd>
358
+
359
+ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
360
+
361
+ </dd>
362
+ </dl>
363
+ </dd>
364
+ </dl>
365
+
366
+ #### 🔌 Usage
367
+
368
+ <dl>
369
+ <dd>
370
+
371
+ <dl>
372
+ <dd>
373
+
374
+ ```typescript
375
+ await client.windows.asyncPromptContent(
376
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
377
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
378
+ {
379
+ prompt: "What is the main idea of this page?",
380
+ }
381
+ );
382
+ ```
383
+
384
+ </dd>
385
+ </dl>
386
+ </dd>
387
+ </dl>
388
+
389
+ #### ⚙️ Parameters
390
+
391
+ <dl>
392
+ <dd>
393
+
394
+ <dl>
395
+ <dd>
396
+
397
+ **sessionId:** `string` — The session id for the window.
398
+
399
+ </dd>
400
+ </dl>
401
+
402
+ <dl>
403
+ <dd>
404
+
405
+ **windowId:** `string` — The Airtop window id of the browser window.
406
+
407
+ </dd>
408
+ </dl>
409
+
410
+ <dl>
411
+ <dd>
412
+
413
+ **request:** `Airtop.AsyncPromptContentRequest`
414
+
415
+ </dd>
416
+ </dl>
417
+
418
+ <dl>
419
+ <dd>
420
+
421
+ **requestOptions:** `Windows.RequestOptions`
422
+
423
+ </dd>
424
+ </dl>
425
+ </dd>
426
+ </dl>
427
+
428
+ </dd>
429
+ </dl>
430
+ </details>
431
+
432
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
433
+ <dl>
434
+ <dd>
435
+
436
+ #### 📝 Description
437
+
438
+ <dl>
439
+ <dd>
440
+
441
+ <dl>
442
+ <dd>
443
+
444
+ Take a screenshot of the current viewport of a browser window asynchronously
445
+
446
+ </dd>
447
+ </dl>
448
+ </dd>
449
+ </dl>
450
+
451
+ #### 🔌 Usage
452
+
453
+ <dl>
454
+ <dd>
455
+
456
+ <dl>
457
+ <dd>
458
+
459
+ ```typescript
460
+ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
461
+ ```
462
+
463
+ </dd>
464
+ </dl>
465
+ </dd>
466
+ </dl>
467
+
468
+ #### ⚙️ Parameters
469
+
470
+ <dl>
471
+ <dd>
472
+
473
+ <dl>
474
+ <dd>
475
+
476
+ **sessionId:** `string` — The session id for the window.
477
+
478
+ </dd>
479
+ </dl>
480
+
481
+ <dl>
482
+ <dd>
483
+
484
+ **windowId:** `string` — The Airtop window id of the browser window.
485
+
486
+ </dd>
487
+ </dl>
488
+
489
+ <dl>
490
+ <dd>
491
+
492
+ **request:** `Airtop.AsyncScreenshotRequest`
493
+
494
+ </dd>
495
+ </dl>
496
+
497
+ <dl>
498
+ <dd>
499
+
500
+ **requestOptions:** `Windows.RequestOptions`
501
+
502
+ </dd>
503
+ </dl>
504
+ </dd>
505
+ </dl>
506
+
507
+ </dd>
508
+ </dl>
509
+ </details>
510
+
511
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
512
+ <dl>
513
+ <dd>
514
+
515
+ #### 📝 Description
516
+
517
+ <dl>
518
+ <dd>
519
+
520
+ <dl>
521
+ <dd>
522
+
523
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
524
+
525
+ </dd>
526
+ </dl>
527
+ </dd>
528
+ </dl>
529
+
530
+ #### 🔌 Usage
531
+
532
+ <dl>
533
+ <dd>
534
+
535
+ <dl>
536
+ <dd>
537
+
538
+ ```typescript
539
+ await client.windows.asyncSummarizeContent(
540
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
541
+ "0334da2a-91b0-42c5-6156-76a5eba87430"
542
+ );
543
+ ```
544
+
545
+ </dd>
546
+ </dl>
547
+ </dd>
548
+ </dl>
549
+
550
+ #### ⚙️ Parameters
551
+
552
+ <dl>
553
+ <dd>
554
+
555
+ <dl>
556
+ <dd>
557
+
558
+ **sessionId:** `string` — The session id for the window.
559
+
560
+ </dd>
561
+ </dl>
562
+
563
+ <dl>
564
+ <dd>
565
+
566
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
567
+
568
+ </dd>
569
+ </dl>
570
+
571
+ <dl>
572
+ <dd>
573
+
574
+ **request:** `Airtop.AsyncSummarizeContentRequest`
575
+
576
+ </dd>
577
+ </dl>
578
+
579
+ <dl>
580
+ <dd>
581
+
582
+ **requestOptions:** `Windows.RequestOptions`
583
+
584
+ </dd>
585
+ </dl>
586
+ </dd>
587
+ </dl>
588
+
589
+ </dd>
590
+ </dl>
591
+ </details>
592
+
593
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
594
+ <dl>
595
+ <dd>
596
+
597
+ #### 🔌 Usage
598
+
599
+ <dl>
600
+ <dd>
601
+
602
+ <dl>
603
+ <dd>
604
+
605
+ ```typescript
606
+ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
607
+ text: "Example text",
608
+ });
609
+ ```
610
+
611
+ </dd>
612
+ </dl>
613
+ </dd>
614
+ </dl>
615
+
616
+ #### ⚙️ Parameters
617
+
618
+ <dl>
619
+ <dd>
620
+
621
+ <dl>
622
+ <dd>
623
+
624
+ **sessionId:** `string` — The session id for the window.
625
+
626
+ </dd>
627
+ </dl>
628
+
629
+ <dl>
630
+ <dd>
631
+
632
+ **windowId:** `string` — The Airtop window id of the browser window.
633
+
634
+ </dd>
635
+ </dl>
636
+
637
+ <dl>
638
+ <dd>
639
+
640
+ **request:** `Airtop.AsyncTypeRequest`
641
+
642
+ </dd>
643
+ </dl>
644
+
645
+ <dl>
646
+ <dd>
647
+
648
+ **requestOptions:** `Windows.RequestOptions`
649
+
650
+ </dd>
651
+ </dl>
652
+ </dd>
653
+ </dl>
654
+
655
+ </dd>
656
+ </dl>
657
+ </details>
658
+
5
659
  <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
6
660
  <dl>
7
661
  <dd>
8
662
 
663
+ #### 📝 Description
664
+
665
+ <dl>
666
+ <dd>
667
+
668
+ <dl>
669
+ <dd>
670
+
671
+ Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
672
+
673
+ </dd>
674
+ </dl>
675
+ </dd>
676
+ </dl>
677
+
9
678
  #### 🔌 Usage
10
679
 
11
680
  <dl>
@@ -31,7 +700,88 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
31
700
  <dl>
32
701
  <dd>
33
702
 
34
- **sessionId:** `string` — ID of the session that owns the window.
703
+ **sessionId:** `string` — ID of the session that owns the window.
704
+
705
+ </dd>
706
+ </dl>
707
+
708
+ <dl>
709
+ <dd>
710
+
711
+ **request:** `Airtop.CreateWindowInputV1Body`
712
+
713
+ </dd>
714
+ </dl>
715
+
716
+ <dl>
717
+ <dd>
718
+
719
+ **requestOptions:** `Windows.RequestOptions`
720
+
721
+ </dd>
722
+ </dl>
723
+ </dd>
724
+ </dl>
725
+
726
+ </dd>
727
+ </dl>
728
+ </details>
729
+
730
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
731
+ <dl>
732
+ <dd>
733
+
734
+ #### 📝 Description
735
+
736
+ <dl>
737
+ <dd>
738
+
739
+ <dl>
740
+ <dd>
741
+
742
+ Get information about a browser window in a session, including the live view url.
743
+
744
+ </dd>
745
+ </dl>
746
+ </dd>
747
+ </dl>
748
+
749
+ #### 🔌 Usage
750
+
751
+ <dl>
752
+ <dd>
753
+
754
+ <dl>
755
+ <dd>
756
+
757
+ ```typescript
758
+ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
759
+ screenResolution: "1280x720",
760
+ });
761
+ ```
762
+
763
+ </dd>
764
+ </dl>
765
+ </dd>
766
+ </dl>
767
+
768
+ #### ⚙️ Parameters
769
+
770
+ <dl>
771
+ <dd>
772
+
773
+ <dl>
774
+ <dd>
775
+
776
+ **sessionId:** `string` — ID of the session that owns the window.
777
+
778
+ </dd>
779
+ </dl>
780
+
781
+ <dl>
782
+ <dd>
783
+
784
+ **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.
35
785
 
36
786
  </dd>
37
787
  </dl>
@@ -39,7 +789,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
39
789
  <dl>
40
790
  <dd>
41
791
 
42
- **request:** `Airtop.CreateWindowInputV1Body`
792
+ **request:** `Airtop.GetWindowInfoRequest`
43
793
 
44
794
  </dd>
45
795
  </dl>
@@ -58,10 +808,25 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
58
808
  </dl>
59
809
  </details>
60
810
 
61
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
811
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
812
+ <dl>
813
+ <dd>
814
+
815
+ #### 📝 Description
816
+
817
+ <dl>
818
+ <dd>
819
+
62
820
  <dl>
63
821
  <dd>
64
822
 
823
+ Loads a specified url on a given window
824
+
825
+ </dd>
826
+ </dl>
827
+ </dd>
828
+ </dl>
829
+
65
830
  #### 🔌 Usage
66
831
 
67
832
  <dl>
@@ -71,8 +836,8 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
71
836
  <dd>
72
837
 
73
838
  ```typescript
74
- await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
75
- screenResolution: "1280x720",
839
+ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
840
+ url: "https://www.airtop.ai",
76
841
  });
77
842
  ```
78
843
 
@@ -97,7 +862,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
97
862
  <dl>
98
863
  <dd>
99
864
 
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.
865
+ **windowId:** `string` — Airtop window ID of the browser window.
101
866
 
102
867
  </dd>
103
868
  </dl>
@@ -105,7 +870,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
105
870
  <dl>
106
871
  <dd>
107
872
 
108
- **request:** `Airtop.GetWindowInfoRequest`
873
+ **request:** `Airtop.WindowLoadUrlV1Body`
109
874
 
110
875
  </dd>
111
876
  </dl>
@@ -124,11 +889,11 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
124
889
  </dl>
125
890
  </details>
126
891
 
127
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
892
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
128
893
  <dl>
129
894
  <dd>
130
895
 
131
- #### 🔌 Usage
896
+ #### 📝 Description
132
897
 
133
898
  <dl>
134
899
  <dd>
@@ -136,18 +901,14 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
136
901
  <dl>
137
902
  <dd>
138
903
 
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
- ```
904
+ Closes a browser window in a session
144
905
 
145
906
  </dd>
146
907
  </dl>
147
908
  </dd>
148
909
  </dl>
149
910
 
150
- #### ⚙️ Parameters
911
+ #### 🔌 Usage
151
912
 
152
913
  <dl>
153
914
  <dd>
@@ -155,15 +916,24 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
155
916
  <dl>
156
917
  <dd>
157
918
 
158
- **sessionId:** `string` — ID of the session that owns the window.
919
+ ```typescript
920
+ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
921
+ ```
159
922
 
160
923
  </dd>
161
924
  </dl>
925
+ </dd>
926
+ </dl>
927
+
928
+ #### ⚙️ Parameters
162
929
 
163
930
  <dl>
164
931
  <dd>
165
932
 
166
- **windowId:** `string` — Airtop window ID of the browser window.
933
+ <dl>
934
+ <dd>
935
+
936
+ **sessionId:** `string` — ID of the session that owns the window.
167
937
 
168
938
  </dd>
169
939
  </dl>
@@ -171,7 +941,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
171
941
  <dl>
172
942
  <dd>
173
943
 
174
- **request:** `Airtop.WindowLoadUrlV1Body`
944
+ **windowId:** `string` — Airtop window ID of the browser window.
175
945
 
176
946
  </dd>
177
947
  </dl>
@@ -190,10 +960,25 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
190
960
  </dl>
191
961
  </details>
192
962
 
193
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
963
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
964
+ <dl>
965
+ <dd>
966
+
967
+ #### 📝 Description
968
+
969
+ <dl>
970
+ <dd>
971
+
194
972
  <dl>
195
973
  <dd>
196
974
 
975
+ Execute a click interaction in a specific browser window
976
+
977
+ </dd>
978
+ </dl>
979
+ </dd>
980
+ </dl>
981
+
197
982
  #### 🔌 Usage
198
983
 
199
984
  <dl>
@@ -203,7 +988,9 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
203
988
  <dd>
204
989
 
205
990
  ```typescript
206
- await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
991
+ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
992
+ elementDescription: "The login button",
993
+ });
207
994
  ```
208
995
 
209
996
  </dd>
@@ -219,7 +1006,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
219
1006
  <dl>
220
1007
  <dd>
221
1008
 
222
- **sessionId:** `string` — ID of the session that owns the window.
1009
+ **sessionId:** `string` — The session id for the window.
223
1010
 
224
1011
  </dd>
225
1012
  </dl>
@@ -227,7 +1014,15 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
227
1014
  <dl>
228
1015
  <dd>
229
1016
 
230
- **windowId:** `string` — Airtop window ID of the browser window.
1017
+ **windowId:** `string` — The Airtop window id of the browser window.
1018
+
1019
+ </dd>
1020
+ </dl>
1021
+
1022
+ <dl>
1023
+ <dd>
1024
+
1025
+ **request:** `Airtop.SessionClickHandlerRequestBody`
231
1026
 
232
1027
  </dd>
233
1028
  </dl>
@@ -246,10 +1041,25 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
246
1041
  </dl>
247
1042
  </details>
248
1043
 
249
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1044
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1045
+ <dl>
1046
+ <dd>
1047
+
1048
+ #### 📝 Description
1049
+
1050
+ <dl>
1051
+ <dd>
1052
+
250
1053
  <dl>
251
1054
  <dd>
252
1055
 
1056
+ Execute a hover interaction in a specific browser window
1057
+
1058
+ </dd>
1059
+ </dl>
1060
+ </dd>
1061
+ </dl>
1062
+
253
1063
  #### 🔌 Usage
254
1064
 
255
1065
  <dl>
@@ -259,9 +1069,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
259
1069
  <dd>
260
1070
 
261
1071
  ```typescript
262
- await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
263
- elementDescription: "The login button",
264
- });
1072
+ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
265
1073
  ```
266
1074
 
267
1075
  </dd>
@@ -293,7 +1101,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
293
1101
  <dl>
294
1102
  <dd>
295
1103
 
296
- **request:** `Airtop.SessionClickHandlerRequestBody`
1104
+ **request:** `Airtop.SessionHoverHandlerRequestBody`
297
1105
 
298
1106
  </dd>
299
1107
  </dl>
@@ -312,7 +1120,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
312
1120
  </dl>
313
1121
  </details>
314
1122
 
315
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1123
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
316
1124
  <dl>
317
1125
  <dd>
318
1126
 
@@ -325,7 +1133,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
325
1133
  <dd>
326
1134
 
327
1135
  ```typescript
328
- await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1136
+ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
329
1137
  ```
330
1138
 
331
1139
  </dd>
@@ -357,7 +1165,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
357
1165
  <dl>
358
1166
  <dd>
359
1167
 
360
- **request:** `Airtop.SessionHoverHandlerRequestBody`
1168
+ **request:** `Airtop.SessionMonitorHandlerRequestBody`
361
1169
 
362
1170
  </dd>
363
1171
  </dl>
@@ -380,6 +1188,21 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
380
1188
  <dl>
381
1189
  <dd>
382
1190
 
1191
+ #### 📝 Description
1192
+
1193
+ <dl>
1194
+ <dd>
1195
+
1196
+ <dl>
1197
+ <dd>
1198
+
1199
+ Submit a prompt that queries the content of a specific browser window. You may extract content from the page, or ask a question about the page and allow the AI to answer it (ex. Is the user logged in?).
1200
+
1201
+ </dd>
1202
+ </dl>
1203
+ </dd>
1204
+ </dl>
1205
+
383
1206
  #### 🔌 Usage
384
1207
 
385
1208
  <dl>
@@ -446,6 +1269,21 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
446
1269
  <dl>
447
1270
  <dd>
448
1271
 
1272
+ #### 📝 Description
1273
+
1274
+ <dl>
1275
+ <dd>
1276
+
1277
+ <dl>
1278
+ <dd>
1279
+
1280
+ Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
1281
+
1282
+ </dd>
1283
+ </dl>
1284
+ </dd>
1285
+ </dl>
1286
+
449
1287
  #### 🔌 Usage
450
1288
 
451
1289
  <dl>
@@ -594,6 +1432,21 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
594
1432
  <dl>
595
1433
  <dd>
596
1434
 
1435
+ #### 📝 Description
1436
+
1437
+ <dl>
1438
+ <dd>
1439
+
1440
+ <dl>
1441
+ <dd>
1442
+
1443
+ Scrape a window and return the content as markdown
1444
+
1445
+ </dd>
1446
+ </dl>
1447
+ </dd>
1448
+ </dl>
1449
+
597
1450
  #### 🔌 Usage
598
1451
 
599
1452
  <dl>
@@ -654,7 +1507,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
654
1507
  </dl>
655
1508
  </details>
656
1509
 
657
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1510
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
658
1511
  <dl>
659
1512
  <dd>
660
1513
 
@@ -666,7 +1519,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
666
1519
  <dl>
667
1520
  <dd>
668
1521
 
669
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1522
+ Take a screenshot of a browser window
670
1523
 
671
1524
  </dd>
672
1525
  </dl>
@@ -682,7 +1535,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
682
1535
  <dd>
683
1536
 
684
1537
  ```typescript
685
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1538
+ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
686
1539
  ```
687
1540
 
688
1541
  </dd>
@@ -706,7 +1559,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
706
1559
  <dl>
707
1560
  <dd>
708
1561
 
709
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
1562
+ **windowId:** `string` — The Airtop window id of the browser window.
710
1563
 
711
1564
  </dd>
712
1565
  </dl>
@@ -714,7 +1567,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
714
1567
  <dl>
715
1568
  <dd>
716
1569
 
717
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
1570
+ **request:** `Airtop.SessionScreenshotHandlerRequestBody`
718
1571
 
719
1572
  </dd>
720
1573
  </dl>
@@ -733,10 +1586,25 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
733
1586
  </dl>
734
1587
  </details>
735
1588
 
736
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1589
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1590
+ <dl>
1591
+ <dd>
1592
+
1593
+ #### 📝 Description
1594
+
1595
+ <dl>
1596
+ <dd>
1597
+
737
1598
  <dl>
738
1599
  <dd>
739
1600
 
1601
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1602
+
1603
+ </dd>
1604
+ </dl>
1605
+ </dd>
1606
+ </dl>
1607
+
740
1608
  #### 🔌 Usage
741
1609
 
742
1610
  <dl>
@@ -746,9 +1614,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
746
1614
  <dd>
747
1615
 
748
1616
  ```typescript
749
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
750
- text: "Example text",
751
- });
1617
+ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
752
1618
  ```
753
1619
 
754
1620
  </dd>
@@ -772,7 +1638,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
772
1638
  <dl>
773
1639
  <dd>
774
1640
 
775
- **windowId:** `string` — The Airtop window id of the browser window.
1641
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
776
1642
 
777
1643
  </dd>
778
1644
  </dl>
@@ -780,7 +1646,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
780
1646
  <dl>
781
1647
  <dd>
782
1648
 
783
- **request:** `Airtop.SessionTypeHandlerRequestBody`
1649
+ **request:** `Airtop.SessionSummaryHandlerRequestBody`
784
1650
 
785
1651
  </dd>
786
1652
  </dl>
@@ -799,9 +1665,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
799
1665
  </dl>
800
1666
  </details>
801
1667
 
802
- ## Profiles
803
-
804
- <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">get</a>({ ...params }) -> Airtop.ProfilesResponse</code></summary>
1668
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
805
1669
  <dl>
806
1670
  <dd>
807
1671
 
@@ -813,7 +1677,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
813
1677
  <dl>
814
1678
  <dd>
815
1679
 
816
- Get profiles matching by id
1680
+ Execute a type interaction in a specific browser window
817
1681
 
818
1682
  </dd>
819
1683
  </dl>
@@ -829,7 +1693,9 @@ Get profiles matching by id
829
1693
  <dd>
830
1694
 
831
1695
  ```typescript
832
- await client.profiles.get();
1696
+ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1697
+ text: "Example text",
1698
+ });
833
1699
  ```
834
1700
 
835
1701
  </dd>
@@ -845,7 +1711,7 @@ await client.profiles.get();
845
1711
  <dl>
846
1712
  <dd>
847
1713
 
848
- **request:** `Airtop.ProfilesGetRequest`
1714
+ **sessionId:** `string` — The session id for the window.
849
1715
 
850
1716
  </dd>
851
1717
  </dl>
@@ -853,7 +1719,23 @@ await client.profiles.get();
853
1719
  <dl>
854
1720
  <dd>
855
1721
 
856
- **requestOptions:** `Profiles.RequestOptions`
1722
+ **windowId:** `string` — The Airtop window id of the browser window.
1723
+
1724
+ </dd>
1725
+ </dl>
1726
+
1727
+ <dl>
1728
+ <dd>
1729
+
1730
+ **request:** `Airtop.SessionTypeHandlerRequestBody`
1731
+
1732
+ </dd>
1733
+ </dl>
1734
+
1735
+ <dl>
1736
+ <dd>
1737
+
1738
+ **requestOptions:** `Windows.RequestOptions`
857
1739
 
858
1740
  </dd>
859
1741
  </dl>
@@ -864,6 +1746,8 @@ await client.profiles.get();
864
1746
  </dl>
865
1747
  </details>
866
1748
 
1749
+ ## Profiles
1750
+
867
1751
  <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
868
1752
  <dl>
869
1753
  <dd>
@@ -927,6 +1811,56 @@ await client.profiles.delete();
927
1811
  </dl>
928
1812
  </details>
929
1813
 
1814
+ ## Requests
1815
+
1816
+ <details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
1817
+ <dl>
1818
+ <dd>
1819
+
1820
+ #### 🔌 Usage
1821
+
1822
+ <dl>
1823
+ <dd>
1824
+
1825
+ <dl>
1826
+ <dd>
1827
+
1828
+ ```typescript
1829
+ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
1830
+ ```
1831
+
1832
+ </dd>
1833
+ </dl>
1834
+ </dd>
1835
+ </dl>
1836
+
1837
+ #### ⚙️ Parameters
1838
+
1839
+ <dl>
1840
+ <dd>
1841
+
1842
+ <dl>
1843
+ <dd>
1844
+
1845
+ **requestId:** `string` — The ID of the request to check.
1846
+
1847
+ </dd>
1848
+ </dl>
1849
+
1850
+ <dl>
1851
+ <dd>
1852
+
1853
+ **requestOptions:** `Requests.RequestOptions`
1854
+
1855
+ </dd>
1856
+ </dl>
1857
+ </dd>
1858
+ </dl>
1859
+
1860
+ </dd>
1861
+ </dl>
1862
+ </details>
1863
+
930
1864
  ## Sessions
931
1865
 
932
1866
  <details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>