@airtop/sdk 0.1.26-beta0 → 0.1.27-beta0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/api/resources/extensionConfigurations/client/Client.js +4 -4
  2. package/api/resources/profiles/client/Client.js +2 -2
  3. package/api/resources/requests/client/Client.js +2 -2
  4. package/api/resources/sessions/client/Client.js +14 -14
  5. package/api/resources/windows/client/Client.d.ts +42 -8
  6. package/api/resources/windows/client/Client.js +192 -56
  7. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
  8. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
  9. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
  10. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
  11. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +4 -2
  12. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +4 -2
  13. package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +4 -2
  14. package/api/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +4 -2
  15. package/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +3 -3
  16. package/api/resources/windows/client/requests/index.d.ts +2 -0
  17. package/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
  18. package/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
  19. package/api/types/index.d.ts +1 -0
  20. package/api/types/index.js +1 -0
  21. package/dist/api/resources/extensionConfigurations/client/Client.js +4 -4
  22. package/dist/api/resources/profiles/client/Client.js +2 -2
  23. package/dist/api/resources/requests/client/Client.js +2 -2
  24. package/dist/api/resources/sessions/client/Client.js +14 -14
  25. package/dist/api/resources/windows/client/Client.d.ts +42 -8
  26. package/dist/api/resources/windows/client/Client.js +192 -56
  27. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
  28. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
  29. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
  30. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
  31. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +4 -2
  32. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +4 -2
  33. package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +4 -2
  34. package/dist/api/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +4 -2
  35. package/dist/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +3 -3
  36. package/dist/api/resources/windows/client/requests/index.d.ts +2 -0
  37. package/dist/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
  38. package/dist/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
  39. package/dist/api/types/index.d.ts +1 -0
  40. package/dist/api/types/index.js +1 -0
  41. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
  42. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
  43. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
  44. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
  45. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +1 -1
  46. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +1 -1
  47. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +1 -1
  48. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +1 -1
  49. package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +1 -1
  50. package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +1 -1
  51. package/dist/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +1 -1
  52. package/dist/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.js +1 -1
  53. package/dist/serialization/resources/windows/client/requests/index.d.ts +2 -0
  54. package/dist/serialization/resources/windows/client/requests/index.js +5 -1
  55. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
  56. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
  57. package/dist/serialization/types/index.d.ts +1 -0
  58. package/dist/serialization/types/index.js +1 -0
  59. package/dist/wrapper/AirtopWindows.d.ts +15 -3
  60. package/dist/wrapper/AirtopWindows.js +21 -2
  61. package/package.json +1 -1
  62. package/reference.md +181 -4
  63. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
  64. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
  65. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
  66. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
  67. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +1 -1
  68. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +1 -1
  69. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +1 -1
  70. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +1 -1
  71. package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +1 -1
  72. package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +1 -1
  73. package/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +1 -1
  74. package/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.js +1 -1
  75. package/serialization/resources/windows/client/requests/index.d.ts +2 -0
  76. package/serialization/resources/windows/client/requests/index.js +5 -1
  77. package/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
  78. package/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
  79. package/serialization/types/index.d.ts +1 -0
  80. package/serialization/types/index.js +1 -0
  81. package/wrapper/AirtopWindows.d.ts +15 -3
  82. package/wrapper/AirtopWindows.js +21 -2
@@ -71,8 +71,8 @@ class Windows {
71
71
  Authorization: yield this._getAuthorizationHeader(),
72
72
  "X-Fern-Language": "JavaScript",
73
73
  "X-Fern-SDK-Name": "@airtop/sdk",
74
- "X-Fern-SDK-Version": "0.1.26-beta0",
75
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
74
+ "X-Fern-SDK-Version": "0.1.27-beta0",
75
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
76
76
  "X-Fern-Runtime": core.RUNTIME.type,
77
77
  "X-Fern-Runtime-Version": core.RUNTIME.version,
78
78
  },
@@ -113,6 +113,134 @@ class Windows {
113
113
  }
114
114
  });
115
115
  }
