@airtop/sdk 0.1.35-beta0 → 0.1.36

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 (286) hide show
  1. package/Client.d.ts +0 -3
  2. package/Client.js +6 -11
  3. package/README.md +10 -9
  4. package/api/resources/automations/client/Client.d.ts +8 -8
  5. package/api/resources/automations/client/Client.js +12 -12
  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 +1 -1
  9. package/api/resources/requests/client/Client.js +1 -1
  10. package/api/resources/sessions/client/Client.d.ts +0 -10
  11. package/api/resources/sessions/client/Client.js +6 -52
  12. package/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
  13. package/api/resources/sessions/types/index.d.ts +1 -1
  14. package/api/resources/sessions/types/index.js +1 -1
  15. package/api/resources/windows/client/Client.d.ts +39 -99
  16. package/api/resources/windows/client/Client.js +125 -400
  17. package/{dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts → api/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts} +2 -4
  18. package/api/resources/windows/client/requests/AsyncFillFormRequest.d.ts +27 -0
  19. package/api/resources/windows/client/requests/{AsyncScreenshotRequest.d.ts → CreateFormFillerRequest.d.ts} +2 -2
  20. package/api/resources/windows/client/requests/FillFormRequest.d.ts +27 -0
  21. package/api/resources/windows/client/requests/index.d.ts +4 -9
  22. package/api/types/index.d.ts +0 -20
  23. package/api/types/index.js +0 -20
  24. package/dist/Client.d.ts +0 -3
  25. package/dist/Client.js +6 -11
  26. package/dist/api/resources/automations/client/Client.d.ts +8 -8
  27. package/dist/api/resources/automations/client/Client.js +12 -12
  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 +1 -1
  31. package/dist/api/resources/requests/client/Client.js +1 -1
  32. package/dist/api/resources/sessions/client/Client.d.ts +0 -10
  33. package/dist/api/resources/sessions/client/Client.js +6 -52
  34. package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
  35. package/dist/api/resources/sessions/types/index.d.ts +1 -1
  36. package/dist/api/resources/sessions/types/index.js +1 -1
  37. package/dist/api/resources/windows/client/Client.d.ts +39 -99
  38. package/dist/api/resources/windows/client/Client.js +125 -400
  39. package/{api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts → dist/api/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts} +2 -4
  40. package/dist/api/resources/windows/client/requests/AsyncFillFormRequest.d.ts +27 -0
  41. package/dist/api/resources/windows/client/requests/{AsyncScreenshotRequest.d.ts → CreateFormFillerRequest.d.ts} +2 -2
  42. package/dist/api/resources/windows/client/requests/FillFormRequest.d.ts +27 -0
  43. package/dist/api/resources/windows/client/requests/index.d.ts +4 -9
  44. package/dist/api/types/index.d.ts +0 -20
  45. package/dist/api/types/index.js +0 -20
  46. package/dist/serialization/resources/index.d.ts +0 -3
  47. package/dist/serialization/resources/index.js +1 -4
  48. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
  49. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
  50. package/dist/serialization/resources/sessions/types/index.d.ts +1 -1
  51. package/dist/serialization/resources/sessions/types/index.js +1 -1
  52. package/dist/serialization/resources/windows/client/requests/{AsyncHoverRequest.d.ts → AsyncCreateFormFillerRequest.d.ts} +4 -5
  53. package/dist/serialization/resources/windows/client/requests/{AsyncSummarizeContentRequest.js → AsyncCreateFormFillerRequest.js} +4 -5
  54. package/{serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts → dist/serialization/resources/windows/client/requests/AsyncFillFormRequest.d.ts} +4 -5
  55. package/dist/serialization/resources/windows/client/requests/{AsyncMonitorRequest.js → AsyncFillFormRequest.js} +4 -5
  56. package/dist/serialization/resources/windows/client/requests/{AsyncPageQueryRequest.d.ts → CreateFormFillerRequest.d.ts} +4 -6
  57. package/dist/serialization/resources/windows/client/requests/{AsyncClickRequest.js → CreateFormFillerRequest.js} +4 -6
  58. package/dist/serialization/resources/windows/client/requests/{AsyncMonitorRequest.d.ts → FillFormRequest.d.ts} +4 -5
  59. package/{serialization/resources/windows/client/requests/AsyncMonitorRequest.js → dist/serialization/resources/windows/client/requests/FillFormRequest.js} +4 -5
  60. package/dist/serialization/resources/windows/client/requests/index.d.ts +4 -9
  61. package/dist/serialization/resources/windows/client/requests/index.js +9 -19
  62. package/dist/serialization/types/index.d.ts +0 -20
  63. package/dist/serialization/types/index.js +0 -20
  64. package/dist/version.d.ts +1 -1
  65. package/dist/version.js +1 -1
  66. package/dist/wrapper/AirtopClient.d.ts +1 -3
  67. package/dist/wrapper/AirtopClient.js +3 -5
  68. package/dist/wrapper/AirtopRequests.js +1 -1
  69. package/dist/wrapper/AirtopWindows.d.ts +27 -1
  70. package/dist/wrapper/AirtopWindows.js +40 -0
  71. package/package.json +2 -3
  72. package/reference.md +257 -1274
  73. package/serialization/resources/index.d.ts +0 -3
  74. package/serialization/resources/index.js +1 -4
  75. package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
  76. package/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
  77. package/serialization/resources/sessions/types/index.d.ts +1 -1
  78. package/serialization/resources/sessions/types/index.js +1 -1
  79. package/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts +18 -0
  80. package/serialization/resources/windows/client/requests/{AsyncSummarizeContentRequest.js → AsyncCreateFormFillerRequest.js} +4 -5
  81. package/serialization/resources/windows/client/requests/{AsyncScreenshotRequest.d.ts → AsyncFillFormRequest.d.ts} +4 -4
  82. package/{dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js → serialization/resources/windows/client/requests/AsyncFillFormRequest.js} +4 -4
  83. package/{dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts → serialization/resources/windows/client/requests/CreateFormFillerRequest.d.ts} +4 -6
  84. package/{dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js → serialization/resources/windows/client/requests/CreateFormFillerRequest.js} +4 -5
  85. package/{dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts → serialization/resources/windows/client/requests/FillFormRequest.d.ts} +4 -4
  86. package/serialization/resources/windows/client/requests/{AsyncScreenshotRequest.js → FillFormRequest.js} +4 -4
  87. package/serialization/resources/windows/client/requests/index.d.ts +4 -9
  88. package/serialization/resources/windows/client/requests/index.js +9 -19
  89. package/serialization/types/index.d.ts +0 -20
  90. package/serialization/types/index.js +0 -20
  91. package/version.d.ts +1 -1
  92. package/version.js +1 -1
  93. package/wrapper/AirtopClient.d.ts +1 -3
  94. package/wrapper/AirtopClient.js +3 -5
  95. package/wrapper/AirtopRequests.js +1 -1
  96. package/wrapper/AirtopWindows.d.ts +27 -1
  97. package/wrapper/AirtopWindows.js +40 -0
  98. package/api/resources/files/client/Client.d.ts +0 -69
  99. package/api/resources/files/client/Client.js +0 -286
  100. package/api/resources/files/client/index.d.ts +0 -1
  101. package/api/resources/files/client/index.js +0 -17
  102. package/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +0 -20
  103. package/api/resources/files/client/requests/FilesListRequest.d.ts +0 -24
  104. package/api/resources/files/client/requests/index.d.ts +0 -2
  105. package/api/resources/files/client/requests/index.js +0 -2
  106. package/api/resources/files/index.d.ts +0 -2
  107. package/api/resources/files/index.js +0 -18
  108. package/api/resources/files/types/CreateFileRestInputV1FileType.d.ts +0 -13
  109. package/api/resources/files/types/CreateFileRestInputV1FileType.js +0 -12
  110. package/api/resources/files/types/index.d.ts +0 -1
  111. package/api/resources/files/types/index.js +0 -17
  112. package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
  113. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  114. package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  115. package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  116. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  117. package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  118. package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  119. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  120. package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  121. package/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  122. package/api/types/CreateFileV1.d.ts +0 -24
  123. package/api/types/CreateFileV1.js +0 -5
  124. package/api/types/CreateFileV1FileType.d.ts +0 -13
  125. package/api/types/CreateFileV1FileType.js +0 -12
  126. package/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +0 -10
  127. package/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +0 -5
  128. package/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +0 -10
  129. package/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +0 -5
  130. package/api/types/ExtensionConfigurationOutput.d.ts +0 -13
  131. package/api/types/ExtensionConfigurationOutput.js +0 -5
  132. package/api/types/ExternalFile.d.ts +0 -33
  133. package/api/types/ExternalFile.js +0 -5
  134. package/api/types/FilesResponse.d.ts +0 -10
  135. package/api/types/FilesResponse.js +0 -5
  136. package/api/types/FilesWithPagination.d.ts +0 -10
  137. package/api/types/FilesWithPagination.js +0 -5
  138. package/api/types/GetFileV1.d.ts +0 -24
  139. package/api/types/GetFileV1.js +0 -5
  140. package/api/types/GetFileV1FileType.d.ts +0 -13
  141. package/api/types/GetFileV1FileType.js +0 -12
  142. package/dist/api/resources/files/client/Client.d.ts +0 -69
  143. package/dist/api/resources/files/client/Client.js +0 -286
  144. package/dist/api/resources/files/client/index.d.ts +0 -1
  145. package/dist/api/resources/files/client/index.js +0 -17
  146. package/dist/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +0 -20
  147. package/dist/api/resources/files/client/requests/CreateFileRestInputV1.js +0 -5
  148. package/dist/api/resources/files/client/requests/FilesListRequest.d.ts +0 -24
  149. package/dist/api/resources/files/client/requests/FilesListRequest.js +0 -5
  150. package/dist/api/resources/files/client/requests/index.d.ts +0 -2
  151. package/dist/api/resources/files/client/requests/index.js +0 -2
  152. package/dist/api/resources/files/index.d.ts +0 -2
  153. package/dist/api/resources/files/index.js +0 -18
  154. package/dist/api/resources/files/types/CreateFileRestInputV1FileType.d.ts +0 -13
  155. package/dist/api/resources/files/types/CreateFileRestInputV1FileType.js +0 -12
  156. package/dist/api/resources/files/types/index.d.ts +0 -1
  157. package/dist/api/resources/files/types/index.js +0 -17
  158. package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
  159. package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
  160. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  161. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
  162. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  163. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
  164. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  165. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
  166. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  167. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
  168. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  169. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
  170. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  171. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  172. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  173. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  174. package/dist/api/types/CreateFileV1.d.ts +0 -24
  175. package/dist/api/types/CreateFileV1.js +0 -5
  176. package/dist/api/types/CreateFileV1FileType.d.ts +0 -13
  177. package/dist/api/types/CreateFileV1FileType.js +0 -12
  178. package/dist/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +0 -10
  179. package/dist/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +0 -5
  180. package/dist/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +0 -10
  181. package/dist/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +0 -5
  182. package/dist/api/types/ExtensionConfigurationOutput.d.ts +0 -13
  183. package/dist/api/types/ExtensionConfigurationOutput.js +0 -5
  184. package/dist/api/types/ExternalFile.d.ts +0 -33
  185. package/dist/api/types/ExternalFile.js +0 -5
  186. package/dist/api/types/FilesResponse.d.ts +0 -10
  187. package/dist/api/types/FilesResponse.js +0 -5
  188. package/dist/api/types/FilesWithPagination.d.ts +0 -10
  189. package/dist/api/types/FilesWithPagination.js +0 -5
  190. package/dist/api/types/GetFileV1.d.ts +0 -24
  191. package/dist/api/types/GetFileV1.js +0 -5
  192. package/dist/api/types/GetFileV1FileType.d.ts +0 -13
  193. package/dist/api/types/GetFileV1FileType.js +0 -12
  194. package/dist/serialization/resources/files/client/index.d.ts +0 -1
  195. package/dist/serialization/resources/files/client/index.js +0 -17
  196. package/dist/serialization/resources/files/client/requests/CreateFileRestInputV1.d.ts +0 -16
  197. package/dist/serialization/resources/files/client/requests/CreateFileRestInputV1.js +0 -47
  198. package/dist/serialization/resources/files/client/requests/index.d.ts +0 -1
  199. package/dist/serialization/resources/files/client/requests/index.js +0 -5
  200. package/dist/serialization/resources/files/index.d.ts +0 -2
  201. package/dist/serialization/resources/files/index.js +0 -18
  202. package/dist/serialization/resources/files/types/CreateFileRestInputV1FileType.d.ts +0 -10
  203. package/dist/serialization/resources/files/types/CreateFileRestInputV1FileType.js +0 -41
  204. package/dist/serialization/resources/files/types/index.d.ts +0 -1
  205. package/dist/serialization/resources/files/types/index.js +0 -17
  206. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -50
  207. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -51
  208. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  209. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  210. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -51
  211. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  212. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  213. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -55
  214. package/dist/serialization/types/CreateFileV1.d.ts +0 -21
  215. package/dist/serialization/types/CreateFileV1.js +0 -52
  216. package/dist/serialization/types/CreateFileV1FileType.d.ts +0 -10
  217. package/dist/serialization/types/CreateFileV1FileType.js +0 -41
  218. package/dist/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +0 -18
  219. package/dist/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +0 -49
  220. package/dist/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +0 -18
  221. package/dist/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +0 -49
  222. package/dist/serialization/types/ExternalFile.d.ts +0 -25
  223. package/dist/serialization/types/ExternalFile.js +0 -56
  224. package/dist/serialization/types/FilesResponse.d.ts +0 -18
  225. package/dist/serialization/types/FilesResponse.js +0 -49
  226. package/dist/serialization/types/FilesWithPagination.d.ts +0 -15
  227. package/dist/serialization/types/FilesWithPagination.js +0 -46
  228. package/dist/serialization/types/GetFileV1.d.ts +0 -21
  229. package/dist/serialization/types/GetFileV1.js +0 -52
  230. package/dist/serialization/types/GetFileV1FileType.d.ts +0 -10
  231. package/dist/serialization/types/GetFileV1FileType.js +0 -41
  232. package/dist/wrapper/AirtopFiles.d.ts +0 -38
  233. package/dist/wrapper/AirtopFiles.js +0 -151
  234. package/serialization/resources/files/client/index.d.ts +0 -1
  235. package/serialization/resources/files/client/index.js +0 -17
  236. package/serialization/resources/files/client/requests/CreateFileRestInputV1.d.ts +0 -16
  237. package/serialization/resources/files/client/requests/CreateFileRestInputV1.js +0 -47
  238. package/serialization/resources/files/client/requests/index.d.ts +0 -1
  239. package/serialization/resources/files/client/requests/index.js +0 -5
  240. package/serialization/resources/files/index.d.ts +0 -2
  241. package/serialization/resources/files/index.js +0 -18
  242. package/serialization/resources/files/types/CreateFileRestInputV1FileType.d.ts +0 -10
  243. package/serialization/resources/files/types/CreateFileRestInputV1FileType.js +0 -41
  244. package/serialization/resources/files/types/index.d.ts +0 -1
  245. package/serialization/resources/files/types/index.js +0 -17
  246. package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
  247. package/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -51
  248. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -19
  249. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -50
  250. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
  251. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -51
  252. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  253. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -50
  254. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  255. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -51
  256. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  257. package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  258. package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -55
  259. package/serialization/types/CreateFileV1.d.ts +0 -21
  260. package/serialization/types/CreateFileV1.js +0 -52
  261. package/serialization/types/CreateFileV1FileType.d.ts +0 -10
  262. package/serialization/types/CreateFileV1FileType.js +0 -41
  263. package/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +0 -18
  264. package/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +0 -49
  265. package/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +0 -18
  266. package/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +0 -49
  267. package/serialization/types/ExternalFile.d.ts +0 -25
  268. package/serialization/types/ExternalFile.js +0 -56
  269. package/serialization/types/FilesResponse.d.ts +0 -18
  270. package/serialization/types/FilesResponse.js +0 -49
  271. package/serialization/types/FilesWithPagination.d.ts +0 -15
  272. package/serialization/types/FilesWithPagination.js +0 -46
  273. package/serialization/types/GetFileV1.d.ts +0 -21
  274. package/serialization/types/GetFileV1.js +0 -52
  275. package/serialization/types/GetFileV1FileType.d.ts +0 -10
  276. package/serialization/types/GetFileV1FileType.js +0 -41
  277. package/wrapper/AirtopFiles.d.ts +0 -38
  278. package/wrapper/AirtopFiles.js +0 -151
  279. /package/api/resources/{files/client/requests/CreateFileRestInputV1.js → windows/client/requests/AsyncCreateFormFillerRequest.js} +0 -0
  280. /package/api/resources/{files/client/requests/FilesListRequest.js → windows/client/requests/AsyncFillFormRequest.js} +0 -0
  281. /package/api/resources/windows/client/requests/{AsyncClickRequest.js → CreateFormFillerRequest.js} +0 -0
  282. /package/api/resources/windows/client/requests/{AsyncHoverRequest.js → FillFormRequest.js} +0 -0
  283. /package/{api/resources/windows/client/requests/AsyncMonitorRequest.js → dist/api/resources/windows/client/requests/AsyncCreateFormFillerRequest.js} +0 -0
  284. /package/{api/resources/windows/client/requests/AsyncPageQueryRequest.js → dist/api/resources/windows/client/requests/AsyncFillFormRequest.js} +0 -0
  285. /package/{api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js → dist/api/resources/windows/client/requests/CreateFormFillerRequest.js} +0 -0
  286. /package/{api/resources/windows/client/requests/AsyncPromptContentRequest.js → dist/api/resources/windows/client/requests/FillFormRequest.js} +0 -0
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">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</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
+ Create an automation of a browser window asynchronously
18
18
 
