@airtop/sdk 0.1.31-beta1 → 0.1.31

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 (315) hide show
  1. package/Client.d.ts +0 -6
  2. package/Client.js +6 -16
  3. package/README.md +6 -8
  4. package/api/errors/index.d.ts +0 -2
  5. package/api/errors/index.js +0 -2
  6. package/api/resources/index.d.ts +0 -3
  7. package/api/resources/index.js +1 -4
  8. package/api/resources/profiles/client/Client.js +2 -2
  9. package/api/resources/requests/client/Client.js +2 -2
  10. package/api/resources/sessions/client/Client.d.ts +0 -9
  11. package/api/resources/sessions/client/Client.js +12 -65
  12. package/api/resources/sessions/types/SessionsEventsResponse.d.ts +7 -7
  13. package/api/resources/sessions/types/index.d.ts +2 -2
  14. package/api/resources/sessions/types/index.js +2 -2
  15. package/api/resources/windows/client/Client.d.ts +4 -138
  16. package/api/resources/windows/client/Client.js +34 -729
  17. package/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +5 -5
  18. package/api/resources/windows/client/requests/index.d.ts +0 -11
  19. package/api/types/IntervalMonitorConfig.d.ts +1 -1
  20. package/api/types/MonitorConfig.d.ts +1 -5
  21. package/api/types/SessionConfigV1.d.ts +0 -2
  22. package/api/types/index.d.ts +0 -9
  23. package/api/types/index.js +0 -9
  24. package/dist/Client.d.ts +0 -6
  25. package/dist/Client.js +6 -16
  26. package/dist/api/errors/index.d.ts +0 -2
  27. package/dist/api/errors/index.js +0 -2
  28. package/dist/api/resources/index.d.ts +0 -3
  29. package/dist/api/resources/index.js +1 -4
  30. package/dist/api/resources/profiles/client/Client.js +2 -2
  31. package/dist/api/resources/requests/client/Client.js +2 -2
  32. package/dist/api/resources/sessions/client/Client.d.ts +0 -9
  33. package/dist/api/resources/sessions/client/Client.js +12 -65
  34. package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +7 -7
  35. package/dist/api/resources/sessions/types/index.d.ts +2 -2
  36. package/dist/api/resources/sessions/types/index.js +2 -2
  37. package/dist/api/resources/windows/client/Client.d.ts +4 -138
  38. package/dist/api/resources/windows/client/Client.js +34 -729
  39. package/dist/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +5 -5
  40. package/dist/api/resources/windows/client/requests/index.d.ts +0 -11
  41. package/dist/api/types/IntervalMonitorConfig.d.ts +1 -1
  42. package/dist/api/types/MonitorConfig.d.ts +1 -5
  43. package/dist/api/types/SessionConfigV1.d.ts +0 -2
  44. package/dist/api/types/index.d.ts +0 -9
  45. package/dist/api/types/index.js +0 -9
  46. package/dist/serialization/resources/index.d.ts +0 -2
  47. package/dist/serialization/resources/index.js +1 -3
  48. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +9 -9
  49. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +4 -4
  50. package/dist/serialization/resources/sessions/types/index.d.ts +2 -2
  51. package/dist/serialization/resources/sessions/types/index.js +2 -2
  52. package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +1 -2
  53. package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +1 -2
  54. package/dist/serialization/resources/windows/client/requests/index.d.ts +0 -11
  55. package/dist/serialization/resources/windows/client/requests/index.js +1 -23
  56. package/dist/serialization/types/MonitorConfig.d.ts +0 -4
  57. package/dist/serialization/types/MonitorConfig.js +0 -4
  58. package/dist/serialization/types/SessionConfigV1.d.ts +0 -1
  59. package/dist/serialization/types/SessionConfigV1.js +0 -1
  60. package/dist/serialization/types/index.d.ts +0 -9
  61. package/dist/serialization/types/index.js +0 -9
  62. package/dist/wrapper/AirtopClient.d.ts +0 -1
  63. package/dist/wrapper/AirtopClient.js +0 -3
  64. package/dist/wrapper/AirtopRequests.d.ts +2 -2
  65. package/dist/wrapper/AirtopRequests.js +3 -3
  66. package/dist/wrapper/AirtopWindows.d.ts +11 -11
  67. package/dist/wrapper/AirtopWindows.js +17 -17
  68. package/package.json +2 -3
  69. package/reference.md +156 -1295
  70. package/serialization/resources/index.d.ts +0 -2
  71. package/serialization/resources/index.js +1 -3
  72. package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +9 -9
  73. package/serialization/resources/sessions/types/SessionsEventsResponse.js +4 -4
  74. package/serialization/resources/sessions/types/index.d.ts +2 -2
  75. package/serialization/resources/sessions/types/index.js +2 -2
  76. package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +1 -2
  77. package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +1 -2
  78. package/serialization/resources/windows/client/requests/index.d.ts +0 -11
  79. package/serialization/resources/windows/client/requests/index.js +1 -23
  80. package/serialization/types/MonitorConfig.d.ts +0 -4
  81. package/serialization/types/MonitorConfig.js +0 -4
  82. package/serialization/types/SessionConfigV1.d.ts +0 -1
  83. package/serialization/types/SessionConfigV1.js +0 -1
  84. package/serialization/types/index.d.ts +0 -9
  85. package/serialization/types/index.js +0 -9
  86. package/wrapper/AirtopClient.d.ts +0 -1
  87. package/wrapper/AirtopClient.js +0 -3
  88. package/wrapper/AirtopRequests.d.ts +2 -2
  89. package/wrapper/AirtopRequests.js +3 -3
  90. package/wrapper/AirtopWindows.d.ts +11 -11
  91. package/wrapper/AirtopWindows.js +17 -17
  92. package/api/errors/ForbiddenError.d.ts +0 -8
  93. package/api/errors/ForbiddenError.js +0 -41
  94. package/api/errors/UnauthorizedError.d.ts +0 -8
  95. package/api/errors/UnauthorizedError.js +0 -41
  96. package/api/resources/automations/client/Client.d.ts +0 -87
  97. package/api/resources/automations/client/Client.js +0 -451
  98. package/api/resources/automations/client/index.d.ts +0 -1
  99. package/api/resources/automations/client/index.js +0 -17
  100. package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -19
  101. package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -5
  102. package/api/resources/automations/client/requests/index.d.ts +0 -1
  103. package/api/resources/automations/client/requests/index.js +0 -2
  104. package/api/resources/automations/index.d.ts +0 -1
  105. package/api/resources/automations/index.js +0 -17
  106. package/api/resources/extensionConfigurations/client/Client.d.ts +0 -40
  107. package/api/resources/extensionConfigurations/client/Client.js +0 -149
  108. package/api/resources/extensionConfigurations/client/index.d.ts +0 -1
  109. package/api/resources/extensionConfigurations/client/index.js +0 -2
  110. package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +0 -13
  111. package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +0 -5
  112. package/api/resources/extensionConfigurations/client/requests/index.d.ts +0 -1
  113. package/api/resources/extensionConfigurations/client/requests/index.js +0 -2
  114. package/api/resources/extensionConfigurations/index.d.ts +0 -1
  115. package/api/resources/extensionConfigurations/index.js +0 -17
  116. package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
  117. package/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
  118. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -23
  119. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -5
  120. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -27
  121. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -5
  122. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  123. package/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
  124. package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  125. package/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
  126. package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  127. package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
  128. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  129. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
  130. package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  131. package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
  132. package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
  133. package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  134. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
  135. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  136. package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  137. package/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  138. package/api/types/AsyncConfig.d.ts +0 -7
  139. package/api/types/AsyncConfig.js +0 -5
  140. package/api/types/AsyncSessionAiResponseEnvelope.d.ts +0 -9
  141. package/api/types/AsyncSessionAiResponseEnvelope.js +0 -5
  142. package/api/types/AutomationOutput.d.ts +0 -10
  143. package/api/types/AutomationOutput.js +0 -5
  144. package/api/types/BrowserWaitSelectorConfig.d.ts +0 -11
  145. package/api/types/BrowserWaitSelectorConfig.js +0 -5
  146. package/api/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -4
  147. package/api/types/CreateAutomationRequestBodyConfiguration.js +0 -5
  148. package/api/types/DeleteAutomationOutputWrapperBody.d.ts +0 -4
  149. package/api/types/DeleteAutomationOutputWrapperBody.js +0 -5
  150. package/api/types/ExtensionConfigurationOutput.d.ts +0 -13
  151. package/api/types/ExtensionConfigurationOutput.js +0 -5
  152. package/api/types/ListAutomationsOutput.d.ts +0 -7
  153. package/api/types/ListAutomationsOutput.js +0 -5
  154. package/api/types/MonitorConfigMonitorType.d.ts +0 -11
  155. package/api/types/MonitorConfigMonitorType.js +0 -10
  156. package/dist/api/errors/ForbiddenError.d.ts +0 -8
  157. package/dist/api/errors/ForbiddenError.js +0 -41
  158. package/dist/api/errors/UnauthorizedError.d.ts +0 -8
  159. package/dist/api/errors/UnauthorizedError.js +0 -41
  160. package/dist/api/resources/automations/client/Client.d.ts +0 -87
  161. package/dist/api/resources/automations/client/Client.js +0 -451
  162. package/dist/api/resources/automations/client/index.d.ts +0 -1
  163. package/dist/api/resources/automations/client/index.js +0 -17
  164. package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -19
  165. package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -5
  166. package/dist/api/resources/automations/client/requests/index.d.ts +0 -1
  167. package/dist/api/resources/automations/client/requests/index.js +0 -2
  168. package/dist/api/resources/automations/index.d.ts +0 -1
  169. package/dist/api/resources/automations/index.js +0 -17
  170. package/dist/api/resources/extensionConfigurations/client/Client.d.ts +0 -40
  171. package/dist/api/resources/extensionConfigurations/client/Client.js +0 -149
  172. package/dist/api/resources/extensionConfigurations/client/index.d.ts +0 -1
  173. package/dist/api/resources/extensionConfigurations/client/index.js +0 -2
  174. package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +0 -13
  175. package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +0 -5
  176. package/dist/api/resources/extensionConfigurations/client/requests/index.d.ts +0 -1
  177. package/dist/api/resources/extensionConfigurations/client/requests/index.js +0 -2
  178. package/dist/api/resources/extensionConfigurations/index.d.ts +0 -1
  179. package/dist/api/resources/extensionConfigurations/index.js +0 -17
  180. package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
  181. package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
  182. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -23
  183. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -5
  184. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -27
  185. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -5
  186. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  187. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
  188. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  189. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
  190. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  191. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
  192. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  193. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
  194. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  195. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
  196. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
  197. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  198. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
  199. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  200. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  201. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  202. package/dist/api/types/AsyncConfig.d.ts +0 -7
  203. package/dist/api/types/AsyncConfig.js +0 -5
  204. package/dist/api/types/AsyncSessionAiResponseEnvelope.d.ts +0 -9
  205. package/dist/api/types/AsyncSessionAiResponseEnvelope.js +0 -5
  206. package/dist/api/types/AutomationOutput.d.ts +0 -10
  207. package/dist/api/types/AutomationOutput.js +0 -5
  208. package/dist/api/types/BrowserWaitSelectorConfig.d.ts +0 -11
  209. package/dist/api/types/BrowserWaitSelectorConfig.js +0 -5
  210. package/dist/api/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -4
  211. package/dist/api/types/CreateAutomationRequestBodyConfiguration.js +0 -5
  212. package/dist/api/types/DeleteAutomationOutputWrapperBody.d.ts +0 -4
  213. package/dist/api/types/DeleteAutomationOutputWrapperBody.js +0 -5
  214. package/dist/api/types/ExtensionConfigurationOutput.d.ts +0 -13
  215. package/dist/api/types/ExtensionConfigurationOutput.js +0 -5
  216. package/dist/api/types/ListAutomationsOutput.d.ts +0 -7
  217. package/dist/api/types/ListAutomationsOutput.js +0 -5
  218. package/dist/api/types/MonitorConfigMonitorType.d.ts +0 -11
  219. package/dist/api/types/MonitorConfigMonitorType.js +0 -10
  220. package/dist/serialization/resources/automations/client/index.d.ts +0 -1
  221. package/dist/serialization/resources/automations/client/index.js +0 -17
  222. package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -14
  223. package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -35
  224. package/dist/serialization/resources/automations/client/requests/index.d.ts +0 -1
  225. package/dist/serialization/resources/automations/client/requests/index.js +0 -5
  226. package/dist/serialization/resources/automations/index.d.ts +0 -1
  227. package/dist/serialization/resources/automations/index.js +0 -17
  228. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
  229. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -41
  230. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -18
  231. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -39
  232. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -18
  233. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -39
  234. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -19
  235. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -40
  236. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -20
  237. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -41
  238. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
  239. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -41
  240. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  241. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -40
  242. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  243. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -41
  244. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
  245. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -39
  246. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  247. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -40
  248. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  249. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -45
  250. package/dist/serialization/types/AsyncConfig.d.ts +0 -12
  251. package/dist/serialization/types/AsyncConfig.js +0 -33
  252. package/dist/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +0 -15
  253. package/dist/serialization/types/AsyncSessionAiResponseEnvelope.js +0 -36
  254. package/dist/serialization/types/AutomationOutput.d.ts +0 -16
  255. package/dist/serialization/types/AutomationOutput.js +0 -37
  256. package/dist/serialization/types/BrowserWaitSelectorConfig.d.ts +0 -14
  257. package/dist/serialization/types/BrowserWaitSelectorConfig.js +0 -35
  258. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -10
  259. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.js +0 -31
  260. package/dist/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +0 -10
  261. package/dist/serialization/types/DeleteAutomationOutputWrapperBody.js +0 -31
  262. package/dist/serialization/types/ExtensionConfigurationOutput.d.ts +0 -15
  263. package/dist/serialization/types/ExtensionConfigurationOutput.js +0 -36
  264. package/dist/serialization/types/ListAutomationsOutput.d.ts +0 -13
  265. package/dist/serialization/types/ListAutomationsOutput.js +0 -34
  266. package/dist/serialization/types/MonitorConfigMonitorType.d.ts +0 -10
  267. package/dist/serialization/types/MonitorConfigMonitorType.js +0 -31
  268. package/serialization/resources/automations/client/index.d.ts +0 -1
  269. package/serialization/resources/automations/client/index.js +0 -17
  270. package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -14
  271. package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -35
  272. package/serialization/resources/automations/client/requests/index.d.ts +0 -1
  273. package/serialization/resources/automations/client/requests/index.js +0 -5
  274. package/serialization/resources/automations/index.d.ts +0 -1
  275. package/serialization/resources/automations/index.js +0 -17
  276. package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
  277. package/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -41
  278. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -18
  279. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -39
  280. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -18
  281. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -39
  282. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -19
  283. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -40
  284. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -20
  285. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -41
  286. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
  287. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -41
  288. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  289. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -40
  290. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  291. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -41
  292. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
  293. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -39
  294. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  295. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -40
  296. package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  297. package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -45
  298. package/serialization/types/AsyncConfig.d.ts +0 -12
  299. package/serialization/types/AsyncConfig.js +0 -33
  300. package/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +0 -15
  301. package/serialization/types/AsyncSessionAiResponseEnvelope.js +0 -36
  302. package/serialization/types/AutomationOutput.d.ts +0 -16
  303. package/serialization/types/AutomationOutput.js +0 -37
  304. package/serialization/types/BrowserWaitSelectorConfig.d.ts +0 -14
  305. package/serialization/types/BrowserWaitSelectorConfig.js +0 -35
  306. package/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -10
  307. package/serialization/types/CreateAutomationRequestBodyConfiguration.js +0 -31
  308. package/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +0 -10
  309. package/serialization/types/DeleteAutomationOutputWrapperBody.js +0 -31
  310. package/serialization/types/ExtensionConfigurationOutput.d.ts +0 -15
  311. package/serialization/types/ExtensionConfigurationOutput.js +0 -36
  312. package/serialization/types/ListAutomationsOutput.d.ts +0 -13
  313. package/serialization/types/ListAutomationsOutput.js +0 -34
  314. package/serialization/types/MonitorConfigMonitorType.d.ts +0 -10
  315. package/serialization/types/MonitorConfigMonitorType.js +0 -31