116
+ /**
117
+ * Create an automation of a browser window asynchronously
118
+ *
119
+ * @param {string} sessionId - The session id for the window.
120
+ * @param {string} windowId - The Airtop window id of the browser window.
121
+ * @param {Airtop.AsyncCreateAutomationRequest} request
122
+ * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
123
+ *
124
+ * @example
125
+ * await client.windows.asyncCreateAutomation("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
126
+ */
127
+ asyncCreateAutomation(sessionId, windowId, request = {}, requestOptions) {
128
+ var _a, _b;
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
131
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `async/sessions/${encodeURIComponent(sessionId)}/windows/${encodeURIComponent(windowId)}/create-automation`),
132
+ method: "POST",
133
+ headers: {
134
+ Authorization: yield this._getAuthorizationHeader(),
135
+ "X-Fern-Language": "JavaScript",
136
+ "X-Fern-SDK-Name": "@airtop/sdk",
137
+ "X-Fern-SDK-Version": "0.1.27-beta0",
138
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
139
+ "X-Fern-Runtime": core.RUNTIME.type,
140
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
141
+ },
142
+ contentType: "application/json",
143
+ requestType: "json",
144
+ body: serializers.AsyncCreateAutomationRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
145
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
146
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
147
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
148
+ });
149
+ if (_response.ok) {
150
+ return serializers.AsyncSessionAiResponseEnvelope.parseOrThrow(_response.body, {
151
+ unrecognizedObjectKeys: "passthrough",
152
+ allowUnrecognizedUnionMembers: true,
153
+ allowUnrecognizedEnumValues: true,
154
+ skipValidation: true,
155
+ breadcrumbsPrefix: ["response"],
156
+ });
157
+ }
158
+ if (_response.error.reason === "status-code") {
159
+ throw new errors.AirtopError({
160
+ statusCode: _response.error.statusCode,
161
+ body: _response.error.body,
162
+ });
163
+ }
164
+ switch (_response.error.reason) {
165
+ case "non-json":
166
+ throw new errors.AirtopError({
167
+ statusCode: _response.error.statusCode,
168
+ body: _response.error.rawBody,
169
+ });
170
+ case "timeout":
171
+ throw new errors.AirtopTimeoutError();
172
+ case "unknown":
173
+ throw new errors.AirtopError({
174
+ message: _response.error.errorMessage,
175
+ });
176
+ }
177
+ });
178
+ }
179
+ /**
180
+ * Execute an automation of a browser window asynchronously
181
+ *
182
+ * @param {string} sessionId - The session id for the window.
183
+ * @param {string} windowId - The Airtop window id of the browser window.
184
+ * @param {Airtop.AsyncExecuteAutomationRequest} request
185
+ * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
186
+ *
187
+ * @example
188
+ * await client.windows.asyncExecuteAutomation("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
189
+ * automationId: "automationId"
190
+ * })
191
+ */
192
+ asyncExecuteAutomation(sessionId, windowId, request, requestOptions) {
193
+ var _a, _b;
194
+ return __awaiter(this, void 0, void 0, function* () {
195
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
196
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `async/sessions/${encodeURIComponent(sessionId)}/windows/${encodeURIComponent(windowId)}/execute-automation`),
197
+ method: "POST",
198
+ headers: {
199
+ Authorization: yield this._getAuthorizationHeader(),
200
+ "X-Fern-Language": "JavaScript",
201
+ "X-Fern-SDK-Name": "@airtop/sdk",
202
+ "X-Fern-SDK-Version": "0.1.27-beta0",
203
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
204
+ "X-Fern-Runtime": core.RUNTIME.type,
205
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
206
+ },
207
+ contentType: "application/json",
208
+ requestType: "json",
209
+ body: serializers.AsyncExecuteAutomationRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
210
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
211
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
212
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
213
+ });
214
+ if (_response.ok) {
215
+ return serializers.AsyncSessionAiResponseEnvelope.parseOrThrow(_response.body, {
216
+ unrecognizedObjectKeys: "passthrough",
217
+ allowUnrecognizedUnionMembers: true,
218
+ allowUnrecognizedEnumValues: true,
219
+ skipValidation: true,
220
+ breadcrumbsPrefix: ["response"],
221
+ });
222
+ }
223
+ if (_response.error.reason === "status-code") {
224
+ throw new errors.AirtopError({
225
+ statusCode: _response.error.statusCode,
226
+ body: _response.error.body,
227
+ });
228
+ }
229
+ switch (_response.error.reason) {
230
+ case "non-json":
231
+ throw new errors.AirtopError({
232
+ statusCode: _response.error.statusCode,
233
+ body: _response.error.rawBody,
234
+ });
235
+ case "timeout":
236
+ throw new errors.AirtopTimeoutError();
237
+ case "unknown":
238
+ throw new errors.AirtopError({
239
+ message: _response.error.errorMessage,
240
+ });
241
+ }
242
+ });
243
+ }
116
244
  /**
117
245
  * @param {string} sessionId - The session id for the window.
118
246
  * @param {string} windowId - The Airtop window id of the browser window.
@@ -120,9 +248,11 @@ class Windows {
120
248
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
121
249
  *
122
250
  * @example
123
- * await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
251
+ * await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
252
+ * elementDescription: "The search box input in the top right corner"
253
+ * })
124
254
  */