19
19
  </dd>
20
20
  </dl>
@@ -30,9 +30,10 @@ 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.asyncCreateAutomation(
34
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
35
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
36
+ );
36
37
  ```
37
38
 
38
39
  </dd>
@@ -64,7 +65,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
64
65
  <dl>
65
66
  <dd>
66
67
 
67
- **request:** `Airtop.AsyncClickRequest`
68
+ **request:** `Airtop.AsyncCreateAutomationRequest`
68
69
 
69
70
  </dd>
70
71
  </dl>
@@ -83,7 +84,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
83
84
  </dl>
84
85
  </details>
85
86
 
86
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
87
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
87
88
  <dl>
88
89
  <dd>
89
90
 
@@ -95,7 +96,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
95
96
  <dl>
96
97
  <dd>
97
98
 
98
- Create an automation of a browser window asynchronously
99
+ Create a form filler automation asynchronously
99
100
 
100
101
  </dd>
101
102
  </dl>
@@ -111,7 +112,7 @@ Create an automation of a browser window asynchronously
111
112
  <dd>
112
113
 
113
114
  ```typescript
114
- await client.windows.asyncCreateAutomation(
115
+ await client.windows.asyncCreateFormFiller(
115
116
  "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
116
117
  "0334da2a-91b0-42c5-6156-76a5eba87430",
117
118
  );
@@ -146,7 +147,7 @@ await client.windows.asyncCreateAutomation(
146
147
  <dl>
147
148
  <dd>
148
149
 
149
- **request:** `Airtop.AsyncCreateAutomationRequest`
150
+ **request:** `Airtop.AsyncCreateFormFillerRequest`
150
151
 
151
152
  </dd>
152
153
  </dl>
@@ -250,10 +251,25 @@ await client.windows.asyncExecuteAutomation(
250
251
  </dl>
251
252
  </details>
252
253
 
253
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
254
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
255
+ <dl>
256
+ <dd>
257
+
258
+ #### 📝 Description
259
+
260
+ <dl>
261
+ <dd>
262
+
254
263
  <dl>
255
264
  <dd>
256
265
 
266
+ Fill a form of a browser window asynchronously using a form-filler automation
267
+
268
+ </dd>
269
+ </dl>
270
+ </dd>
271
+ </dl>
272
+
257
273
  #### 🔌 Usage
258
274
 
259
275
  <dl>
@@ -263,8 +279,8 @@ await client.windows.asyncExecuteAutomation(
263
279
  <dd>
264
280
 
265
281
  ```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",
282
+ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
283
+ automationId: "automationId",
268
284
  });
269
285
  ```
270
286
 
@@ -297,7 +313,7 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
297
313
  <dl>
298
314
  <dd>
299
315
 
300
- **request:** `Airtop.AsyncHoverRequest`
316
+ **request:** `Airtop.AsyncFillFormRequest`
301
317
 
302
318
  </dd>
303
319
  </dl>
@@ -316,11 +332,11 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
316
332
  </dl>
317
333
  </details>
318
334
 
319
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
335
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
320
336
  <dl>
321
337
  <dd>
322
338
 
323
- #### 🔌 Usage
339
+ #### 📝 Description
324
340
 
325
341
  <dl>
326
342
  <dd>
@@ -328,18 +344,14 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
328
344
  <dl>
329
345
  <dd>
330
346
 
331
- ```typescript
332
- await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
333
- condition: "Determine if the user appears to be signed in to the website",
334
- });
335
- ```
347
+ Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
336
348
 
337
349
  </dd>
338
350
  </dl>
339
351
  </dd>
340
352
  </dl>
341
353
 
342
- #### ⚙️ Parameters
354
+ #### 🔌 Usage
343
355
 
344
356
  <dl>
345
357
  <dd>
@@ -347,15 +359,24 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
347
359
  <dl>
348
360
  <dd>
349
361
 
350
- **sessionId:** `string` — The session id for the window.
362
+ ```typescript
363
+ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
364
+ ```
351
365
 
366
+ </dd>
367
+ </dl>
352
368
  </dd>
353
369
  </dl>
354
370
 
371
+ #### ⚙️ Parameters
372
+
355
373
  <dl>
356
374
  <dd>
357
375
 
358
- **windowId:** `string` — The Airtop window id of the browser window.
376
+ <dl>
377
+ <dd>
378
+
379
+ **sessionId:** `string` — ID of the session that owns the window.
359
380
 
360
381
  </dd>
361
382
  </dl>
@@ -363,7 +384,7 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
363
384
  <dl>
364
385
  <dd>
365
386
 
366
- **request:** `Airtop.AsyncMonitorRequest`
387
+ **request:** `Airtop.CreateWindowInputV1Body`
367
388
 
368
389
  </dd>
369
390
  </dl>
@@ -382,10 +403,25 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
382
403
  </dl>
383
404
  </details>
384
405
 
385
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
406
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
407
+ <dl>
408
+ <dd>
409
+
410
+ #### 📝 Description
411
+
412
+ <dl>
413
+ <dd>
414
+
386
415
  <dl>
387
416
  <dd>
388
417
 
418
+ Get information about a browser window in a session, including the live view url.
419
+
420
+ </dd>
421
+ </dl>
422
+ </dd>
423
+ </dl>
424
+
389
425
  #### 🔌 Usage
390
426
 
391
427
  <dl>
@@ -395,8 +431,8 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
395
431
  <dd>
396
432
 
397
433
  ```typescript
398
- await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
399
- prompt: "What is the main idea of this page?",
434
+ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
435
+ screenResolution: "1280x720",
400
436
  });
401
437
  ```
402
438
 
@@ -413,7 +449,7 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
413
449
  <dl>
414
450
  <dd>
415
451
 
416
- **sessionId:** `string` — The session id for the window.
452
+ **sessionId:** `string` — ID of the session that owns the window.
417
453
 
418
454
  </dd>
419
455
  </dl>
@@ -421,7 +457,7 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
421
457
  <dl>
422
458
  <dd>
423
459
 
424
- **windowId:** `string` — The Airtop window id of the browser window.
460
+ **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.
425
461
 
426
462
  </dd>
427
463
  </dl>
@@ -429,7 +465,7 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
429
465
  <dl>
430
466
  <dd>
431
467
 
432
- **request:** `Airtop.AsyncPageQueryRequest`
468
+ **request:** `Airtop.GetWindowInfoRequest`
433
469
 
434
470
  </dd>
435
471
  </dl>
@@ -448,10 +484,25 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
448
484
  </dl>
449
485
  </details>
450
486
 
451
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
487
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
488
+ <dl>
489
+ <dd>
490
+
491
+ #### 📝 Description
492
+
493
+ <dl>
494
+ <dd>
495
+
452
496
  <dl>
453
497
  <dd>
454
498
 
499
+ Loads a specified url on a given window
500
+
501
+ </dd>
502
+ </dl>
503
+ </dd>
504
+ </dl>
505
+
455
506
  #### 🔌 Usage
456
507
 
457
508
  <dl>
@@ -461,13 +512,9 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
461
512
  <dd>
462
513
 
463
514
  ```typescript
464
- await client.windows.asyncPaginatedExtraction(
465
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
466
- "0334da2a-91b0-42c5-6156-76a5eba87430",
467
- {
468
- 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.",
469
- },
470
- );
515
+ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
516
+ url: "https://www.airtop.ai",
517
+ });
471
518
  ```
472
519
 
473
520
  </dd>
@@ -483,7 +530,7 @@ await client.windows.asyncPaginatedExtraction(
483
530
  <dl>
484
531
  <dd>
485
532
 
486
- **sessionId:** `string` — The session id for the window.
533
+ **sessionId:** `string` — ID of the session that owns the window.
487
534
 
488
535
  </dd>
489
536
  </dl>
@@ -491,7 +538,7 @@ await client.windows.asyncPaginatedExtraction(
491
538
  <dl>
492
539
  <dd>
493
540
 
494
- **windowId:** `string` — The Airtop window id of the browser window.
541
+ **windowId:** `string` — Airtop window ID of the browser window.
495
542
 
496
543
  </dd>
497
544
  </dl>
@@ -499,7 +546,7 @@ await client.windows.asyncPaginatedExtraction(
499
546
  <dl>
500
547
  <dd>
501
548
 
502
- **request:** `Airtop.AsyncPaginatedExtractionRequest`
549
+ **request:** `Airtop.WindowLoadUrlV1Body`
503
550
 
504
551
  </dd>
505
552
  </dl>
@@ -518,7 +565,7 @@ await client.windows.asyncPaginatedExtraction(
518
565
  </dl>
519
566
  </details>
520
567
 
521
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
568
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
522
569
  <dl>
523
570
  <dd>
524
571
 
@@ -530,7 +577,7 @@ await client.windows.asyncPaginatedExtraction(
530
577
  <dl>
531
578
  <dd>
532
579
 
533
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
580
+ Closes a browser window in a session
534
581
 
535
582
  </dd>
536
583
  </dl>
@@ -546,13 +593,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
546
593
  <dd>
547
594
 
548
595
  ```typescript
549
- await client.windows.asyncPromptContent(
550
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
551
- "0334da2a-91b0-42c5-6156-76a5eba87430",
552
- {
553
- prompt: "What is the main idea of this page?",
554
- },
555
- );
596
+ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
556
597
  ```
557
598
 
558
599
  </dd>
@@ -568,15 +609,7 @@ await client.windows.asyncPromptContent(
568
609
  <dl>
569
610
  <dd>
570
611
 
571
- **sessionId:** `string` — The session id for the window.
572
-
573
- </dd>
574
- </dl>
575
-
576
- <dl>
577
- <dd>
578
-
579
- **windowId:** `string` — The Airtop window id of the browser window.
612
+ **sessionId:** `string` — ID of the session that owns the window.
580
613
 
581
614
  </dd>
582
615
  </dl>
@@ -584,7 +617,7 @@ await client.windows.asyncPromptContent(
584
617
  <dl>
585
618
  <dd>
586
619
 
587
- **request:** `Airtop.AsyncPromptContentRequest`
620
+ **windowId:** `string` — Airtop window ID of the browser window.
588
621
 
589
622
  </dd>
590
623
  </dl>
@@ -603,7 +636,7 @@ await client.windows.asyncPromptContent(
603
636
  </dl>
604
637
  </details>
605
638
 
606
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
639
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
607
640
  <dl>
608
641
  <dd>
609
642
 
@@ -615,7 +648,7 @@ await client.windows.asyncPromptContent(
615
648
  <dl>
616
649
  <dd>
617
650
 
618
- Take a screenshot of the current viewport of a browser window asynchronously
651
+ Execute a click interaction in a specific browser window
619
652
 
620
653
  </dd>
621
654
  </dl>
@@ -631,7 +664,9 @@ Take a screenshot of the current viewport of a browser window asynchronously
631
664
  <dd>
632
665
 
633
666
  ```typescript
634
- await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
667
+ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
668
+ elementDescription: "The login button",
669
+ });
635
670
  ```
636
671
 
637
672
  </dd>
@@ -663,7 +698,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
663
698
  <dl>
664
699
  <dd>
665
700
 
666
- **request:** `Airtop.AsyncScreenshotRequest`
701
+ **request:** `Airtop.SessionClickHandlerRequestBody`
667
702
 
668
703
  </dd>
669
704
  </dl>
@@ -682,7 +717,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
682
717
  </dl>
683
718
  </details>
684
719
 
685
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
720
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
686
721
  <dl>
687
722
  <dd>
688
723
 
@@ -694,7 +729,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
694
729
  <dl>
695
730
  <dd>
696
731
 
697
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
732
+ Create a form-filler automation synchronously for the form loaded in the browser window
698
733
 
699
734
  </dd>
700
735
  </dl>
@@ -710,10 +745,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
710
745
  <dd>
711
746
 
712
747
  ```typescript
713
- await client.windows.asyncSummarizeContent(
714
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
715
- "0334da2a-91b0-42c5-6156-76a5eba87430",
716
- );
748
+ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
717
749
  ```
718
750
 
719
751
  </dd>
@@ -737,7 +769,7 @@ await client.windows.asyncSummarizeContent(
737
769
  <dl>
738
770
  <dd>
739
771
 
740
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
772
+ **windowId:** `string` — The Airtop window id of the browser window.
741
773
 
742
774
  </dd>
743
775
  </dl>
@@ -745,7 +777,7 @@ await client.windows.asyncSummarizeContent(
745
777
  <dl>
746
778
  <dd>
747
779
 
748
- **request:** `Airtop.AsyncSummarizeContentRequest`
780
+ **request:** `Airtop.CreateFormFillerRequest`
749
781
 
750
782
  </dd>
751
783
  </dl>
@@ -764,10 +796,25 @@ await client.windows.asyncSummarizeContent(
764
796
  </dl>
765
797
  </details>
766
798
 
767
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
799
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
800
+ <dl>
801
+ <dd>
802
+
803
+ #### 📝 Description
804
+
805
+ <dl>
806
+ <dd>
807
+
768
808
  <dl>
769
809
  <dd>
770
810
 
811
+ Fill a form of a browser window synchronously using a form-filler automation
812
+
813
+ </dd>
814
+ </dl>
815
+ </dd>
816
+ </dl>
817
+
771
818
  #### 🔌 Usage
772
819
 
773
820
  <dl>
@@ -777,8 +824,8 @@ await client.windows.asyncSummarizeContent(
777
824
  <dd>
778
825
 
779
826
  ```typescript
780
- await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
781
- text: "Example text",
827
+ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
828
+ automationId: "automationId",
782
829
  });
783
830
  ```
784
831
 
@@ -811,7 +858,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
811
858
  <dl>
812
859
  <dd>
813
860
 
814
- **request:** `Airtop.AsyncTypeRequest`
861
+ **request:** `Airtop.FillFormRequest`
815
862
 
816
863
  </dd>
817
864
  </dl>
@@ -830,7 +877,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
830
877
  </dl>
831
878
  </details>
832
879
 
833
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
880
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
834
881
  <dl>
835
882
  <dd>
836
883
 
@@ -842,7 +889,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
842
889
  <dl>
843
890
  <dd>
844
891
 
845
- Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
892
+ Execute a hover interaction in a specific browser window
846
893
 
847
894
  </dd>
848
895
  </dl>
@@ -858,7 +905,9 @@ Creates a new browser window in a session. Optionally, you can specify a url to
858
905
  <dd>
859
906
 
860
907
  ```typescript
861
- await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
908
+ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
909
+ elementDescription: "The search box input in the top right corner",
910
+ });
862
911
  ```
863
912
 
864
913
  </dd>
@@ -874,7 +923,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
874
923
  <dl>
875
924
  <dd>
876
925
 
877
- **sessionId:** `string` — ID of the session that owns the window.
926
+ **sessionId:** `string` — The session id for the window.
878
927
 
879
928
  </dd>
880
929
  </dl>
@@ -882,7 +931,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
882
931
  <dl>
883
932
  <dd>
884
933
 
885
- **request:** `Airtop.CreateWindowInputV1Body`
934
+ **windowId:** `string` — The Airtop window id of the browser window.
935
+
936
+ </dd>
937
+ </dl>
938
+
939
+ <dl>
940
+ <dd>
941
+
942
+ **request:** `Airtop.SessionHoverHandlerRequestBody`
886
943
 
887
944
  </dd>
888
945
  </dl>
@@ -901,25 +958,10 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
901
958
  </dl>
902
959
  </details>
903
960
 
904
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
905
- <dl>
906
- <dd>
907
-
908
- #### 📝 Description
909
-
910
- <dl>
911
- <dd>
912
-
961
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
913
962
  <dl>
914
963
  <dd>
915
964
 
916
- Get information about a browser window in a session, including the live view url.
917
-
918
- </dd>
919
- </dl>
920
- </dd>
921
- </dl>
922
-
923
965
  #### 🔌 Usage
924
966
 
925
967
  <dl>
@@ -929,8 +971,8 @@ Get information about a browser window in a session, including the live view url
929
971
  <dd>
930
972
 
931
973
  ```typescript
932
- await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
933
- screenResolution: "1280x720",
974
+ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
975
+ condition: "Determine if the user appears to be signed in to the website",
934
976
  });
935
977
  ```
936
978
 
@@ -947,7 +989,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
947
989
  <dl>
948
990
  <dd>
949
991
 
950
- **sessionId:** `string` — ID of the session that owns the window.
992
+ **sessionId:** `string` — The session id for the window.
951
993
 
952
994
  </dd>
953
995
  </dl>
@@ -955,7 +997,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
955
997
  <dl>
956
998
  <dd>
957
999
 
958
- **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.
1000
+ **windowId:** `string` — The Airtop window id of the browser window.
959
1001
 
960
1002
  </dd>
961
1003
  </dl>
@@ -963,7 +1005,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
963
1005
  <dl>
964
1006
  <dd>
965
1007
 
966
- **request:** `Airtop.GetWindowInfoRequest`
1008
+ **request:** `Airtop.SessionMonitorHandlerRequestBody`
967
1009
 
968
1010
  </dd>
969
1011
  </dl>
@@ -982,7 +1024,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
982
1024
  </dl>
983
1025
  </details>
984
1026
 
985
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
1027
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
986
1028
  <dl>
987
1029
  <dd>
988
1030
 
@@ -994,7 +1036,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
994
1036
  <dl>
995
1037
  <dd>
996
1038
 
997
- Loads a specified url on a given window
1039
+ 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?).
998
1040
 
999
1041
  </dd>
1000
1042
  </dl>
@@ -1010,8 +1052,8 @@ Loads a specified url on a given window
1010
1052
  <dd>
1011
1053
 
1012
1054
  ```typescript
1013
- await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1014
- url: "https://www.airtop.ai",
1055
+ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1056
+ prompt: "What is the main idea of this page?",
1015
1057
  });
1016
1058
  ```
1017
1059
 
@@ -1028,7 +1070,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1028
1070
  <dl>
1029
1071
  <dd>
1030
1072
 
1031
- **sessionId:** `string` — ID of the session that owns the window.
1073
+ **sessionId:** `string` — The session id for the window.
1032
1074
 
1033
1075
  </dd>
1034
1076
  </dl>
@@ -1036,7 +1078,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1036
1078
  <dl>
1037
1079
  <dd>
1038
1080
 
1039
- **windowId:** `string` — Airtop window ID of the browser window.
1081
+ **windowId:** `string` — The Airtop window id of the browser window.
1040
1082
 
1041
1083
  </dd>
1042
1084
  </dl>
@@ -1044,7 +1086,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1044
1086
  <dl>
1045
1087
  <dd>
1046
1088
 
1047
- **request:** `Airtop.WindowLoadUrlV1Body`
1089
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1048
1090
 
1049
1091
  </dd>
1050
1092
  </dl>
@@ -1063,7 +1105,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1063
1105
  </dl>
1064
1106
  </details>
1065
1107
 
1066
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
1108
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1067
1109
  <dl>
1068
1110
  <dd>
1069
1111
 
@@ -1075,7 +1117,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1075
1117
  <dl>
1076
1118
  <dd>
1077
1119
 
1078
- Closes a browser window in a session
1120
+ Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
1079
1121
 
1080
1122
  </dd>
1081
1123
  </dl>
@@ -1091,7 +1133,13 @@ Closes a browser window in a session
1091
1133
  <dd>
1092
1134
 
1093
1135
  ```typescript
1094
- await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
1136
+ await client.windows.paginatedExtraction(
1137
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
1138
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
1139
+ {
1140
+ 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.",
1141
+ },
1142
+ );
1095
1143
  ```
1096
1144
 
1097
1145
  </dd>
@@ -1107,7 +1155,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1107
1155
  <dl>
1108
1156
  <dd>
1109
1157
 
1110
- **sessionId:** `string` — ID of the session that owns the window.
1158
+ **sessionId:** `string` — The session id for the window.
1111
1159
 
1112
1160
  </dd>
1113
1161
  </dl>
@@ -1115,7 +1163,15 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1115
1163
  <dl>
1116
1164
  <dd>
1117
1165
 
1118
- **windowId:** `string` — Airtop window ID of the browser window.
1166
+ **windowId:** `string` — The Airtop window id of the browser window.
1167
+
1168
+ </dd>
1169
+ </dl>
1170
+
1171
+ <dl>
1172
+ <dd>
1173
+
1174
+ **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
1119
1175
 
1120
1176
  </dd>
1121
1177
  </dl>
@@ -1134,7 +1190,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1134
1190
  </dl>
1135
1191
  </details>
1136
1192
 
1137
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1193
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1138
1194
  <dl>
1139
1195
  <dd>
1140
1196
 
@@ -1146,7 +1202,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1146
1202
  <dl>
1147
1203
  <dd>
1148
1204
 
1149
- Execute a click interaction in a specific browser window
1205
+ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
1150
1206
 
1151
1207
  </dd>
1152
1208
  </dl>
@@ -1162,8 +1218,8 @@ Execute a click interaction in a specific browser window
1162
1218
  <dd>
1163
1219
 
1164
1220
  ```typescript
1165
- await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1166
- elementDescription: "The login button",
1221
+ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1222
+ prompt: "What is the main idea of this page?",
1167
1223
  });
1168
1224
  ```
1169
1225
 
@@ -1196,7 +1252,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1196
1252
  <dl>
1197
1253
  <dd>
1198
1254
 
1199
- **request:** `Airtop.SessionClickHandlerRequestBody`
1255
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1200
1256
 
1201
1257
  </dd>
1202
1258
  </dl>
@@ -1215,7 +1271,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1215
1271
  </dl>
1216
1272
  </details>
1217
1273
 
1218
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1274
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
1219
1275
  <dl>
1220
1276
  <dd>
1221
1277
 
@@ -1227,7 +1283,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1227
1283
  <dl>
1228
1284
  <dd>
1229
1285
 
1230
- Execute a hover interaction in a specific browser window
1286
+ Scrape a window and return the content as markdown
1231
1287
 
1232
1288
  </dd>
1233
1289
  </dl>
@@ -1243,9 +1299,7 @@ Execute a hover interaction in a specific browser window
1243
1299
  <dd>
1244
1300
 
1245
1301
  ```typescript
1246
- await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1247
- elementDescription: "The search box input in the top right corner",
1248
- });
1302
+ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1249
1303
  ```
1250
1304
 
1251
1305
  </dd>
@@ -1269,7 +1323,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1269
1323
  <dl>
1270
1324
  <dd>
1271
1325
 
1272
- **windowId:** `string` — The Airtop window id of the browser window.
1326
+ **windowId:** `string` — The Airtop window id of the browser window to scrape.
1273
1327
 
1274
1328
  </dd>
1275
1329
  </dl>
@@ -1277,7 +1331,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1277
1331
  <dl>
1278
1332
  <dd>
1279
1333
 
1280
- **request:** `Airtop.SessionHoverHandlerRequestBody`
1334
+ **request:** `Airtop.ScrapeContentRequest`
1281
1335
 
1282
1336
  </dd>
1283
1337
  </dl>
@@ -1296,10 +1350,25 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1296
1350
  </dl>
1297
1351
  </details>
1298
1352
 
1299
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1353
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1354
+ <dl>
1355
+ <dd>
1356
+
1357
+ #### 📝 Description
1358
+
1359
+ <dl>
1360
+ <dd>
1361
+
1300
1362
  <dl>
1301
1363
  <dd>
1302
1364
 
1365
+ Take a screenshot of a browser window
1366
+
1367
+ </dd>
1368
+ </dl>
1369
+ </dd>
1370
+ </dl>
1371
+
1303
1372
  #### 🔌 Usage
1304
1373
 
1305
1374
  <dl>
@@ -1309,9 +1378,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1309
1378
  <dd>
1310
1379
 
1311
1380
  ```typescript
1312
- await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1313
- condition: "Determine if the user appears to be signed in to the website",
1314
- });
1381
+ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1315
1382
  ```
1316
1383
 
1317
1384
  </dd>
@@ -1343,7 +1410,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1343
1410
  <dl>
1344
1411
  <dd>
1345
1412
 
1346
- **request:** `Airtop.SessionMonitorHandlerRequestBody`
1413
+ **request:** `Airtop.SessionScreenshotHandlerRequestBody`
1347
1414
 
1348
1415
  </dd>
1349
1416
  </dl>
@@ -1362,7 +1429,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1362
1429
  </dl>
1363
1430
  </details>
1364
1431
 
1365
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1432
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1366
1433
  <dl>
1367
1434
  <dd>
1368
1435
 
@@ -1374,7 +1441,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1374
1441
  <dl>
1375
1442
  <dd>
1376
1443
 
1377
- 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?).
1444
+ Execute a scroll interaction in a specific browser window
1378
1445
 
1379
1446
  </dd>
1380
1447
  </dl>
@@ -1390,9 +1457,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
1390
1457
  <dd>
1391
1458
 
1392
1459
  ```typescript
1393
- await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1394
- prompt: "What is the main idea of this page?",
1395
- });
1460
+ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1396
1461
  ```
1397
1462
 
1398
1463
  </dd>
@@ -1424,7 +1489,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1424
1489
  <dl>
1425
1490
  <dd>
1426
1491
 
1427
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1492
+ **request:** `Airtop.SessionScrollHandlerRequestBody`
1428
1493
 
1429
1494
  </dd>
1430
1495
  </dl>
@@ -1443,7 +1508,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1443
1508
  </dl>
1444
1509
  </details>
1445
1510
 
1446
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1511
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1447
1512
  <dl>
1448
1513
  <dd>
1449
1514
 
@@ -1455,7 +1520,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1455
1520
  <dl>
1456
1521
  <dd>
1457
1522
 
1458
- Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
1523
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1459
1524
 
1460
1525
  </dd>
1461
1526
  </dl>
@@ -1471,13 +1536,7 @@ Submit a prompt that queries the content of a specific browser window and pagina
1471
1536
  <dd>
1472
1537
 
1473
1538
  ```typescript
1474
- await client.windows.paginatedExtraction(
1475
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
1476
- "0334da2a-91b0-42c5-6156-76a5eba87430",
1477
- {
1478
- 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.",
1479
- },
1480
- );
1539
+ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1481
1540
  ```
1482
1541
 
1483
1542
  </dd>
@@ -1501,7 +1560,7 @@ await client.windows.paginatedExtraction(
1501
1560
  <dl>
1502
1561
  <dd>
1503
1562
 
1504
- **windowId:** `string` — The Airtop window id of the browser window.
1563
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
1505
1564
 
1506
1565
  </dd>
1507
1566
  </dl>
@@ -1509,7 +1568,7 @@ await client.windows.paginatedExtraction(
1509
1568
  <dl>
1510
1569
  <dd>
1511
1570
 
1512
- **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
1571
+ **request:** `Airtop.SessionSummaryHandlerRequestBody`
1513
1572
 
1514
1573
  </dd>
1515
1574
  </dl>
@@ -1528,7 +1587,7 @@ await client.windows.paginatedExtraction(
1528
1587
  </dl>
1529
1588
  </details>
1530
1589
 
1531
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1590
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1532
1591
  <dl>
1533
1592
  <dd>
1534
1593
 
@@ -1540,7 +1599,7 @@ await client.windows.paginatedExtraction(
1540
1599
  <dl>
1541
1600
  <dd>
1542
1601
 
1543
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
1602
+ Execute a type interaction in a specific browser window
1544
1603
 
1545
1604
  </dd>
1546
1605
  </dl>
@@ -1556,8 +1615,8 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
1556
1615
  <dd>
1557
1616
 
1558
1617
  ```typescript
1559
- await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1560
- prompt: "What is the main idea of this page?",
1618
+ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1619
+ text: "Example text",
1561
1620
  });
1562
1621
  ```
1563
1622
 
@@ -1590,7 +1649,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1590
1649
  <dl>
1591
1650
  <dd>
1592
1651
 
1593
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1652
+ **request:** `Airtop.SessionTypeHandlerRequestBody`
1594
1653
 
1595
1654
  </dd>
1596
1655
  </dl>
@@ -1609,7 +1668,9 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1609
1668
  </dl>
1610
1669
  </details>
1611
1670
 
1612
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
1671
+ ## Automations
1672
+
1673
+ <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">list</a>() -> Airtop.ListAutomationsOutput</code></summary>
1613
1674
  <dl>
1614
1675
  <dd>
1615
1676
 
@@ -1621,7 +1682,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1621
1682
  <dl>
1622
1683
  <dd>
1623
1684
 
1624
- Scrape a window and return the content as markdown
1685
+ List all automations for a given organization
1625
1686
 
1626
1687
  </dd>
1627
1688
  </dl>
@@ -1637,7 +1698,7 @@ Scrape a window and return the content as markdown
1637
1698
  <dd>
1638
1699
 
1639
1700
  ```typescript
1640
- await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1701
+ await client.automations.list();
1641
1702
  ```
1642
1703
 
1643
1704
  </dd>
@@ -1653,31 +1714,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1653
1714
  <dl>
1654
1715
  <dd>
1655
1716
 
1656
- **sessionId:** `string` — The session id for the window.
1657
-
1658
- </dd>
1659
- </dl>
1660
-
1661
- <dl>
1662
- <dd>
1663
-
1664
- **windowId:** `string` — The Airtop window id of the browser window to scrape.
1665
-
1666
- </dd>
1667
- </dl>
1668
-
1669
- <dl>
1670
- <dd>
1671
-
1672
- **request:** `Airtop.ScrapeContentRequest`
1673
-
1674
- </dd>
1675
- </dl>
1676
-
1677
- <dl>
1678
- <dd>
1679
-
1680
- **requestOptions:** `Windows.RequestOptions`
1717
+ **requestOptions:** `Automations.RequestOptions`
1681
1718
 
1682
1719
  </dd>
1683
1720
  </dl>
@@ -1688,7 +1725,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1688
1725
  </dl>
1689
1726
  </details>
1690
1727
 
1691
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1728
+ <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">update</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
1692
1729
  <dl>
1693
1730
  <dd>
1694
1731
 
@@ -1700,7 +1737,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1700
1737
  <dl>
1701
1738
  <dd>
1702
1739
 
1703
- Take a screenshot of a browser window
1740
+ Update the description of a specific automation
1704
1741
 
1705
1742
  </dd>
1706
1743
  </dl>
@@ -1716,7 +1753,11 @@ Take a screenshot of a browser window
1716
1753
  <dd>
1717
1754
 
1718
1755
  ```typescript
1719
- await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1756
+ await client.automations.update({
1757
+ description: "description",
1758
+ id: "id",
1759
+ orgId: "orgId",
1760
+ });
1720
1761
  ```
1721
1762
 
1722
1763
  </dd>
@@ -1732,23 +1773,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
1732
1773
  <dl>
1733
1774
  <dd>
1734
1775
 
1735
- **sessionId:** `string` — The session id for the window.
1736
-
1737
- </dd>
1738
- </dl>
1739
-
1740
- <dl>
1741
- <dd>
1742
-
1743
- **windowId:** `string` — The Airtop window id of the browser window.
1744
-
1745
- </dd>
1746
- </dl>
1747
-
1748
- <dl>
1749
- <dd>
1750
-
1751
- **request:** `Airtop.SessionScreenshotHandlerRequestBody`
1776
+ **request:** `Airtop.UpdateAutomationDescriptionInputBody`
1752
1777
 
1753
1778
  </dd>
1754
1779
  </dl>
@@ -1756,7 +1781,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
1756
1781
  <dl>
1757
1782
  <dd>
1758
1783
 
1759
- **requestOptions:** `Windows.RequestOptions`
1784
+ **requestOptions:** `Automations.RequestOptions`
1760
1785
 
1761
1786
  </dd>
1762
1787
  </dl>
@@ -1767,7 +1792,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
1767
1792
  </dl>
1768
1793
  </details>
1769
1794
 
1770
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1795
+ <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">get</a>(automationId) -> Airtop.AutomationOutput</code></summary>
1771
1796
  <dl>
1772
1797
  <dd>
1773
1798
 
@@ -1779,7 +1804,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
1779
1804
  <dl>
1780
1805
  <dd>
1781
1806
 
1782
- Execute a scroll interaction in a specific browser window
1807
+ Get a specific automation by ID
1783
1808
 
1784
1809
  </dd>
1785
1810
  </dl>
@@ -1795,7 +1820,7 @@ Execute a scroll interaction in a specific browser window
1795
1820
  <dd>
1796
1821
 
1797
1822
  ```typescript
1798
- await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1823
+ await client.automations.get("automationId");
1799
1824
  ```
1800
1825
 
1801
1826
  </dd>
@@ -1811,23 +1836,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1811
1836
  <dl>
1812
1837
  <dd>
1813
1838
 
1814
- **sessionId:** `string` — The session id for the window.
1815
-
1816
- </dd>
1817
- </dl>
1818
-
1819
- <dl>
1820
- <dd>
1821
-
1822
- **windowId:** `string` — The Airtop window id of the browser window.
1823
-
1824
- </dd>
1825
- </dl>
1826
-
1827
- <dl>
1828
- <dd>
1829
-
1830
- **request:** `Airtop.SessionScrollHandlerRequestBody`
1839
+ **automationId:** `string` — ID of the automation to retrieve
1831
1840
 
1832
1841
  </dd>
1833
1842
  </dl>
@@ -1835,7 +1844,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1835
1844
  <dl>
1836
1845
  <dd>
1837
1846
 
1838
- **requestOptions:** `Windows.RequestOptions`
1847
+ **requestOptions:** `Automations.RequestOptions`
1839
1848
 
1840
1849
  </dd>
1841
1850
  </dl>
@@ -1846,7 +1855,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1846
1855
  </dl>
1847
1856
  </details>
1848
1857
 
1849
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1858
+ <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">delete</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
1850
1859
  <dl>
1851
1860
  <dd>
1852
1861
 
@@ -1858,7 +1867,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1858
1867
  <dl>
1859
1868
  <dd>
1860
1869
 
1861
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1870
+ Delete a specific automation
1862
1871
 
1863
1872
  </dd>
1864
1873
  </dl>
@@ -1874,7 +1883,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
1874
1883
  <dd>
1875
1884
 
1876
1885
  ```typescript
1877
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1886
+ await client.automations.delete("automationId");
1878
1887
  ```
1879
1888
 
1880
1889
  </dd>
@@ -1890,23 +1899,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1890
1899
  <dl>
1891
1900
  <dd>
1892
1901
 
1893
- **sessionId:** `string` — The session id for the window.
1894
-
1895
- </dd>
1896
- </dl>
1897
-
1898
- <dl>
1899
- <dd>
1900
-
1901
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
1902
-
1903
- </dd>
1904
- </dl>
1905
-
1906
- <dl>
1907
- <dd>
1908
-
1909
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
1902
+ **automationId:** `string` — ID of the automation to delete
1910
1903
 
1911
1904
  </dd>
1912
1905
  </dl>
@@ -1914,7 +1907,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1914
1907
  <dl>
1915
1908
  <dd>
1916
1909
 
1917
- **requestOptions:** `Windows.RequestOptions`
1910
+ **requestOptions:** `Automations.RequestOptions`
1918
1911
 
1919
1912
  </dd>
1920
1913
  </dl>
@@ -1925,7 +1918,9 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1925
1918
  </dl>
1926
1919
  </details>
1927
1920
 
1928
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1921
+ ## Profiles
1922
+
1923
+ <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
1929
1924
  <dl>
1930
1925
  <dd>
1931
1926
 
@@ -1937,7 +1932,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1937
1932
  <dl>
1938
1933
  <dd>
1939
1934
 
1940
- Execute a type interaction in a specific browser window
1935
+ Delete profiles matching by id
1941
1936
 
1942
1937
  </dd>
1943
1938
  </dl>
@@ -1953,9 +1948,7 @@ Execute a type interaction in a specific browser window
1953
1948
  <dd>
1954
1949
 
1955
1950
  ```typescript
1956
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1957
- text: "Example text",
1958
- });
1951
+ await client.profiles.delete();
1959
1952
  ```
1960
1953
 
1961
1954
  </dd>
@@ -1971,23 +1964,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
1971
1964
  <dl>
1972
1965
  <dd>
1973
1966
 
1974
- **sessionId:** `string` — The session id for the window.
1975
-
1976
- </dd>
1977
- </dl>
1978
-
1979
- <dl>
1980
- <dd>
1981
-
1982
- **windowId:** `string` — The Airtop window id of the browser window.
1983
-
1984
- </dd>
1985
- </dl>
1986
-
1987
- <dl>
1988
- <dd>
1989
-
1990
- **request:** `Airtop.SessionTypeHandlerRequestBody`
1967
+ **request:** `Airtop.ProfilesDeleteRequest`
1991
1968
 
1992
1969
  </dd>
1993
1970
  </dl>
@@ -1995,7 +1972,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
1995
1972
  <dl>
1996
1973
  <dd>
1997
1974
 
1998
- **requestOptions:** `Windows.RequestOptions`
1975
+ **requestOptions:** `Profiles.RequestOptions`
1999
1976
 
2000
1977
  </dd>
2001
1978
  </dl>
@@ -2006,13 +1983,13 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
2006
1983
  </dl>
2007
1984
  </details>
2008
1985
 
2009
- ## Automations
1986
+ ## Requests
2010
1987
 
2011
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">listAutomations</a>() -> Airtop.ListAutomationsOutput</code></summary>
1988
+ <details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
2012
1989
  <dl>
2013
1990
  <dd>
2014
1991
 
2015
- #### 📝 Description
1992
+ #### 🔌 Usage
2016
1993
 
2017
1994
  <dl>
2018
1995
  <dd>
@@ -2020,14 +1997,16 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
2020
1997
  <dl>
2021
1998
  <dd>
2022
1999
 
2023
- List all automations for a given organization
2000
+ ```typescript
2001
+ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
2002
+ ```
2024
2003
 
2025
2004
  </dd>
2026
2005
  </dl>
2027
2006
  </dd>
2028
2007
  </dl>
2029
2008
 
2030
- #### 🔌 Usage
2009
+ #### ⚙️ Parameters
2031
2010
 
2032
2011
  <dl>
2033
2012
  <dd>
@@ -2035,24 +2014,15 @@ List all automations for a given organization
2035
2014
  <dl>
2036
2015
  <dd>
2037
2016
 
2038
- ```typescript
2039
- await client.automations.listAutomations();
2040
- ```
2017
+ **requestId:** `string` — The ID of the request to check.
2041
2018
 
2042
2019
  </dd>
2043
2020
  </dl>
2044
- </dd>
2045
- </dl>
2046
-
2047
- #### ⚙️ Parameters
2048
-
2049
- <dl>
2050
- <dd>
2051
2021
 
2052
2022
  <dl>
2053
2023
  <dd>
2054
2024
 
2055
- **requestOptions:** `Automations.RequestOptions`
2025
+ **requestOptions:** `Requests.RequestOptions`
2056
2026
 
2057
2027
  </dd>
2058
2028
  </dl>
@@ -2063,26 +2033,13 @@ await client.automations.listAutomations();
2063
2033
  </dl>
2064
2034
  </details>
2065
2035
 
2066
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">updateAutomationDescription</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
2067
- <dl>
2068
- <dd>
2069
-
2070
- #### 📝 Description
2071
-
2072
- <dl>
2073
- <dd>
2036
+ ## Sessions
2074
2037
 
2038
+ <details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
2075
2039
  <dl>
2076
2040
  <dd>
2077
2041
 
2078
- Update the description of a specific automation
2079
-
2080
- </dd>
2081
- </dl>
2082
- </dd>
2083
- </dl>
2084
-
2085
- #### 🔌 Usage
2042
+ #### 📝 Description
2086
2043
 
2087
2044
  <dl>
2088
2045
  <dd>
@@ -2090,980 +2047,6 @@ Update the description of a specific automation
2090
2047
  <dl>
2091
2048
  <dd>
2092
2049
 
2093
- ```typescript
2094
- await client.automations.updateAutomationDescription({
2095
- description: "description",
2096
- id: "id",
2097
- orgId: "orgId",
2098
- });
2099
- ```
2100
-
2101
- </dd>
2102
- </dl>
2103
- </dd>
2104
- </dl>
2105
-
2106
- #### ⚙️ Parameters
2107
-
2108
- <dl>
2109
- <dd>
2110
-
2111
- <dl>
2112
- <dd>
2113
-
2114
- **request:** `Airtop.UpdateAutomationDescriptionInputBody`
2115
-
2116
- </dd>
2117
- </dl>
2118
-
2119
- <dl>
2120
- <dd>
2121
-
2122
- **requestOptions:** `Automations.RequestOptions`
2123
-
2124
- </dd>
2125
- </dl>
2126
- </dd>
2127
- </dl>
2128
-
2129
- </dd>
2130
- </dl>
2131
- </details>
2132
-
2133
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">getAutomation</a>(automationId) -> Airtop.AutomationOutput</code></summary>
2134
- <dl>
2135
- <dd>
2136
-
2137
- #### 📝 Description
2138
-
2139
- <dl>
2140
- <dd>
2141
-
2142
- <dl>
2143
- <dd>
2144
-
2145
- Get a specific automation by ID
2146
-
2147
- </dd>
2148
- </dl>
2149
- </dd>
2150
- </dl>
2151
-
2152
- #### 🔌 Usage
2153
-
2154
- <dl>
2155
- <dd>
2156
-
2157
- <dl>
2158
- <dd>
2159
-
2160
- ```typescript
2161
- await client.automations.getAutomation("automationId");
2162
- ```
2163
-
2164
- </dd>
2165
- </dl>
2166
- </dd>
2167
- </dl>
2168
-
2169
- #### ⚙️ Parameters
2170
-
2171
- <dl>
2172
- <dd>
2173
-
2174
- <dl>
2175
- <dd>
2176
-
2177
- **automationId:** `string` — ID of the automation to retrieve
2178
-
2179
- </dd>
2180
- </dl>
2181
-
2182
- <dl>
2183
- <dd>
2184
-
2185
- **requestOptions:** `Automations.RequestOptions`
2186
-
2187
- </dd>
2188
- </dl>
2189
- </dd>
2190
- </dl>
2191
-
2192
- </dd>
2193
- </dl>
2194
- </details>
2195
-
2196
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">deleteAutomation</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
2197
- <dl>
2198
- <dd>
2199
-
2200
- #### 📝 Description
2201
-
2202
- <dl>
2203
- <dd>
2204
-
2205
- <dl>
2206
- <dd>
2207
-
2208
- Delete a specific automation
2209
-
2210
- </dd>
2211
- </dl>
2212
- </dd>
2213
- </dl>
2214
-
2215
- #### 🔌 Usage
2216
-
2217
- <dl>
2218
- <dd>
2219
-
2220
- <dl>
2221
- <dd>
2222
-
2223
- ```typescript
2224
- await client.automations.deleteAutomation("automationId");
2225
- ```
2226
-
2227
- </dd>
2228
- </dl>
2229
- </dd>
2230
- </dl>
2231
-
2232
- #### ⚙️ Parameters
2233
-
2234
- <dl>
2235
- <dd>
2236
-
2237
- <dl>
2238
- <dd>
2239
-
2240
- **automationId:** `string` — ID of the automation to delete
2241
-
2242
- </dd>
2243
- </dl>
2244
-
2245
- <dl>
2246
- <dd>
2247
-
2248
- **requestOptions:** `Automations.RequestOptions`
2249
-
2250
- </dd>
2251
- </dl>
2252
- </dd>
2253
- </dl>
2254
-
2255
- </dd>
2256
- </dl>
2257
- </details>
2258
-
2259
- ## Files
2260
-
2261
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">list</a>({ ...params }) -> Airtop.FilesResponse</code></summary>
2262
- <dl>
2263
- <dd>
2264
-
2265
- #### 📝 Description
2266
-
2267
- <dl>
2268
- <dd>
2269
-
2270
- <dl>
2271
- <dd>
2272
-
2273
- Get a list of files filtered by session ID
2274
-
2275
- </dd>
2276
- </dl>
2277
- </dd>
2278
- </dl>
2279
-
2280
- #### 🔌 Usage
2281
-
2282
- <dl>
2283
- <dd>
2284
-
2285
- <dl>
2286
- <dd>
2287
-
2288
- ```typescript
2289
- await client.files.list({
2290
- offset: 1,
2291
- limit: 10,
2292
- });
2293
- ```
2294
-
2295
- </dd>
2296
- </dl>
2297
- </dd>
2298
- </dl>
2299
-
2300
- #### ⚙️ Parameters
2301
-
2302
- <dl>
2303
- <dd>
2304
-
2305
- <dl>
2306
- <dd>
2307
-
2308
- **request:** `Airtop.FilesListRequest`
2309
-
2310
- </dd>
2311
- </dl>
2312
-
2313
- <dl>
2314
- <dd>
2315
-
2316
- **requestOptions:** `Files.RequestOptions`
2317
-
2318
- </dd>
2319
- </dl>
2320
- </dd>
2321
- </dl>
2322
-
2323
- </dd>
2324
- </dl>
2325
- </details>
2326
-
2327
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">create</a>({ ...params }) -> Airtop.EnvelopeCreateFileV1EnvelopeDefaultMeta</code></summary>
2328
- <dl>
2329
- <dd>
2330
-
2331
- #### 🔌 Usage
2332
-
2333
- <dl>
2334
- <dd>
2335
-
2336
- <dl>
2337
- <dd>
2338
-
2339
- ```typescript
2340
- await client.files.create({
2341
- fileName: "fileName",
2342
- });
2343
- ```
2344
-
2345
- </dd>
2346
- </dl>
2347
- </dd>
2348
- </dl>
2349
-
2350
- #### ⚙️ Parameters
2351
-
2352
- <dl>
2353
- <dd>
2354
-
2355
- <dl>
2356
- <dd>
2357
-
2358
- **request:** `Airtop.CreateFileRestInputV1`
2359
-
2360
- </dd>
2361
- </dl>
2362
-
2363
- <dl>
2364
- <dd>
2365
-
2366
- **requestOptions:** `Files.RequestOptions`
2367
-
2368
- </dd>
2369
- </dl>
2370
- </dd>
2371
- </dl>
2372
-
2373
- </dd>
2374
- </dl>
2375
- </details>
2376
-
2377
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">get</a>(id) -> Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta</code></summary>
2378
- <dl>
2379
- <dd>
2380
-
2381
- #### 🔌 Usage
2382
-
2383
- <dl>
2384
- <dd>
2385
-
2386
- <dl>
2387
- <dd>
2388
-
2389
- ```typescript
2390
- await client.files.get("id");
2391
- ```
2392
-
2393
- </dd>
2394
- </dl>
2395
- </dd>
2396
- </dl>
2397
-
2398
- #### ⚙️ Parameters
2399
-
2400
- <dl>
2401
- <dd>
2402
-
2403
- <dl>
2404
- <dd>
2405
-
2406
- **id:** `string` — ID of the file
2407
-
2408
- </dd>
2409
- </dl>
2410
-
2411
- <dl>
2412
- <dd>
2413
-
2414
- **requestOptions:** `Files.RequestOptions`
2415
-
2416
- </dd>
2417
- </dl>
2418
- </dd>
2419
- </dl>
2420
-
2421
- </dd>
2422
- </dl>
2423
- </details>
2424
-
2425
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> void</code></summary>
2426
- <dl>
2427
- <dd>
2428
-
2429
- #### 🔌 Usage
2430
-
2431
- <dl>
2432
- <dd>
2433
-
2434
- <dl>
2435
- <dd>
2436
-
2437
- ```typescript
2438
- await client.files.delete("id");
2439
- ```
2440
-
2441
- </dd>
2442
- </dl>
2443
- </dd>
2444
- </dl>
2445
-
2446
- #### ⚙️ Parameters
2447
-
2448
- <dl>
2449
- <dd>
2450
-
2451
- <dl>
2452
- <dd>
2453
-
2454
- **id:** `string` — ID of the file
2455
-
2456
- </dd>
2457
- </dl>
2458
-
2459
- <dl>
2460
- <dd>
2461
-
2462
- **requestOptions:** `Files.RequestOptions`
2463
-
2464
- </dd>
2465
- </dl>
2466
- </dd>
2467
- </dl>
2468
-
2469
- </dd>
2470
- </dl>
2471
- </details>
2472
-
2473
- ## Automations
2474
-
2475
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">listAutomations</a>() -> Airtop.ListAutomationsOutput</code></summary>
2476
- <dl>
2477
- <dd>
2478
-
2479
- #### 📝 Description
2480
-
2481
- <dl>
2482
- <dd>
2483
-
2484
- <dl>
2485
- <dd>
2486
-
2487
- List all automations for a given organization
2488
-
2489
- </dd>
2490
- </dl>
2491
- </dd>
2492
- </dl>
2493
-
2494
- #### 🔌 Usage
2495
-
2496
- <dl>
2497
- <dd>
2498
-
2499
- <dl>
2500
- <dd>
2501
-
2502
- ```typescript
2503
- await client.automations.listAutomations();
2504
- ```
2505
-
2506
- </dd>
2507
- </dl>
2508
- </dd>
2509
- </dl>
2510
-
2511
- #### ⚙️ Parameters
2512
-
2513
- <dl>
2514
- <dd>
2515
-
2516
- <dl>
2517
- <dd>
2518
-
2519
- **requestOptions:** `Automations.RequestOptions`
2520
-
2521
- </dd>
2522
- </dl>
2523
- </dd>
2524
- </dl>
2525
-
2526
- </dd>
2527
- </dl>
2528
- </details>
2529
-
2530
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">updateAutomationDescription</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
2531
- <dl>
2532
- <dd>
2533
-
2534
- #### 📝 Description
2535
-
2536
- <dl>
2537
- <dd>
2538
-
2539
- <dl>
2540
- <dd>
2541
-
2542
- Update the description of a specific automation
2543
-
2544
- </dd>
2545
- </dl>
2546
- </dd>
2547
- </dl>
2548
-
2549
- #### 🔌 Usage
2550
-
2551
- <dl>
2552
- <dd>
2553
-
2554
- <dl>
2555
- <dd>
2556
-
2557
- ```typescript
2558
- await client.automations.updateAutomationDescription({
2559
- description: "description",
2560
- id: "id",
2561
- orgId: "orgId",
2562
- });
2563
- ```
2564
-
2565
- </dd>
2566
- </dl>
2567
- </dd>
2568
- </dl>
2569
-
2570
- #### ⚙️ Parameters
2571
-
2572
- <dl>
2573
- <dd>
2574
-
2575
- <dl>
2576
- <dd>
2577
-
2578
- **request:** `Airtop.UpdateAutomationDescriptionInputBody`
2579
-
2580
- </dd>
2581
- </dl>
2582
-
2583
- <dl>
2584
- <dd>
2585
-
2586
- **requestOptions:** `Automations.RequestOptions`
2587
-
2588
- </dd>
2589
- </dl>
2590
- </dd>
2591
- </dl>
2592
-
2593
- </dd>
2594
- </dl>
2595
- </details>
2596
-
2597
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">getAutomation</a>(automationId) -> Airtop.AutomationOutput</code></summary>
2598
- <dl>
2599
- <dd>
2600
-
2601
- #### 📝 Description
2602
-
2603
- <dl>
2604
- <dd>
2605
-
2606
- <dl>
2607
- <dd>
2608
-
2609
- Get a specific automation by ID
2610
-
2611
- </dd>
2612
- </dl>
2613
- </dd>
2614
- </dl>
2615
-
2616
- #### 🔌 Usage
2617
-
2618
- <dl>
2619
- <dd>
2620
-
2621
- <dl>
2622
- <dd>
2623
-
2624
- ```typescript
2625
- await client.automations.getAutomation("automationId");
2626
- ```
2627
-
2628
- </dd>
2629
- </dl>
2630
- </dd>
2631
- </dl>
2632
-
2633
- #### ⚙️ Parameters
2634
-
2635
- <dl>
2636
- <dd>
2637
-
2638
- <dl>
2639
- <dd>
2640
-
2641
- **automationId:** `string` — ID of the automation to retrieve
2642
-
2643
- </dd>
2644
- </dl>
2645
-
2646
- <dl>
2647
- <dd>
2648
-
2649
- **requestOptions:** `Automations.RequestOptions`
2650
-
2651
- </dd>
2652
- </dl>
2653
- </dd>
2654
- </dl>
2655
-
2656
- </dd>
2657
- </dl>
2658
- </details>
2659
-
2660
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">deleteAutomation</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
2661
- <dl>
2662
- <dd>
2663
-
2664
- #### 📝 Description
2665
-
2666
- <dl>
2667
- <dd>
2668
-
2669
- <dl>
2670
- <dd>
2671
-
2672
- Delete a specific automation
2673
-
2674
- </dd>
2675
- </dl>
2676
- </dd>
2677
- </dl>
2678
-
2679
- #### 🔌 Usage
2680
-
2681
- <dl>
2682
- <dd>
2683
-
2684
- <dl>
2685
- <dd>
2686
-
2687
- ```typescript
2688
- await client.automations.deleteAutomation("automationId");
2689
- ```
2690
-
2691
- </dd>
2692
- </dl>
2693
- </dd>
2694
- </dl>
2695
-
2696
- #### ⚙️ Parameters
2697
-
2698
- <dl>
2699
- <dd>
2700
-
2701
- <dl>
2702
- <dd>
2703
-
2704
- **automationId:** `string` — ID of the automation to delete
2705
-
2706
- </dd>
2707
- </dl>
2708
-
2709
- <dl>
2710
- <dd>
2711
-
2712
- **requestOptions:** `Automations.RequestOptions`
2713
-
2714
- </dd>
2715
- </dl>
2716
- </dd>
2717
- </dl>
2718
-
2719
- </dd>
2720
- </dl>
2721
- </details>
2722
-
2723
- ## Files
2724
-
2725
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">list</a>({ ...params }) -> Airtop.FilesResponse</code></summary>
2726
- <dl>
2727
- <dd>
2728
-
2729
- #### 📝 Description
2730
-
2731
- <dl>
2732
- <dd>
2733
-
2734
- <dl>
2735
- <dd>
2736
-
2737
- Get a list of files filtered by session ID
2738
-
2739
- </dd>
2740
- </dl>
2741
- </dd>
2742
- </dl>
2743
-
2744
- #### 🔌 Usage
2745
-
2746
- <dl>
2747
- <dd>
2748
-
2749
- <dl>
2750
- <dd>
2751
-
2752
- ```typescript
2753
- await client.files.list({
2754
- offset: 1,
2755
- limit: 10,
2756
- });
2757
- ```
2758
-
2759
- </dd>
2760
- </dl>
2761
- </dd>
2762
- </dl>
2763
-
2764
- #### ⚙️ Parameters
2765
-
2766
- <dl>
2767
- <dd>
2768
-
2769
- <dl>
2770
- <dd>
2771
-
2772
- **request:** `Airtop.FilesListRequest`
2773
-
2774
- </dd>
2775
- </dl>
2776
-
2777
- <dl>
2778
- <dd>
2779
-
2780
- **requestOptions:** `Files.RequestOptions`
2781
-
2782
- </dd>
2783
- </dl>
2784
- </dd>
2785
- </dl>
2786
-
2787
- </dd>
2788
- </dl>
2789
- </details>
2790
-
2791
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">create</a>({ ...params }) -> Airtop.EnvelopeCreateFileV1EnvelopeDefaultMeta</code></summary>
2792
- <dl>
2793
- <dd>
2794
-
2795
- #### 🔌 Usage
2796
-
2797
- <dl>
2798
- <dd>
2799
-
2800
- <dl>
2801
- <dd>
2802
-
2803
- ```typescript
2804
- await client.files.create({
2805
- fileName: "fileName",
2806
- });
2807
- ```
2808
-
2809
- </dd>
2810
- </dl>
2811
- </dd>
2812
- </dl>
2813
-
2814
- #### ⚙️ Parameters
2815
-
2816
- <dl>
2817
- <dd>
2818
-
2819
- <dl>
2820
- <dd>
2821
-
2822
- **request:** `Airtop.CreateFileRestInputV1`
2823
-
2824
- </dd>
2825
- </dl>
2826
-
2827
- <dl>
2828
- <dd>
2829
-
2830
- **requestOptions:** `Files.RequestOptions`
2831
-
2832
- </dd>
2833
- </dl>
2834
- </dd>
2835
- </dl>
2836
-
2837
- </dd>
2838
- </dl>
2839
- </details>
2840
-
2841
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">get</a>(id) -> Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta</code></summary>
2842
- <dl>
2843
- <dd>
2844
-
2845
- #### 🔌 Usage
2846
-
2847
- <dl>
2848
- <dd>
2849
-
2850
- <dl>
2851
- <dd>
2852
-
2853
- ```typescript
2854
- await client.files.get("id");
2855
- ```
2856
-
2857
- </dd>
2858
- </dl>
2859
- </dd>
2860
- </dl>
2861
-
2862
- #### ⚙️ Parameters
2863
-
2864
- <dl>
2865
- <dd>
2866
-
2867
- <dl>
2868
- <dd>
2869
-
2870
- **id:** `string` — ID of the file
2871
-
2872
- </dd>
2873
- </dl>
2874
-
2875
- <dl>
2876
- <dd>
2877
-
2878
- **requestOptions:** `Files.RequestOptions`
2879
-
2880
- </dd>
2881
- </dl>
2882
- </dd>
2883
- </dl>
2884
-
2885
- </dd>
2886
- </dl>
2887
- </details>
2888
-
2889
- <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> void</code></summary>
2890
- <dl>
2891
- <dd>
2892
-
2893
- #### 🔌 Usage
2894
-
2895
- <dl>
2896
- <dd>
2897
-
2898
- <dl>
2899
- <dd>
2900
-
2901
- ```typescript
2902
- await client.files.delete("id");
2903
- ```
2904
-
2905
- </dd>
2906
- </dl>
2907
- </dd>
2908
- </dl>
2909
-
2910
- #### ⚙️ Parameters
2911
-
2912
- <dl>
2913
- <dd>
2914
-
2915
- <dl>
2916
- <dd>
2917
-
2918
- **id:** `string` — ID of the file
2919
-
2920
- </dd>
2921
- </dl>
2922
-
2923
- <dl>
2924
- <dd>
2925
-
2926
- **requestOptions:** `Files.RequestOptions`
2927
-
2928
- </dd>
2929
- </dl>
2930
- </dd>
2931
- </dl>
2932
-
2933
- </dd>
2934
- </dl>
2935
- </details>
2936
-
2937
- ## Profiles
2938
-
2939
- <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
2940
- <dl>
2941
- <dd>
2942
-
2943
- #### 📝 Description
2944
-
2945
- <dl>
2946
- <dd>
2947
-
2948
- <dl>
2949
- <dd>
2950
-
2951
- Delete profiles matching by id
2952
-
2953
- </dd>
2954
- </dl>
2955
- </dd>
2956
- </dl>
2957
-
2958
- #### 🔌 Usage
2959
-
2960
- <dl>
2961
- <dd>
2962
-
2963
- <dl>
2964
- <dd>
2965
-
2966
- ```typescript
2967
- await client.profiles.delete();
2968
- ```
2969
-
2970
- </dd>
2971
- </dl>
2972
- </dd>
2973
- </dl>
2974
-
2975
- #### ⚙️ Parameters
2976
-
2977
- <dl>
2978
- <dd>
2979
-
2980
- <dl>
2981
- <dd>
2982
-
2983
- **request:** `Airtop.ProfilesDeleteRequest`
2984
-
2985
- </dd>
2986
- </dl>
2987
-
2988
- <dl>
2989
- <dd>
2990
-
2991
- **requestOptions:** `Profiles.RequestOptions`
2992
-
2993
- </dd>
2994
- </dl>
2995
- </dd>
2996
- </dl>
2997
-
2998
- </dd>
2999
- </dl>
3000
- </details>
3001
-
3002
- ## Requests
3003
-
3004
- <details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
3005
- <dl>
3006
- <dd>
3007
-
3008
- #### 🔌 Usage
3009
-
3010
- <dl>
3011
- <dd>
3012
-
3013
- <dl>
3014
- <dd>
3015
-
3016
- ```typescript
3017
- await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
3018
- ```
3019
-
3020
- </dd>
3021
- </dl>
3022
- </dd>
3023
- </dl>
3024
-
3025
- #### ⚙️ Parameters
3026
-
3027
- <dl>
3028
- <dd>
3029
-
3030
- <dl>
3031
- <dd>
3032
-
3033
- **requestId:** `string` — The ID of the request to check.
3034
-
3035
- </dd>
3036
- </dl>
3037
-
3038
- <dl>
3039
- <dd>
3040
-
3041
- **requestOptions:** `Requests.RequestOptions`
3042
-
3043
- </dd>
3044
- </dl>
3045
- </dd>
3046
- </dl>
3047
-
3048
- </dd>
3049
- </dl>
3050
- </details>
3051
-
3052
- ## Sessions
3053
-
3054
- <details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
3055
- <dl>
3056
- <dd>
3057
-
3058
- #### 📝 Description
3059
-
3060
- <dl>
3061
- <dd>
3062
-
3063
- <dl>
3064
- <dd>
3065
-
3066
- Get a paginated list of sessions filtered by ID or status
3067
2050
  Get a paginated list of sessions filtered by ID or status
3068
2051
 
3069
2052
  </dd>