package/reference.md CHANGED
@@ -2,7 +2,7 @@
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>
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
 
@@ -14,7 +14,7 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- Execute a click interaction in a specific browser window asynchronously
17
+ Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
18
18
 
19
19
  </dd>
20
20
  </dl>
@@ -30,9 +30,7 @@ Execute a click interaction in a specific browser window asynchronously
30
30
  <dd>
31
31
 
32
32
  ```typescript
33
- await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
34
- elementDescription: "The login button",
35
- });
33
+ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
36
34
  ```
37
35
 
38
36
  </dd>
@@ -48,15 +46,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
48
46
  <dl>
49
47
  <dd>
50
48
 
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.
49
+ **sessionId:** `string` — ID of the session that owns the window.
60
50
 
61
51
  </dd>
62
52
  </dl>
@@ -64,7 +54,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
64
54
  <dl>
65
55
  <dd>
66
56
 
67
- **request:** `Airtop.AsyncClickRequest`
57
+ **request:** `Airtop.CreateWindowInputV1Body`
68
58
 
69
59
  </dd>
70
60
  </dl>
@@ -83,7 +73,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
83
73
  </dl>
84
74
  </details>
85
75
 
86
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
76
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
87
77
  <dl>
88
78
  <dd>
89
79
 
@@ -95,7 +85,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
95
85
  <dl>