125
- asyncHover(sessionId, windowId, request = {}, requestOptions) {
255
+ asyncHover(sessionId, windowId, request, requestOptions) {
126
256
  var _a, _b;
127
257
  return __awaiter(this, void 0, void 0, function* () {
128
258
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -132,8 +262,8 @@ class Windows {
132
262
  Authorization: yield this._getAuthorizationHeader(),
133
263
  "X-Fern-Language": "JavaScript",
134
264
  "X-Fern-SDK-Name": "@airtop/sdk",
135
- "X-Fern-SDK-Version": "0.1.26-beta0",
136
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
265
+ "X-Fern-SDK-Version": "0.1.27-beta0",
266
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
137
267
  "X-Fern-Runtime": core.RUNTIME.type,
138
268
  "X-Fern-Runtime-Version": core.RUNTIME.version,
139
269
  },
@@ -193,8 +323,8 @@ class Windows {
193
323
  Authorization: yield this._getAuthorizationHeader(),
194
324
  "X-Fern-Language": "JavaScript",
195
325
  "X-Fern-SDK-Name": "@airtop/sdk",
196
- "X-Fern-SDK-Version": "0.1.26-beta0",
197
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
326
+ "X-Fern-SDK-Version": "0.1.27-beta0",
327
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
198
328
  "X-Fern-Runtime": core.RUNTIME.type,
199
329
  "X-Fern-Runtime-Version": core.RUNTIME.version,
200
330
  },
@@ -256,8 +386,8 @@ class Windows {
256
386
  Authorization: yield this._getAuthorizationHeader(),
257
387
  "X-Fern-Language": "JavaScript",
258
388
  "X-Fern-SDK-Name": "@airtop/sdk",
259
- "X-Fern-SDK-Version": "0.1.26-beta0",
260
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
389
+ "X-Fern-SDK-Version": "0.1.27-beta0",
390
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
261
391
  "X-Fern-Runtime": core.RUNTIME.type,
262
392
  "X-Fern-Runtime-Version": core.RUNTIME.version,
263
393
  },
@@ -305,9 +435,11 @@ class Windows {
305
435
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
306
436
  *
307
437
  * @example
308
- * await client.windows.asyncPaginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
438
+ * await client.windows.asyncPaginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
439
+ * 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."
440
+ * })
309
441
  */
310
- asyncPaginatedExtraction(sessionId, windowId, request = {}, requestOptions) {
442
+ asyncPaginatedExtraction(sessionId, windowId, request, requestOptions) {
311
443
  var _a, _b;
312
444
  return __awaiter(this, void 0, void 0, function* () {
313
445
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -317,8 +449,8 @@ class Windows {
317
449
  Authorization: yield this._getAuthorizationHeader(),
318
450
  "X-Fern-Language": "JavaScript",
319
451
  "X-Fern-SDK-Name": "@airtop/sdk",
320
- "X-Fern-SDK-Version": "0.1.26-beta0",
321
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
452
+ "X-Fern-SDK-Version": "0.1.27-beta0",
453
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
322
454
  "X-Fern-Runtime": core.RUNTIME.type,
323
455
  "X-Fern-Runtime-Version": core.RUNTIME.version,
324
456
  },
@@ -382,8 +514,8 @@ class Windows {
382
514
  Authorization: yield this._getAuthorizationHeader(),
383
515
  "X-Fern-Language": "JavaScript",
384
516
  "X-Fern-SDK-Name": "@airtop/sdk",
385
- "X-Fern-SDK-Version": "0.1.26-beta0",
386
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
517
+ "X-Fern-SDK-Version": "0.1.27-beta0",
518
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
387
519
  "X-Fern-Runtime": core.RUNTIME.type,
388
520
  "X-Fern-Runtime-Version": core.RUNTIME.version,
389
521
  },
@@ -445,8 +577,8 @@ class Windows {
445
577
  Authorization: yield this._getAuthorizationHeader(),
446
578
  "X-Fern-Language": "JavaScript",
447
579
  "X-Fern-SDK-Name": "@airtop/sdk",
448
- "X-Fern-SDK-Version": "0.1.26-beta0",
449
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
580
+ "X-Fern-SDK-Version": "0.1.27-beta0",
581
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
450
582
  "X-Fern-Runtime": core.RUNTIME.type,
451
583
  "X-Fern-Runtime-Version": core.RUNTIME.version,
452
584
  },
@@ -508,8 +640,8 @@ class Windows {
508
640
  Authorization: yield this._getAuthorizationHeader(),
509
641
  "X-Fern-Language": "JavaScript",
510
642
  "X-Fern-SDK-Name": "@airtop/sdk",
511
- "X-Fern-SDK-Version": "0.1.26-beta0",
512
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
643
+ "X-Fern-SDK-Version": "0.1.27-beta0",
644
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
513
645
  "X-Fern-Runtime": core.RUNTIME.type,
514
646
  "X-Fern-Runtime-Version": core.RUNTIME.version,
515
647
  },
@@ -571,8 +703,8 @@ class Windows {
571
703
  Authorization: yield this._getAuthorizationHeader(),
572
704
  "X-Fern-Language": "JavaScript",
573
705
  "X-Fern-SDK-Name": "@airtop/sdk",
574
- "X-Fern-SDK-Version": "0.1.26-beta0",
575
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
706
+ "X-Fern-SDK-Version": "0.1.27-beta0",
707
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
576
708
  "X-Fern-Runtime": core.RUNTIME.type,
577
709
  "X-Fern-Runtime-Version": core.RUNTIME.version,
578
710
  },
@@ -633,8 +765,8 @@ class Windows {
633
765
  Authorization: yield this._getAuthorizationHeader(),
634
766
  "X-Fern-Language": "JavaScript",
635
767
  "X-Fern-SDK-Name": "@airtop/sdk",
636
- "X-Fern-SDK-Version": "0.1.26-beta0",
637
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
768
+ "X-Fern-SDK-Version": "0.1.27-beta0",
769
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
638
770
  "X-Fern-Runtime": core.RUNTIME.type,
639
771
  "X-Fern-Runtime-Version": core.RUNTIME.version,
640
772
  },
@@ -709,8 +841,8 @@ class Windows {
709
841
  Authorization: yield this._getAuthorizationHeader(),
710
842
  "X-Fern-Language": "JavaScript",
711
843
  "X-Fern-SDK-Name": "@airtop/sdk",
712
- "X-Fern-SDK-Version": "0.1.26-beta0",
713
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
844
+ "X-Fern-SDK-Version": "0.1.27-beta0",
845
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
714
846
  "X-Fern-Runtime": core.RUNTIME.type,
715
847
  "X-Fern-Runtime-Version": core.RUNTIME.version,
716
848
  },
@@ -774,8 +906,8 @@ class Windows {
774
906
  Authorization: yield this._getAuthorizationHeader(),
775
907
  "X-Fern-Language": "JavaScript",
776
908
  "X-Fern-SDK-Name": "@airtop/sdk",
777
- "X-Fern-SDK-Version": "0.1.26-beta0",
778
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
909
+ "X-Fern-SDK-Version": "0.1.27-beta0",
910
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
779
911
  "X-Fern-Runtime": core.RUNTIME.type,
780
912
  "X-Fern-Runtime-Version": core.RUNTIME.version,
781
913
  },
@@ -836,8 +968,8 @@ class Windows {
836
968
  Authorization: yield this._getAuthorizationHeader(),
837
969
  "X-Fern-Language": "JavaScript",
838
970
  "X-Fern-SDK-Name": "@airtop/sdk",
839
- "X-Fern-SDK-Version": "0.1.26-beta0",
840
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
971
+ "X-Fern-SDK-Version": "0.1.27-beta0",
972
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
841
973
  "X-Fern-Runtime": core.RUNTIME.type,
842
974
  "X-Fern-Runtime-Version": core.RUNTIME.version,
843
975
  },
@@ -900,8 +1032,8 @@ class Windows {
900
1032
  Authorization: yield this._getAuthorizationHeader(),
901
1033
  "X-Fern-Language": "JavaScript",
902
1034
  "X-Fern-SDK-Name": "@airtop/sdk",
903
- "X-Fern-SDK-Version": "0.1.26-beta0",
904
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1035
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1036
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
905
1037
  "X-Fern-Runtime": core.RUNTIME.type,
906
1038
  "X-Fern-Runtime-Version": core.RUNTIME.version,
907
1039
  },
@@ -951,9 +1083,11 @@ class Windows {
951
1083
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
952
1084
  *
953
1085
  * @example
954
- * await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
1086
+ * await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1087
+ * elementDescription: "The search box input in the top right corner"
1088
+ * })
955
1089
  */
956
- hover(sessionId, windowId, request = {}, requestOptions) {
1090
+ hover(sessionId, windowId, request, requestOptions) {
957
1091
  var _a, _b;
958
1092
  return __awaiter(this, void 0, void 0, function* () {
959
1093
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -963,8 +1097,8 @@ class Windows {
963
1097
  Authorization: yield this._getAuthorizationHeader(),
964
1098
  "X-Fern-Language": "JavaScript",
965
1099
  "X-Fern-SDK-Name": "@airtop/sdk",
966
- "X-Fern-SDK-Version": "0.1.26-beta0",
967
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1100
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1101
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
968
1102
  "X-Fern-Runtime": core.RUNTIME.type,
969
1103
  "X-Fern-Runtime-Version": core.RUNTIME.version,
970
1104
  },
@@ -1024,8 +1158,8 @@ class Windows {
1024
1158
  Authorization: yield this._getAuthorizationHeader(),
1025
1159
  "X-Fern-Language": "JavaScript",
1026
1160
  "X-Fern-SDK-Name": "@airtop/sdk",
1027
- "X-Fern-SDK-Version": "0.1.26-beta0",
1028
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1161
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1162
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1029
1163
  "X-Fern-Runtime": core.RUNTIME.type,
1030
1164
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1031
1165
  },
@@ -1091,8 +1225,8 @@ class Windows {
1091
1225
  Authorization: yield this._getAuthorizationHeader(),
1092
1226
  "X-Fern-Language": "JavaScript",
1093
1227
  "X-Fern-SDK-Name": "@airtop/sdk",
1094
- "X-Fern-SDK-Version": "0.1.26-beta0",
1095
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1228
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1229
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1096
1230
  "X-Fern-Runtime": core.RUNTIME.type,
1097
1231
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1098
1232
  },
@@ -1144,9 +1278,11 @@ class Windows {
1144
1278
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
1145
1279
  *
1146
1280
  * @example
1147
- * await client.windows.paginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
1281
+ * await client.windows.paginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1282
+ * 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."
1283
+ * })
1148
1284
  */
1149
- paginatedExtraction(sessionId, windowId, request = {}, requestOptions) {
1285
+ paginatedExtraction(sessionId, windowId, request, requestOptions) {
1150
1286
  var _a, _b;
1151
1287
  return __awaiter(this, void 0, void 0, function* () {
1152
1288
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -1156,8 +1292,8 @@ class Windows {
1156
1292
  Authorization: yield this._getAuthorizationHeader(),
1157
1293
  "X-Fern-Language": "JavaScript",
1158
1294
  "X-Fern-SDK-Name": "@airtop/sdk",
1159
- "X-Fern-SDK-Version": "0.1.26-beta0",
1160
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1295
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1296
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1161
1297
  "X-Fern-Runtime": core.RUNTIME.type,
1162
1298
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1163
1299
  },
@@ -1223,8 +1359,8 @@ class Windows {
1223
1359
  Authorization: yield this._getAuthorizationHeader(),
1224
1360
  "X-Fern-Language": "JavaScript",
1225
1361
  "X-Fern-SDK-Name": "@airtop/sdk",
1226
- "X-Fern-SDK-Version": "0.1.26-beta0",
1227
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1362
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1363
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1228
1364
  "X-Fern-Runtime": core.RUNTIME.type,
1229
1365
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1230
1366
  },
@@ -1288,8 +1424,8 @@ class Windows {
1288
1424
  Authorization: yield this._getAuthorizationHeader(),
1289
1425
  "X-Fern-Language": "JavaScript",
1290
1426
  "X-Fern-SDK-Name": "@airtop/sdk",
1291
- "X-Fern-SDK-Version": "0.1.26-beta0",
1292
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1427
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1428
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1293
1429
  "X-Fern-Runtime": core.RUNTIME.type,
1294
1430
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1295
1431
  },
@@ -1351,8 +1487,8 @@ class Windows {
1351
1487
  Authorization: yield this._getAuthorizationHeader(),
1352
1488
  "X-Fern-Language": "JavaScript",
1353
1489
  "X-Fern-SDK-Name": "@airtop/sdk",
1354
- "X-Fern-SDK-Version": "0.1.26-beta0",
1355
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1490
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1491
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1356
1492
  "X-Fern-Runtime": core.RUNTIME.type,
1357
1493
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1358
1494
  },
@@ -1416,8 +1552,8 @@ class Windows {
1416
1552
  Authorization: yield this._getAuthorizationHeader(),
1417
1553
  "X-Fern-Language": "JavaScript",
1418
1554
  "X-Fern-SDK-Name": "@airtop/sdk",
1419
- "X-Fern-SDK-Version": "0.1.26-beta0",
1420
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1555
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1556
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1421
1557
  "X-Fern-Runtime": core.RUNTIME.type,
1422
1558
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1423
1559
  },
@@ -1479,8 +1615,8 @@ class Windows {
1479
1615
  Authorization: yield this._getAuthorizationHeader(),
1480
1616
  "X-Fern-Language": "JavaScript",
1481
1617
  "X-Fern-SDK-Name": "@airtop/sdk",
1482
- "X-Fern-SDK-Version": "0.1.26-beta0",
1483
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1618
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1619
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1484
1620
  "X-Fern-Runtime": core.RUNTIME.type,
1485
1621
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1486
1622
  },
@@ -1546,8 +1682,8 @@ class Windows {
1546
1682
  Authorization: yield this._getAuthorizationHeader(),
1547
1683
  "X-Fern-Language": "JavaScript",
1548
1684
  "X-Fern-SDK-Name": "@airtop/sdk",
1549
- "X-Fern-SDK-Version": "0.1.26-beta0",
1550
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
1685
+ "X-Fern-SDK-Version": "0.1.27-beta0",
1686
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
1551
1687
  "X-Fern-Runtime": core.RUNTIME.type,
1552
1688
  "X-Fern-Runtime-Version": core.RUNTIME.version,
1553
1689
  },
@@ -0,0 +1,23 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Airtop from "../../../../index";
5
+ /**
6
+ * @example
7
+ * {}
8
+ */
9
+ export interface AsyncCreateAutomationRequest {
10
+ /** Async configuration options. */
11
+ async?: Airtop.AsyncConfig;
12
+ clientRequestId?: string;
13
+ /** Request configuration */
14
+ configuration?: Airtop.CreateAutomationRequestBodyConfiguration;
15
+ /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
16
+ costThresholdCredits?: number;
17
+ /**
18
+ * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
19
+ *
20
+ * This setting does not extend the maximum session duration provided at the time of session creation.
21
+ */
22
+ timeThresholdSeconds?: number;
23
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,27 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Airtop from "../../../../index";
5
+ /**
6
+ * @example
7
+ * {
8
+ * automationId: "automationId"
9
+ * }
10
+ */
11
+ export interface AsyncExecuteAutomationRequest {
12
+ /** Async configuration options. */
13
+ async?: Airtop.AsyncConfig;
14
+ /** The ID of the automation to execute */
15
+ automationId: string;
16
+ clientRequestId?: string;
17
+ /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
18
+ costThresholdCredits?: number;
19
+ /** Optional parameters to pass to the automation execution */
20
+ parameters?: Record<string, unknown>;
21
+ /**
22
+ * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
23
+ *
24
+ * This setting does not extend the maximum session duration provided at the time of session creation.
25
+ */
26
+ timeThresholdSeconds?: number;
27
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,7 +4,9 @@
4
4
  import * as Airtop from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * elementDescription: "The search box input in the top right corner"
9
+ * }
8
10
  */
9
11
  export interface AsyncHoverRequest {
10
12
  /** Async configuration options. */
@@ -15,7 +17,7 @@ export interface AsyncHoverRequest {
15
17
  /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
16
18
  costThresholdCredits?: number;
17
19
  /** A natural language description of where to hover (e.g. 'the search box', 'username field'). The interaction will be aborted if the target element cannot be found. */
18
- elementDescription?: string;
20
+ elementDescription: string;
19
21
  /**
20
22
  * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
21
23
  *
@@ -4,7 +4,9 @@
4
4
  import * as Airtop from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * 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."
9
+ * }
8
10
  */
9
11
  export interface AsyncPaginatedExtractionRequest {
10
12
  /** Async configuration options. */
@@ -15,7 +17,7 @@ export interface AsyncPaginatedExtractionRequest {
15
17
  /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
16
18
  costThresholdCredits?: number;
17
19
  /** A prompt providing the Airtop AI model with additional direction or constraints about the page and the details you want to extract from the page. */
18
- prompt?: string;
20
+ prompt: string;
19
21
  /**
20
22
  * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
21
23
  *
@@ -4,7 +4,9 @@
4
4
  import * as Airtop from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * elementDescription: "The search box input in the top right corner"
9
+ * }
8
10
  */
9
11
  export interface SessionHoverHandlerRequestBody {
10
12
  clientRequestId?: string;
@@ -13,7 +15,7 @@ export interface SessionHoverHandlerRequestBody {
13
15
  /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
14
16
  costThresholdCredits?: number;
15
17
  /** A natural language description of where to hover (e.g. 'the search box', 'username field'). The interaction will be aborted if the target element cannot be found. */
16
- elementDescription?: string;
18
+ elementDescription: string;
17
19
  /**
18
20
  * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
19
21
  *
@@ -4,7 +4,9 @@
4
4
  import * as Airtop from "../../../../index";
5
5
  /**
6
6
  * @example
7
- * {}
7
+ * {
8
+ * 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."
9
+ * }
8
10
  */
9
11
  export interface SessionPaginatedExtractionHandlerRequestBody {
10
12
  clientRequestId?: string;
@@ -13,7 +15,7 @@ export interface SessionPaginatedExtractionHandlerRequestBody {
13
15
  /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
14
16
  costThresholdCredits?: number;
15
17
  /** A prompt providing the Airtop AI model with additional direction or constraints about the page and the details you want to extract from the page. */
16
- prompt?: string;
18
+ prompt: string;
17
19
  /**
18
20
  * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
19
21
  *
@@ -12,11 +12,11 @@ export interface SessionScrollHandlerRequestBody {
12
12
  configuration?: Airtop.MicroInteractionConfig;
13
13
  /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
14
14
  costThresholdCredits?: number;
15
- /** The amount of pixels/percentage to scroll horizontally or vertically relative to the current scroll position. Positive values scroll right and down, negative values scroll left and up. If an element description is provided, the element description will take precedence over the scrollBy values. */
15
+ /** The amount of pixels/percentage to scroll horizontally or vertically relative to the current scroll position. Positive values scroll right and down, negative values scroll left and up. If a scrollToElement value is provided, scrollBy/scrollToEdge values will be ignored. */
16
16
  scrollBy?: Airtop.ScrollByConfig;
17
- /** Scroll to the top or bottom of the page, or to the left or right of the page. If provided these values will take precedence over the scrollBy values. If an element description is provided, the element description will take precedence over the scrollToEdge values. */
17
+ /** Scroll to the top or bottom of the page, or to the left or right of the page. ScrollToEdge values will take precedence over the scrollBy values, and scrollToEdge will be executed first. If a scrollToElement value is provided, scrollToEdge/scrollBy values will be ignored. */
18
18
  scrollToEdge?: Airtop.ScrollToEdgeConfig;
19
- /** A natural language description of where to scroll (e.g. 'the search box', 'username field'). The interaction will be aborted if the target element cannot be found. */
19
+ /** A natural language description of where to scroll (e.g. 'the search box', 'username field'). The interaction will be aborted if the target element cannot be found. If provided, scrollToEdge/scrollBy values will be ignored. */
20
20
  scrollToElement?: string;
21
21
  /**
22
22
  * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
@@ -1,4 +1,6 @@
1
1
  export { type AsyncClickRequest } from "./AsyncClickRequest";
2
+ export { type AsyncCreateAutomationRequest } from "./AsyncCreateAutomationRequest";
3
+ export { type AsyncExecuteAutomationRequest } from "./AsyncExecuteAutomationRequest";
2
4
  export { type AsyncHoverRequest } from "./AsyncHoverRequest";
3
5
  export { type AsyncMonitorRequest } from "./AsyncMonitorRequest";
4
6
  export { type AsyncPageQueryRequest } from "./AsyncPageQueryRequest";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export declare type CreateAutomationRequestBodyConfiguration = Record<string, unknown>;