96
86
  <dd>
97
87
 
98
- Create an automation of a browser window asynchronously
88
+ Get information about a browser window in a session, including the live view url.
99
89
 
100
90
  </dd>
101
91
  </dl>
@@ -111,10 +101,9 @@ Create an automation of a browser window asynchronously
111
101
  <dd>
112
102
 
113
103
  ```typescript
114
- await client.windows.asyncCreateAutomation(
115
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
116
- "0334da2a-91b0-42c5-6156-76a5eba87430"
117
- );
104
+ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
105
+ screenResolution: "1280x720",
106
+ });
118
107
  ```
119
108
 
120
109
  </dd>
@@ -130,7 +119,7 @@ await client.windows.asyncCreateAutomation(
130
119
  <dl>
131
120
  <dd>
132
121
 
133
- **sessionId:** `string` — The session id for the window.
122
+ **sessionId:** `string` — ID of the session that owns the window.
134
123
 
135
124
  </dd>
136
125
  </dl>
@@ -138,7 +127,7 @@ await client.windows.asyncCreateAutomation(
138
127
  <dl>
139
128
  <dd>
140
129
 
141
- **windowId:** `string` — The Airtop window id of the browser window.
130
+ **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.
142
131
 
143
132
  </dd>
144
133
  </dl>
@@ -146,7 +135,7 @@ await client.windows.asyncCreateAutomation(
146
135
  <dl>
147
136
  <dd>
148
137
 
149
- **request:** `Airtop.AsyncCreateAutomationRequest`
138
+ **request:** `Airtop.GetWindowInfoRequest`
150
139
 
151
140
  </dd>
152
141
  </dl>
@@ -165,7 +154,7 @@ await client.windows.asyncCreateAutomation(
165
154
  </dl>
166
155
  </details>
167
156
 
168
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
157
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
169
158
  <dl>
170
159
  <dd>
171
160
 
@@ -177,7 +166,7 @@ await client.windows.asyncCreateAutomation(
177
166
  <dl>
178
167
  <dd>
179
168
 
180
- Execute an automation of a browser window asynchronously
169
+ Loads a specified url on a given window
181
170
 
182
171
  </dd>
183
172
  </dl>
@@ -193,13 +182,9 @@ Execute an automation of a browser window asynchronously
193
182
  <dd>
194
183
 
195
184
  ```typescript
196
- await client.windows.asyncExecuteAutomation(
197
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
198
- "0334da2a-91b0-42c5-6156-76a5eba87430",
199
- {
200
- automationId: "automationId",
201
- }
202
- );
185
+ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
186
+ url: "https://www.airtop.ai",
187
+ });
203
188
  ```
204
189
 
205
190
  </dd>
@@ -215,7 +200,7 @@ await client.windows.asyncExecuteAutomation(
215
200
  <dl>
216
201
  <dd>
217
202
 
218
- **sessionId:** `string` — The session id for the window.
203
+ **sessionId:** `string` — ID of the session that owns the window.
219
204
 
220
205
  </dd>
221
206
  </dl>
@@ -223,7 +208,7 @@ await client.windows.asyncExecuteAutomation(
223
208
  <dl>
224
209
  <dd>
225
210
 
226
- **windowId:** `string` — The Airtop window id of the browser window.
211
+ **windowId:** `string` — Airtop window ID of the browser window.
227
212
 
228
213
  </dd>
229
214
  </dl>
@@ -231,7 +216,7 @@ await client.windows.asyncExecuteAutomation(
231
216
  <dl>
232
217
  <dd>
233
218
 
234
- **request:** `Airtop.AsyncExecuteAutomationRequest`
219
+ **request:** `Airtop.WindowLoadUrlV1Body`
235
220
 
236
221
  </dd>
237
222
  </dl>
@@ -250,11 +235,11 @@ await client.windows.asyncExecuteAutomation(
250
235
  </dl>
251
236
  </details>
252
237
 
253
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
238
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
254
239
  <dl>
255
240
  <dd>
256
241
 
257
- #### 🔌 Usage
242
+ #### 📝 Description
258
243
 
259
244
  <dl>
260
245
  <dd>
@@ -262,18 +247,14 @@ await client.windows.asyncExecuteAutomation(
262
247
  <dl>
263
248
  <dd>
264
249
 
265
- ```typescript
266
- await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
267
- elementDescription: "The search box input in the top right corner",
268
- });
269
- ```
250
+ Closes a browser window in a session
270
251
 
271
252
  </dd>
272
253
  </dl>
273
254
  </dd>
274
255
  </dl>
275
256
 
276
- #### ⚙️ Parameters
257
+ #### 🔌 Usage
277
258
 
278
259
  <dl>
279
260
  <dd>
@@ -281,15 +262,24 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
281
262
  <dl>
282
263
  <dd>
283
264
 
284
- **sessionId:** `string` — The session id for the window.
265
+ ```typescript
266
+ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
267
+ ```
285
268
 
286
269
  </dd>
287
270
  </dl>
271
+ </dd>
272
+ </dl>
273
+
274
+ #### ⚙️ Parameters
288
275
 
289
276
  <dl>
290
277
  <dd>
291
278
 
292
- **windowId:** `string` — The Airtop window id of the browser window.
279
+ <dl>
280
+ <dd>
281
+
282
+ **sessionId:** `string` — ID of the session that owns the window.
293
283
 
294
284
  </dd>
295
285
  </dl>
@@ -297,7 +287,7 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
297
287
  <dl>
298
288
  <dd>
299
289
 
300
- **request:** `Airtop.AsyncHoverRequest`
290
+ **windowId:** `string` — Airtop window ID of the browser window.
301
291
 
302
292
  </dd>
303
293
  </dl>
@@ -316,10 +306,25 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
316
306
  </dl>
317
307
  </details>
318
308
 
319
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
309
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
310
+ <dl>
311
+ <dd>
312
+
313
+ #### 📝 Description
314
+
315
+ <dl>
316
+ <dd>
317
+
320
318
  <dl>
321
319
  <dd>
322
320
 
321
+ Execute a click interaction in a specific browser window
322
+
323
+ </dd>
324
+ </dl>
325
+ </dd>
326
+ </dl>
327
+
323
328
  #### 🔌 Usage
324
329
 
325
330
  <dl>
@@ -329,7 +334,9 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
329
334
  <dd>
330
335
 
331
336
  ```typescript
332
- await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
337
+ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
338
+ elementDescription: "The login button",
339
+ });
333
340
  ```
334
341
 
335
342
  </dd>
@@ -361,7 +368,7 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
361
368
  <dl>
362
369
  <dd>
363
370
 
364
- **request:** `Airtop.AsyncMonitorRequest`
371
+ **request:** `Airtop.SessionClickHandlerRequestBody`
365
372
 
366
373
  </dd>
367
374
  </dl>
@@ -380,10 +387,25 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
380
387
  </dl>
381
388
  </details>
382
389
 
383
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
390
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
391
+ <dl>
392
+ <dd>
393
+
394
+ #### 📝 Description
395
+
396
+ <dl>
397
+ <dd>
398
+
384
399
  <dl>
385
400
  <dd>
386
401
 
402
+ Execute a hover interaction in a specific browser window
403
+
404
+ </dd>
405
+ </dl>
406
+ </dd>
407
+ </dl>
408
+
387
409
  #### 🔌 Usage
388
410
 
389
411
  <dl>
@@ -393,8 +415,8 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
393
415
  <dd>
394
416
 
395
417
  ```typescript
396
- await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
397
- prompt: "What is the main idea of this page?",
418
+ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
419
+ elementDescription: "The search box input in the top right corner",
398
420
  });
399
421
  ```
400
422
 
@@ -427,7 +449,7 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
427
449
  <dl>
428
450
  <dd>
429
451
 
430
- **request:** `Airtop.AsyncPageQueryRequest`
452
+ **request:** `Airtop.SessionHoverHandlerRequestBody`
431
453
 
432
454
  </dd>
433
455
  </dl>
@@ -446,7 +468,7 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
446
468
  </dl>
447
469
  </details>
448
470
 
449
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
471
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
450
472
  <dl>
451
473
  <dd>
452
474
 
@@ -459,13 +481,9 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
459
481
  <dd>
460
482
 
461
483
  ```typescript
462
- await client.windows.asyncPaginatedExtraction(
463
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
464
- "0334da2a-91b0-42c5-6156-76a5eba87430",
465
- {
466
- prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
467
- }
468
- );
484
+ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
485
+ condition: "Determine if the user appears to be signed in to the website",
486
+ });
469
487
  ```
470
488
 
471
489
  </dd>
@@ -497,7 +515,7 @@ await client.windows.asyncPaginatedExtraction(
497
515
  <dl>
498
516
  <dd>
499
517
 
500
- **request:** `Airtop.AsyncPaginatedExtractionRequest`
518
+ **request:** `Airtop.SessionMonitorHandlerRequestBody`
501
519
 
502
520
  </dd>
503
521
  </dl>
@@ -516,7 +534,7 @@ await client.windows.asyncPaginatedExtraction(
516
534
  </dl>
517
535
  </details>
518
536
 
519
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
537
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
520
538
  <dl>
521
539
  <dd>
522
540
 
@@ -528,7 +546,7 @@ await client.windows.asyncPaginatedExtraction(
528
546
  <dl>
529
547
  <dd>
530
548
 
531
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
549
+ 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?).
532
550
 
533
551
  </dd>
534
552
  </dl>
@@ -544,13 +562,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
544
562
  <dd>
545
563
 
546
564
  ```typescript
547
- await client.windows.asyncPromptContent(
548
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
549
- "0334da2a-91b0-42c5-6156-76a5eba87430",
550
- {
551
- prompt: "What is the main idea of this page?",
552
- }
553
- );
565
+ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
566
+ prompt: "What is the main idea of this page?",
567
+ });
554
568
  ```
555
569
 
556
570
  </dd>
@@ -582,7 +596,7 @@ await client.windows.asyncPromptContent(
582
596
  <dl>
583
597
  <dd>
584
598
 
585
- **request:** `Airtop.AsyncPromptContentRequest`
599
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
586
600
 
587
601
  </dd>
588
602
  </dl>
@@ -601,7 +615,7 @@ await client.windows.asyncPromptContent(
601
615
  </dl>
602
616
  </details>
603
617
 
604
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
618
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
605
619
  <dl>
606
620
  <dd>
607
621
 
@@ -613,7 +627,7 @@ await client.windows.asyncPromptContent(
613
627
  <dl>
614
628
  <dd>
615
629
 
616
- Take a screenshot of the current viewport of a browser window asynchronously
630
+ Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
617
631
 
618
632
  </dd>
619
633
  </dl>
@@ -629,7 +643,13 @@ Take a screenshot of the current viewport of a browser window asynchronously
629
643
  <dd>
630
644
 
631
645
  ```typescript
632
- await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
646
+ await client.windows.paginatedExtraction(
647
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
648
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
649
+ {
650
+ prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
651
+ }
652
+ );
633
653
  ```
634
654
 
635
655
  </dd>
@@ -661,7 +681,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
661
681
  <dl>
662
682
  <dd>
663
683
 
664
- **request:** `Airtop.AsyncScreenshotRequest`
684
+ **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
665
685
 
666
686
  </dd>
667
687
  </dl>
@@ -680,7 +700,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
680
700
  </dl>
681
701
  </details>
682
702
 
683
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
703
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
684
704
  <dl>
685
705
  <dd>
686
706
 
@@ -692,7 +712,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
692
712
  <dl>
693
713
  <dd>
694
714
 
695
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
715
+ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
696
716
 
697
717
  </dd>
698
718
  </dl>
@@ -708,10 +728,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
708
728
  <dd>
709
729
 
710
730
  ```typescript
711
- await client.windows.asyncSummarizeContent(
712
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
713
- "0334da2a-91b0-42c5-6156-76a5eba87430"
714
- );
731
+ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
732
+ prompt: "What is the main idea of this page?",
733
+ });
715
734
  ```
716
735
 
717
736
  </dd>
@@ -735,7 +754,7 @@ await client.windows.asyncSummarizeContent(
735
754
  <dl>
736
755
  <dd>
737
756
 
738
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
757
+ **windowId:** `string` — The Airtop window id of the browser window.
739
758
 
740
759
  </dd>
741
760
  </dl>
@@ -743,7 +762,7 @@ await client.windows.asyncSummarizeContent(
743
762
  <dl>
744
763
  <dd>
745
764
 
746
- **request:** `Airtop.AsyncSummarizeContentRequest`
765
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
747
766
 
748
767
  </dd>
749
768
  </dl>
@@ -762,10 +781,25 @@ await client.windows.asyncSummarizeContent(
762
781
  </dl>
763
782
  </details>
764
783
 
765
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
784
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
785
+ <dl>
786
+ <dd>
787
+
788
+ #### 📝 Description
789
+
790
+ <dl>
791
+ <dd>
792
+
766
793
  <dl>
767
794
  <dd>
768
795
 
796
+ Scrape a window and return the content as markdown
797
+
798
+ </dd>
799
+ </dl>
800
+ </dd>
801
+ </dl>
802
+
769
803
  #### 🔌 Usage
770
804
 
771
805
  <dl>
@@ -775,9 +809,7 @@ await client.windows.asyncSummarizeContent(
775
809
  <dd>
776
810
 
777
811
  ```typescript
778
- await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
779
- text: "Example text",
780
- });
812
+ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
781
813
  ```
782
814
 
783
815
  </dd>
@@ -801,7 +833,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
801
833
  <dl>
802
834
  <dd>
803
835
 
804
- **windowId:** `string` — The Airtop window id of the browser window.
836
+ **windowId:** `string` — The Airtop window id of the browser window to scrape.
805
837
 
806
838
  </dd>
807
839
  </dl>
@@ -809,7 +841,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
809
841
  <dl>
810
842
  <dd>
811
843
 
812
- **request:** `Airtop.AsyncTypeRequest`
844
+ **request:** `Airtop.ScrapeContentRequest`
813
845
 
814
846
  </dd>
815
847
  </dl>
@@ -828,7 +860,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
828
860
  </dl>
829
861
  </details>
830
862
 
831
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
863
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
832
864
  <dl>
833
865
  <dd>
834
866
 
@@ -840,7 +872,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
840
872
  <dl>
841
873
  <dd>
842
874
 
843
- Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
875
+ Take a screenshot of a browser window
844
876
 
845
877
  </dd>
846
878
  </dl>
@@ -856,7 +888,7 @@ Creates a new browser window in a session. Optionally, you can specify a url to
856
888
  <dd>
857
889
 
858
890
  ```typescript
859
- await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
891
+ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
860
892
  ```
861
893
 
862
894
  </dd>
@@ -872,7 +904,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
872
904
  <dl>
873
905
  <dd>
874
906
 
875
- **sessionId:** `string` — ID of the session that owns the window.
907
+ **sessionId:** `string` — The session id for the window.
876
908
 
877
909
  </dd>
878
910
  </dl>
@@ -880,7 +912,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
880
912
  <dl>
881
913
  <dd>
882
914
 
883
- **request:** `Airtop.CreateWindowInputV1Body`
915
+ **windowId:** `string` — The Airtop window id of the browser window.
916
+
917
+ </dd>
918
+ </dl>
919
+
920
+ <dl>
921
+ <dd>
922
+
923
+ **request:** `Airtop.SessionScreenshotHandlerRequestBody`
884
924
 
885
925
  </dd>
886
926
  </dl>
@@ -899,7 +939,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
899
939
  </dl>
900
940
  </details>
901
941
 
902
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
942
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
903
943
  <dl>
904
944
  <dd>
905
945
 
@@ -911,7 +951,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
911
951
  <dl>
912
952
  <dd>
913
953
 
914
- Get information about a browser window in a session, including the live view url.
954
+ Execute a scroll interaction in a specific browser window
915
955
 
916
956
  </dd>
917
957
  </dl>
@@ -927,9 +967,7 @@ Get information about a browser window in a session, including the live view url
927
967
  <dd>
928
968
 
929
969
  ```typescript
930
- await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
931
- screenResolution: "1280x720",
932
- });
970
+ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
933
971
  ```
934
972
 
935
973
  </dd>
@@ -945,7 +983,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
945
983
  <dl>
946
984
  <dd>
947
985
 
948
- **sessionId:** `string` — ID of the session that owns the window.
986
+ **sessionId:** `string` — The session id for the window.
949
987
 
950
988
  </dd>
951
989
  </dl>
@@ -953,7 +991,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
953
991
  <dl>
954
992
  <dd>
955
993
 
956
- **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.
994
+ **windowId:** `string` — The Airtop window id of the browser window.
957
995
 
958
996
  </dd>
959
997
  </dl>
@@ -961,7 +999,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
961
999
  <dl>
962
1000
  <dd>
963
1001
 
964
- **request:** `Airtop.GetWindowInfoRequest`
1002
+ **request:** `Airtop.SessionScrollHandlerRequestBody`
965
1003
 
966
1004
  </dd>
967
1005
  </dl>
@@ -980,7 +1018,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
980
1018
  </dl>
981
1019
  </details>
982
1020
 
983
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
1021
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
984
1022
  <dl>
985
1023
  <dd>
986
1024
 
@@ -992,7 +1030,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
992
1030
  <dl>
993
1031
  <dd>
994
1032
 
995
- Loads a specified url on a given window
1033
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
996
1034
 
997
1035
  </dd>
998
1036
  </dl>
@@ -1008,9 +1046,7 @@ Loads a specified url on a given window
1008
1046
  <dd>
1009
1047
 
1010
1048
  ```typescript
1011
- await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1012
- url: "https://www.airtop.ai",
1013
- });
1049
+ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1014
1050
  ```
1015
1051
 
1016
1052
  </dd>
@@ -1026,7 +1062,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1026
1062
  <dl>
1027
1063
  <dd>
1028
1064
 
1029
- **sessionId:** `string` — ID of the session that owns the window.
1065
+ **sessionId:** `string` — The session id for the window.
1030
1066
 
1031
1067
  </dd>
1032
1068
  </dl>
@@ -1034,7 +1070,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1034
1070
  <dl>
1035
1071
  <dd>
1036
1072
 
1037
- **windowId:** `string` — Airtop window ID of the browser window.
1073
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
1038
1074
 
1039
1075
  </dd>
1040
1076
  </dl>
@@ -1042,7 +1078,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1042
1078
  <dl>
1043
1079
  <dd>
1044
1080
 
1045
- **request:** `Airtop.WindowLoadUrlV1Body`
1081
+ **request:** `Airtop.SessionSummaryHandlerRequestBody`
1046
1082
 
1047
1083
  </dd>
1048
1084
  </dl>
@@ -1061,7 +1097,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1061
1097
  </dl>
1062
1098
  </details>
1063
1099
 
1064
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
1100
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1065
1101
  <dl>
1066
1102
  <dd>
1067
1103
 
@@ -1073,7 +1109,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1073
1109
  <dl>
1074
1110
  <dd>
1075
1111
 
1076
- Closes a browser window in a session
1112
+ Execute a type interaction in a specific browser window
1077
1113
 
1078
1114
  </dd>
1079
1115
  </dl>
@@ -1089,7 +1125,9 @@ Closes a browser window in a session
1089
1125
  <dd>
1090
1126
 
1091
1127
  ```typescript
1092
- await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
1128
+ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1129
+ text: "Example text",
1130
+ });
1093
1131
  ```
1094
1132
 
1095
1133
  </dd>
@@ -1105,7 +1143,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1105
1143
  <dl>
1106
1144
  <dd>
1107
1145
 
1108
- **sessionId:** `string` — ID of the session that owns the window.
1146
+ **sessionId:** `string` — The session id for the window.
1109
1147
 
1110
1148
  </dd>
1111
1149
  </dl>
@@ -1113,7 +1151,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1113
1151
  <dl>
1114
1152
  <dd>
1115
1153
 
1116
- **windowId:** `string` — Airtop window ID of the browser window.
1154
+ **windowId:** `string` — The Airtop window id of the browser window.
1117
1155
 
1118
1156
  </dd>
1119
1157
  </dl>
@@ -1121,225 +1159,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1121
1159
  <dl>
1122
1160
  <dd>
1123
1161
 
1124
- **requestOptions:** `Windows.RequestOptions`
1125
-
1126
- </dd>
1127
- </dl>
1128
- </dd>
1129
- </dl>
1130
-
1131
- </dd>
1132
- </dl>
1133
- </details>
1134
-
1135
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1136
- <dl>
1137
- <dd>
1138
-
1139
- #### 📝 Description
1140
-
1141
- <dl>
1142
- <dd>
1143
-
1144
- <dl>
1145
- <dd>
1146
-
1147
- Execute a click interaction in a specific browser window
1148
-
1149
- </dd>
1150
- </dl>
1151
- </dd>
1152
- </dl>
1153
-
1154
- #### 🔌 Usage
1155
-
1156
- <dl>
1157
- <dd>
1158
-
1159
- <dl>
1160
- <dd>
1161
-
1162
- ```typescript
1163
- await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1164
- elementDescription: "The login button",
1165
- });
1166
- ```
1167
-
1168
- </dd>
1169
- </dl>
1170
- </dd>
1171
- </dl>
1172
-
1173
- #### ⚙️ Parameters
1174
-
1175
- <dl>
1176
- <dd>
1177
-
1178
- <dl>
1179
- <dd>
1180
-
1181
- **sessionId:** `string` — The session id for the window.
1182
-
1183
- </dd>
1184
- </dl>
1185
-
1186
- <dl>
1187
- <dd>
1188
-
1189
- **windowId:** `string` — The Airtop window id of the browser window.
1190
-
1191
- </dd>
1192
- </dl>
1193
-
1194
- <dl>
1195
- <dd>
1196
-
1197
- **request:** `Airtop.SessionClickHandlerRequestBody`
1198
-
1199
- </dd>
1200
- </dl>
1201
-
1202
- <dl>
1203
- <dd>
1204
-
1205
- **requestOptions:** `Windows.RequestOptions`
1206
-
1207
- </dd>
1208
- </dl>
1209
- </dd>
1210
- </dl>
1211
-
1212
- </dd>
1213
- </dl>
1214
- </details>
1215
-
1216
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1217
- <dl>
1218
- <dd>
1219
-
1220
- #### 📝 Description
1221
-
1222
- <dl>
1223
- <dd>
1224
-
1225
- <dl>
1226
- <dd>
1227
-
1228
- Execute a hover interaction in a specific browser window
1229
-
1230
- </dd>
1231
- </dl>
1232
- </dd>
1233
- </dl>
1234
-
1235
- #### 🔌 Usage
1236
-
1237
- <dl>
1238
- <dd>
1239
-
1240
- <dl>
1241
- <dd>
1242
-
1243
- ```typescript
1244
- await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1245
- elementDescription: "The search box input in the top right corner",
1246
- });
1247
- ```
1248
-
1249
- </dd>
1250
- </dl>
1251
- </dd>
1252
- </dl>
1253
-
1254
- #### ⚙️ Parameters
1255
-
1256
- <dl>
1257
- <dd>
1258
-
1259
- <dl>
1260
- <dd>
1261
-
1262
- **sessionId:** `string` — The session id for the window.
1263
-
1264
- </dd>
1265
- </dl>
1266
-
1267
- <dl>
1268
- <dd>
1269
-
1270
- **windowId:** `string` — The Airtop window id of the browser window.
1271
-
1272
- </dd>
1273
- </dl>
1274
-
1275
- <dl>
1276
- <dd>
1277
-
1278
- **request:** `Airtop.SessionHoverHandlerRequestBody`
1279
-
1280
- </dd>
1281
- </dl>
1282
-
1283
- <dl>
1284
- <dd>
1285
-
1286
- **requestOptions:** `Windows.RequestOptions`
1287
-
1288
- </dd>
1289
- </dl>
1290
- </dd>
1291
- </dl>
1292
-
1293
- </dd>
1294
- </dl>
1295
- </details>
1296
-
1297
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1298
- <dl>
1299
- <dd>
1300
-
1301
- #### 🔌 Usage
1302
-
1303
- <dl>
1304
- <dd>
1305
-
1306
- <dl>
1307
- <dd>
1308
-
1309
- ```typescript
1310
- await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1311
- ```
1312
-
1313
- </dd>
1314
- </dl>
1315
- </dd>
1316
- </dl>
1317
-
1318
- #### ⚙️ Parameters
1319
-
1320
- <dl>
1321
- <dd>
1322
-
1323
- <dl>
1324
- <dd>
1325
-
1326
- **sessionId:** `string` — The session id for the window.
1327
-
1328
- </dd>
1329
- </dl>
1330
-
1331
- <dl>
1332
- <dd>
1333
-
1334
- **windowId:** `string` — The Airtop window id of the browser window.
1335
-
1336
- </dd>
1337
- </dl>
1338
-
1339
- <dl>
1340
- <dd>
1341
-
1342
- **request:** `Airtop.SessionMonitorHandlerRequestBody`
1162
+ **request:** `Airtop.SessionTypeHandlerRequestBody`
1343
1163
 
1344
1164
  </dd>
1345
1165
  </dl>
@@ -1358,965 +1178,6 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1358
1178
  </dl>
1359
1179
  </details>
1360
1180
 
1361
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1362
- <dl>
1363
- <dd>
1364
-
1365
- #### 📝 Description
1366
-
1367
- <dl>
1368
- <dd>
1369
-
1370
- <dl>
1371
- <dd>
1372
-
1373
- 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?).
1374
-
1375
- </dd>
1376
- </dl>
1377
- </dd>
1378
- </dl>
1379
-
1380
- #### 🔌 Usage
1381
-
1382
- <dl>
1383
- <dd>
1384
-
1385
- <dl>
1386
- <dd>
1387
-
1388
- ```typescript
1389
- await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1390
- prompt: "What is the main idea of this page?",
1391
- });
1392
- ```
1393
-
1394
- </dd>
1395
- </dl>
1396
- </dd>
1397
- </dl>
1398
-
1399
- #### ⚙️ Parameters
1400
-
1401
- <dl>
1402
- <dd>
1403
-
1404
- <dl>
1405
- <dd>
1406
-
1407
- **sessionId:** `string` — The session id for the window.
1408
-
1409
- </dd>
1410
- </dl>
1411
-
1412
- <dl>
1413
- <dd>
1414
-
1415
- **windowId:** `string` — The Airtop window id of the browser window.
1416
-
1417
- </dd>
1418
- </dl>
1419
-
1420
- <dl>
1421
- <dd>
1422
-
1423
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1424
-
1425
- </dd>
1426
- </dl>
1427
-
1428
- <dl>
1429
- <dd>
1430
-
1431
- **requestOptions:** `Windows.RequestOptions`
1432
-
1433
- </dd>
1434
- </dl>
1435
- </dd>
1436
- </dl>
1437
-
1438
- </dd>
1439
- </dl>
1440
- </details>
1441
-
1442
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1443
- <dl>
1444
- <dd>
1445
-
1446
- #### 📝 Description
1447
-
1448
- <dl>
1449
- <dd>
1450
-
1451
- <dl>
1452
- <dd>
1453
-
1454
- Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
1455
-
1456
- </dd>
1457
- </dl>
1458
- </dd>
1459
- </dl>
1460
-
1461
- #### 🔌 Usage
1462
-
1463
- <dl>
1464
- <dd>
1465
-
1466
- <dl>
1467
- <dd>
1468
-
1469
- ```typescript
1470
- await client.windows.paginatedExtraction(
1471
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
1472
- "0334da2a-91b0-42c5-6156-76a5eba87430",
1473
- {
1474
- prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
1475
- }
1476
- );
1477
- ```
1478
-
1479
- </dd>
1480
- </dl>
1481
- </dd>
1482
- </dl>
1483
-
1484
- #### ⚙️ Parameters
1485
-
1486
- <dl>
1487
- <dd>
1488
-
1489
- <dl>
1490
- <dd>
1491
-
1492
- **sessionId:** `string` — The session id for the window.
1493
-
1494
- </dd>
1495
- </dl>
1496
-
1497
- <dl>
1498
- <dd>
1499
-
1500
- **windowId:** `string` — The Airtop window id of the browser window.
1501
-
1502
- </dd>
1503
- </dl>
1504
-
1505
- <dl>
1506
- <dd>
1507
-
1508
- **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
1509
-
1510
- </dd>
1511
- </dl>
1512
-
1513
- <dl>
1514
- <dd>
1515
-
1516
- **requestOptions:** `Windows.RequestOptions`
1517
-
1518
- </dd>
1519
- </dl>
1520
- </dd>
1521
- </dl>
1522
-
1523
- </dd>
1524
- </dl>
1525
- </details>
1526
-
1527
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1528
- <dl>
1529
- <dd>
1530
-
1531
- #### 📝 Description
1532
-
1533
- <dl>
1534
- <dd>
1535
-
1536
- <dl>
1537
- <dd>
1538
-
1539
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
1540
-
1541
- </dd>
1542
- </dl>
1543
- </dd>
1544
- </dl>
1545
-
1546
- #### 🔌 Usage
1547
-
1548
- <dl>
1549
- <dd>
1550
-
1551
- <dl>
1552
- <dd>
1553
-
1554
- ```typescript
1555
- await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1556
- prompt: "What is the main idea of this page?",
1557
- });
1558
- ```
1559
-
1560
- </dd>
1561
- </dl>
1562
- </dd>
1563
- </dl>
1564
-
1565
- #### ⚙️ Parameters
1566
-
1567
- <dl>
1568
- <dd>
1569
-
1570
- <dl>
1571
- <dd>
1572
-
1573
- **sessionId:** `string` — The session id for the window.
1574
-
1575
- </dd>
1576
- </dl>
1577
-
1578
- <dl>
1579
- <dd>
1580
-
1581
- **windowId:** `string` — The Airtop window id of the browser window.
1582
-
1583
- </dd>
1584
- </dl>
1585
-
1586
- <dl>
1587
- <dd>
1588
-
1589
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1590
-
1591
- </dd>
1592
- </dl>
1593
-
1594
- <dl>
1595
- <dd>
1596
-
1597
- **requestOptions:** `Windows.RequestOptions`
1598
-
1599
- </dd>
1600
- </dl>
1601
- </dd>
1602
- </dl>
1603
-
1604
- </dd>
1605
- </dl>
1606
- </details>
1607
-
1608
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
1609
- <dl>
1610
- <dd>
1611
-
1612
- #### 📝 Description
1613
-
1614
- <dl>
1615
- <dd>
1616
-
1617
- <dl>
1618
- <dd>
1619
-
1620
- Scrape a window and return the content as markdown
1621
-
1622
- </dd>
1623
- </dl>
1624
- </dd>
1625
- </dl>
1626
-
1627
- #### 🔌 Usage
1628
-
1629
- <dl>
1630
- <dd>
1631
-
1632
- <dl>
1633
- <dd>
1634
-
1635
- ```typescript
1636
- await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1637
- ```
1638
-
1639
- </dd>
1640
- </dl>
1641
- </dd>
1642
- </dl>
1643
-
1644
- #### ⚙️ Parameters
1645
-
1646
- <dl>
1647
- <dd>
1648
-
1649
- <dl>
1650
- <dd>
1651
-
1652
- **sessionId:** `string` — The session id for the window.
1653
-
1654
- </dd>
1655
- </dl>
1656
-
1657
- <dl>
1658
- <dd>
1659
-
1660
- **windowId:** `string` — The Airtop window id of the browser window to scrape.
1661
-
1662
- </dd>
1663
- </dl>
1664
-
1665
- <dl>
1666
- <dd>
1667
-
1668
- **request:** `Airtop.ScrapeContentRequest`
1669
-
1670
- </dd>
1671
- </dl>
1672
-
1673
- <dl>
1674
- <dd>
1675
-
1676
- **requestOptions:** `Windows.RequestOptions`
1677
-
1678
- </dd>
1679
- </dl>
1680
- </dd>
1681
- </dl>
1682
-
1683
- </dd>
1684
- </dl>
1685
- </details>
1686
-
1687
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1688
- <dl>
1689
- <dd>
1690
-
1691
- #### 📝 Description
1692
-
1693
- <dl>
1694
- <dd>
1695
-
1696
- <dl>
1697
- <dd>
1698
-
1699
- Take a screenshot of a browser window
1700
-
1701
- </dd>
1702
- </dl>
1703
- </dd>
1704
- </dl>
1705
-
1706
- #### 🔌 Usage
1707
-
1708
- <dl>
1709
- <dd>
1710
-
1711
- <dl>
1712
- <dd>
1713
-
1714
- ```typescript
1715
- await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1716
- ```
1717
-
1718
- </dd>
1719
- </dl>
1720
- </dd>
1721
- </dl>
1722
-
1723
- #### ⚙️ Parameters
1724
-
1725
- <dl>
1726
- <dd>
1727
-
1728
- <dl>
1729
- <dd>
1730
-
1731
- **sessionId:** `string` — The session id for the window.
1732
-
1733
- </dd>
1734
- </dl>
1735
-
1736
- <dl>
1737
- <dd>
1738
-
1739
- **windowId:** `string` — The Airtop window id of the browser window.
1740
-
1741
- </dd>
1742
- </dl>
1743
-
1744
- <dl>
1745
- <dd>
1746
-
1747
- **request:** `Airtop.SessionScreenshotHandlerRequestBody`
1748
-
1749
- </dd>
1750
- </dl>
1751
-
1752
- <dl>
1753
- <dd>
1754
-
1755
- **requestOptions:** `Windows.RequestOptions`
1756
-
1757
- </dd>
1758
- </dl>
1759
- </dd>
1760
- </dl>
1761
-
1762
- </dd>
1763
- </dl>
1764
- </details>
1765
-
1766
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1767
- <dl>
1768
- <dd>
1769
-
1770
- #### 📝 Description
1771
-
1772
- <dl>
1773
- <dd>
1774
-
1775
- <dl>
1776
- <dd>
1777
-
1778
- Execute a scroll interaction in a specific browser window
1779
-
1780
- </dd>
1781
- </dl>
1782
- </dd>
1783
- </dl>
1784
-
1785
- #### 🔌 Usage
1786
-
1787
- <dl>
1788
- <dd>
1789
-
1790
- <dl>
1791
- <dd>
1792
-
1793
- ```typescript
1794
- await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1795
- ```
1796
-
1797
- </dd>
1798
- </dl>
1799
- </dd>
1800
- </dl>
1801
-
1802
- #### ⚙️ Parameters
1803
-
1804
- <dl>
1805
- <dd>
1806
-
1807
- <dl>
1808
- <dd>
1809
-
1810
- **sessionId:** `string` — The session id for the window.
1811
-
1812
- </dd>
1813
- </dl>
1814
-
1815
- <dl>
1816
- <dd>
1817
-
1818
- **windowId:** `string` — The Airtop window id of the browser window.
1819
-
1820
- </dd>
1821
- </dl>
1822
-
1823
- <dl>
1824
- <dd>
1825
-
1826
- **request:** `Airtop.SessionScrollHandlerRequestBody`
1827
-
1828
- </dd>
1829
- </dl>
1830
-
1831
- <dl>
1832
- <dd>
1833
-
1834
- **requestOptions:** `Windows.RequestOptions`
1835
-
1836
- </dd>
1837
- </dl>
1838
- </dd>
1839
- </dl>
1840
-
1841
- </dd>
1842
- </dl>
1843
- </details>
1844
-
1845
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1846
- <dl>
1847
- <dd>
1848
-
1849
- #### 📝 Description
1850
-
1851
- <dl>
1852
- <dd>
1853
-
1854
- <dl>
1855
- <dd>
1856
-
1857
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1858
-
1859
- </dd>
1860
- </dl>
1861
- </dd>
1862
- </dl>
1863
-
1864
- #### 🔌 Usage
1865
-
1866
- <dl>
1867
- <dd>
1868
-
1869
- <dl>
1870
- <dd>
1871
-
1872
- ```typescript
1873
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1874
- ```
1875
-
1876
- </dd>
1877
- </dl>
1878
- </dd>
1879
- </dl>
1880
-
1881
- #### ⚙️ Parameters
1882
-
1883
- <dl>
1884
- <dd>
1885
-
1886
- <dl>
1887
- <dd>
1888
-
1889
- **sessionId:** `string` — The session id for the window.
1890
-
1891
- </dd>
1892
- </dl>
1893
-
1894
- <dl>
1895
- <dd>
1896
-
1897
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
1898
-
1899
- </dd>
1900
- </dl>
1901
-
1902
- <dl>
1903
- <dd>
1904
-
1905
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
1906
-
1907
- </dd>
1908
- </dl>
1909
-
1910
- <dl>
1911
- <dd>
1912
-
1913
- **requestOptions:** `Windows.RequestOptions`
1914
-
1915
- </dd>
1916
- </dl>
1917
- </dd>
1918
- </dl>
1919
-
1920
- </dd>
1921
- </dl>
1922
- </details>
1923
-
1924
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1925
- <dl>
1926
- <dd>
1927
-
1928
- #### 📝 Description
1929
-
1930
- <dl>
1931
- <dd>
1932
-
1933
- <dl>
1934
- <dd>
1935
-
1936
- Execute a type interaction in a specific browser window
1937
-
1938
- </dd>
1939
- </dl>
1940
- </dd>
1941
- </dl>
1942
-
1943
- #### 🔌 Usage
1944
-
1945
- <dl>
1946
- <dd>
1947
-
1948
- <dl>
1949
- <dd>
1950
-
1951
- ```typescript
1952
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1953
- text: "Example text",
1954
- });
1955
- ```
1956
-
1957
- </dd>
1958
- </dl>
1959
- </dd>
1960
- </dl>
1961
-
1962
- #### ⚙️ Parameters
1963
-
1964
- <dl>
1965
- <dd>
1966
-
1967
- <dl>
1968
- <dd>
1969
-
1970
- **sessionId:** `string` — The session id for the window.
1971
-
1972
- </dd>
1973
- </dl>
1974
-
1975
- <dl>
1976
- <dd>
1977
-
1978
- **windowId:** `string` — The Airtop window id of the browser window.
1979
-
1980
- </dd>
1981
- </dl>
1982
-
1983
- <dl>
1984
- <dd>
1985
-
1986
- **request:** `Airtop.SessionTypeHandlerRequestBody`
1987
-
1988
- </dd>
1989
- </dl>
1990
-
1991
- <dl>
1992
- <dd>
1993
-
1994
- **requestOptions:** `Windows.RequestOptions`
1995
-
1996
- </dd>
1997
- </dl>
1998
- </dd>
1999
- </dl>
2000
-
2001
- </dd>
2002
- </dl>
2003
- </details>
2004
-
2005
- ## Automations
2006
-
2007
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">listAutomations</a>() -> Airtop.ListAutomationsOutput</code></summary>
2008
- <dl>
2009
- <dd>
2010
-
2011
- #### 📝 Description
2012
-
2013
- <dl>
2014
- <dd>
2015
-
2016
- <dl>
2017
- <dd>
2018
-
2019
- List all automations for a given organization
2020
-
2021
- </dd>
2022
- </dl>
2023
- </dd>
2024
- </dl>
2025
-
2026
- #### 🔌 Usage
2027
-
2028
- <dl>
2029
- <dd>
2030
-
2031
- <dl>
2032
- <dd>
2033
-
2034
- ```typescript
2035
- await client.automations.listAutomations();
2036
- ```
2037
-
2038
- </dd>
2039
- </dl>
2040
- </dd>
2041
- </dl>
2042
-
2043
- #### ⚙️ Parameters
2044
-
2045
- <dl>
2046
- <dd>
2047
-
2048
- <dl>
2049
- <dd>
2050
-
2051
- **requestOptions:** `Automations.RequestOptions`
2052
-
2053
- </dd>
2054
- </dl>
2055
- </dd>
2056
- </dl>
2057
-
2058
- </dd>
2059
- </dl>
2060
- </details>
2061
-
2062
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">updateAutomationDescription</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
2063
- <dl>
2064
- <dd>
2065
-
2066
- #### 📝 Description
2067
-
2068
- <dl>
2069
- <dd>
2070
-
2071
- <dl>
2072
- <dd>
2073
-
2074
- Update the description of a specific automation
2075
-
2076
- </dd>
2077
- </dl>
2078
- </dd>
2079
- </dl>
2080
-
2081
- #### 🔌 Usage
2082
-
2083
- <dl>
2084
- <dd>
2085
-
2086
- <dl>
2087
- <dd>
2088
-
2089
- ```typescript
2090
- await client.automations.updateAutomationDescription({
2091
- description: "description",
2092
- id: "id",
2093
- orgId: "orgId",
2094
- });
2095
- ```
2096
-
2097
- </dd>
2098
- </dl>
2099
- </dd>
2100
- </dl>
2101
-
2102
- #### ⚙️ Parameters
2103
-
2104
- <dl>
2105
- <dd>
2106
-
2107
- <dl>
2108
- <dd>
2109
-
2110
- **request:** `Airtop.UpdateAutomationDescriptionInputBody`
2111
-
2112
- </dd>
2113
- </dl>
2114
-
2115
- <dl>
2116
- <dd>
2117
-
2118
- **requestOptions:** `Automations.RequestOptions`
2119
-
2120
- </dd>
2121
- </dl>
2122
- </dd>
2123
- </dl>
2124
-
2125
- </dd>
2126
- </dl>
2127
- </details>
2128
-
2129
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">getAutomation</a>(automationId) -> Airtop.AutomationOutput</code></summary>
2130
- <dl>
2131
- <dd>
2132
-
2133
- #### 📝 Description
2134
-
2135
- <dl>
2136
- <dd>
2137
-
2138
- <dl>
2139
- <dd>
2140
-
2141
- Get a specific automation by ID
2142
-
2143
- </dd>
2144
- </dl>
2145
- </dd>
2146
- </dl>
2147
-
2148
- #### 🔌 Usage
2149
-
2150
- <dl>
2151
- <dd>
2152
-
2153
- <dl>
2154
- <dd>
2155
-
2156
- ```typescript
2157
- await client.automations.getAutomation("automationId");
2158
- ```
2159
-
2160
- </dd>
2161
- </dl>
2162
- </dd>
2163
- </dl>
2164
-
2165
- #### ⚙️ Parameters
2166
-
2167
- <dl>
2168
- <dd>
2169
-
2170
- <dl>
2171
- <dd>
2172
-
2173
- **automationId:** `string` — ID of the automation to retrieve
2174
-
2175
- </dd>
2176
- </dl>
2177
-
2178
- <dl>
2179
- <dd>
2180
-
2181
- **requestOptions:** `Automations.RequestOptions`
2182
-
2183
- </dd>
2184
- </dl>
2185
- </dd>
2186
- </dl>
2187
-
2188
- </dd>
2189
- </dl>
2190
- </details>
2191
-
2192
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">deleteAutomation</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
2193
- <dl>
2194
- <dd>
2195
-
2196
- #### 📝 Description
2197
-
2198
- <dl>
2199
- <dd>
2200
-
2201
- <dl>
2202
- <dd>
2203
-
2204
- Delete a specific automation
2205
-
2206
- </dd>
2207
- </dl>
2208
- </dd>
2209
- </dl>
2210
-
2211
- #### 🔌 Usage
2212
-
2213
- <dl>
2214
- <dd>
2215
-
2216
- <dl>
2217
- <dd>
2218
-
2219
- ```typescript
2220
- await client.automations.deleteAutomation("automationId");
2221
- ```
2222
-
2223
- </dd>
2224
- </dl>
2225
- </dd>
2226
- </dl>
2227
-
2228
- #### ⚙️ Parameters
2229
-
2230
- <dl>
2231
- <dd>
2232
-
2233
- <dl>
2234
- <dd>
2235
-
2236
- **automationId:** `string` — ID of the automation to delete
2237
-
2238
- </dd>
2239
- </dl>
2240
-
2241
- <dl>
2242
- <dd>
2243
-
2244
- **requestOptions:** `Automations.RequestOptions`
2245
-
2246
- </dd>
2247
- </dl>
2248
- </dd>
2249
- </dl>
2250
-
2251
- </dd>
2252
- </dl>
2253
- </details>
2254
-
2255
- ## ExtensionConfigurations
2256
-
2257
- <details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationGetInfo</a>(name) -> Airtop.ExtensionConfigurationOutput</code></summary>
2258
- <dl>
2259
- <dd>
2260
-
2261
- #### 📝 Description
2262
-
2263
- <dl>
2264
- <dd>
2265
-
2266
- <dl>
2267
- <dd>
2268
-
2269
- Get an extension configuration by name
2270
-
2271
- </dd>
2272
- </dl>
2273
- </dd>
2274
- </dl>
2275
-
2276
- #### 🔌 Usage
2277
-
2278
- <dl>
2279
- <dd>
2280
-
2281
- <dl>
2282
- <dd>
2283
-
2284
- ```typescript
2285
- await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration");
2286
- ```
2287
-
2288
- </dd>
2289
- </dl>
2290
- </dd>
2291
- </dl>
2292
-
2293
- #### ⚙️ Parameters
2294
-
2295
- <dl>
2296
- <dd>
2297
-
2298
- <dl>
2299
- <dd>
2300
-
2301
- **name:** `string` — Name of the extension configuration to get
2302
-
2303
- </dd>
2304
- </dl>
2305
-
2306
- <dl>
2307
- <dd>
2308
-
2309
- **requestOptions:** `ExtensionConfigurations.RequestOptions`
2310
-
2311
- </dd>
2312
- </dl>
2313
- </dd>
2314
- </dl>
2315
-
2316
- </dd>
2317
- </dl>
2318
- </details>
2319
-
2320
1181
  ## Profiles
2321
1182
 
2322
1183
  <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>