@airtop/sdk 0.1.5 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +3 -3
- package/Client.js +9 -9
- package/README.md +6 -6
- package/api/resources/index.d.ts +3 -3
- package/api/resources/index.js +4 -4
- package/api/resources/profiles/client/Client.js +4 -4
- package/api/resources/sessions/client/Client.js +10 -10
- package/api/resources/windows/client/Client.d.ts +37 -3
- package/api/resources/windows/client/Client.js +206 -19
- package/api/resources/windows/client/requests/CreateWindowInputV1Body.d.ts +1 -1
- package/api/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +25 -0
- package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +23 -0
- package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +29 -0
- package/api/resources/windows/client/requests/WindowLoadUrlV1Body.d.ts +1 -1
- package/api/resources/windows/client/requests/index.d.ts +3 -0
- package/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +3 -2
- package/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -0
- package/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +3 -2
- package/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -0
- package/api/types/ClickConfig.d.ts +8 -0
- package/api/types/CustomProxy.d.ts +1 -1
- package/api/types/Issue.d.ts +2 -0
- package/{dist/api/types/EmptyResponseJson.d.ts → api/types/OperationOutcome.d.ts} +1 -1
- package/api/types/{EmptyResponse.d.ts → OperationOutcomeResponse.d.ts} +3 -3
- package/api/types/PageQueryConfig.d.ts +3 -0
- package/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/api/types/SummaryConfig.d.ts +2 -0
- package/api/types/VisualAnalysisConfig.d.ts +12 -0
- package/api/types/VisualAnalysisConfig.js +5 -0
- package/api/types/VisualAnalysisConfigPartitionDirection.d.ts +12 -0
- package/api/types/VisualAnalysisConfigPartitionDirection.js +11 -0
- package/api/types/VisualAnalysisConfigScope.d.ts +11 -0
- package/api/types/VisualAnalysisConfigScope.js +10 -0
- package/api/types/index.d.ts +6 -4
- package/api/types/index.js +6 -4
- package/dist/Client.d.ts +3 -3
- package/dist/Client.js +9 -9
- package/dist/api/resources/index.d.ts +3 -3
- package/dist/api/resources/index.js +4 -4
- package/dist/api/resources/profiles/client/Client.js +4 -4
- package/dist/api/resources/sessions/client/Client.js +10 -10
- package/dist/api/resources/windows/client/Client.d.ts +37 -3
- package/dist/api/resources/windows/client/Client.js +206 -19
- package/dist/api/resources/windows/client/requests/CreateWindowInputV1Body.d.ts +1 -1
- package/dist/api/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/SessionClickHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/WindowLoadUrlV1Body.d.ts +1 -1
- package/dist/api/resources/windows/client/requests/index.d.ts +3 -0
- package/dist/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +3 -2
- package/dist/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -0
- package/dist/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +3 -2
- package/dist/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -0
- package/dist/api/types/ClickConfig.d.ts +8 -0
- package/dist/api/types/ClickConfig.js +5 -0
- package/dist/api/types/CustomProxy.d.ts +1 -1
- package/dist/api/types/Issue.d.ts +2 -0
- package/{api/types/EmptyResponseJson.d.ts → dist/api/types/OperationOutcome.d.ts} +1 -1
- package/dist/api/types/OperationOutcome.js +5 -0
- package/dist/api/types/{EmptyResponse.d.ts → OperationOutcomeResponse.d.ts} +3 -3
- package/dist/api/types/OperationOutcomeResponse.js +5 -0
- package/dist/api/types/PageQueryConfig.d.ts +3 -0
- package/dist/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/dist/api/types/SummaryConfig.d.ts +2 -0
- package/dist/api/types/VisualAnalysisConfig.d.ts +12 -0
- package/dist/api/types/VisualAnalysisConfig.js +5 -0
- package/dist/api/types/VisualAnalysisConfigPartitionDirection.d.ts +12 -0
- package/dist/api/types/VisualAnalysisConfigPartitionDirection.js +11 -0
- package/dist/api/types/VisualAnalysisConfigScope.d.ts +11 -0
- package/dist/api/types/VisualAnalysisConfigScope.js +10 -0
- package/dist/api/types/index.d.ts +6 -4
- package/dist/api/types/index.js +6 -4
- package/dist/index.d.ts +1 -0
- package/dist/index.js +4 -0
- package/dist/serialization/resources/index.d.ts +3 -3
- package/dist/serialization/resources/index.js +4 -4
- package/dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +17 -0
- package/{serialization/types/EnvelopeStatusDefaultMeta.js → dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js} +9 -6
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +38 -0
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +40 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +3 -0
- package/dist/serialization/resources/windows/client/requests/index.js +7 -1
- package/dist/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
- package/dist/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -1
- package/dist/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
- package/dist/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -1
- package/dist/serialization/types/ClickConfig.d.ts +13 -0
- package/dist/serialization/types/ClickConfig.js +34 -0
- package/dist/serialization/types/Issue.d.ts +1 -0
- package/dist/serialization/types/Issue.js +1 -0
- package/{serialization/types/EmptyResponseJson.d.ts → dist/serialization/types/OperationOutcome.d.ts} +2 -2
- package/{serialization/types/EmptyResponseJson.js → dist/serialization/types/OperationOutcome.js} +2 -2
- package/dist/serialization/types/OperationOutcomeResponse.d.ts +18 -0
- package/dist/serialization/types/{EmptyResponse.js → OperationOutcomeResponse.js} +6 -6
- package/dist/serialization/types/PageQueryConfig.d.ts +2 -0
- package/dist/serialization/types/PageQueryConfig.js +2 -0
- package/dist/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/dist/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/dist/serialization/types/SummaryConfig.d.ts +2 -0
- package/dist/serialization/types/SummaryConfig.js +2 -0
- package/dist/serialization/types/VisualAnalysisConfig.d.ts +16 -0
- package/dist/serialization/types/{EnvelopeStatusDefaultMeta.js → VisualAnalysisConfig.js} +7 -5
- package/dist/serialization/types/VisualAnalysisConfigPartitionDirection.d.ts +10 -0
- package/dist/serialization/types/VisualAnalysisConfigPartitionDirection.js +31 -0
- package/dist/serialization/types/VisualAnalysisConfigScope.d.ts +10 -0
- package/dist/serialization/types/{EnvelopeStatusDefaultMetaStatus.js → VisualAnalysisConfigScope.js} +2 -2
- package/dist/serialization/types/index.d.ts +6 -4
- package/dist/serialization/types/index.js +6 -4
- package/dist/utils/batch-operate/SessionQueue.d.ts +46 -0
- package/dist/utils/batch-operate/SessionQueue.js +223 -0
- package/dist/utils/batch-operate/WindowQueue.d.ts +25 -0
- package/dist/utils/batch-operate/WindowQueue.js +201 -0
- package/dist/utils/batch-operate/batch-util.d.ts +3 -0
- package/dist/utils/batch-operate/batch-util.js +51 -0
- package/dist/utils/batch-operate/helpers.d.ts +2 -0
- package/dist/utils/batch-operate/helpers.js +19 -0
- package/dist/utils/batch-operate/types.d.ts +29 -0
- package/dist/utils/batch-operate/types.js +2 -0
- package/dist/utils/index.d.ts +2 -0
- package/dist/utils/index.js +18 -0
- package/dist/wrapper/AirtopClient.d.ts +3 -0
- package/dist/wrapper/AirtopClient.js +16 -0
- package/index.d.ts +1 -0
- package/index.js +4 -0
- package/package.json +3 -2
- package/reference.md +344 -148
- package/serialization/resources/index.d.ts +3 -3
- package/serialization/resources/index.js +4 -4
- package/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +17 -0
- package/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js +38 -0
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +17 -0
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +38 -0
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +19 -0
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +40 -0
- package/serialization/resources/windows/client/requests/index.d.ts +3 -0
- package/serialization/resources/windows/client/requests/index.js +7 -1
- package/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
- package/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -1
- package/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
- package/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -1
- package/serialization/types/ClickConfig.d.ts +13 -0
- package/serialization/types/ClickConfig.js +34 -0
- package/serialization/types/Issue.d.ts +1 -0
- package/serialization/types/Issue.js +1 -0
- package/{dist/serialization/types/EmptyResponseJson.d.ts → serialization/types/OperationOutcome.d.ts} +2 -2
- package/{dist/serialization/types/EmptyResponseJson.js → serialization/types/OperationOutcome.js} +2 -2
- package/serialization/types/OperationOutcomeResponse.d.ts +18 -0
- package/serialization/types/{EmptyResponse.js → OperationOutcomeResponse.js} +6 -6
- package/serialization/types/PageQueryConfig.d.ts +2 -0
- package/serialization/types/PageQueryConfig.js +2 -0
- package/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/serialization/types/SummaryConfig.d.ts +2 -0
- package/serialization/types/SummaryConfig.js +2 -0
- package/serialization/types/VisualAnalysisConfig.d.ts +16 -0
- package/serialization/types/VisualAnalysisConfig.js +37 -0
- package/serialization/types/VisualAnalysisConfigPartitionDirection.d.ts +10 -0
- package/serialization/types/VisualAnalysisConfigPartitionDirection.js +31 -0
- package/serialization/types/VisualAnalysisConfigScope.d.ts +10 -0
- package/serialization/types/{EnvelopeStatusDefaultMetaStatus.js → VisualAnalysisConfigScope.js} +2 -2
- package/serialization/types/index.d.ts +6 -4
- package/serialization/types/index.js +6 -4
- package/utils/batch-operate/SessionQueue.d.ts +46 -0
- package/utils/batch-operate/SessionQueue.js +223 -0
- package/utils/batch-operate/WindowQueue.d.ts +25 -0
- package/utils/batch-operate/WindowQueue.js +201 -0
- package/utils/batch-operate/batch-util.d.ts +3 -0
- package/utils/batch-operate/batch-util.js +51 -0
- package/utils/batch-operate/helpers.d.ts +2 -0
- package/utils/batch-operate/helpers.js +19 -0
- package/utils/batch-operate/types.d.ts +29 -0
- package/utils/batch-operate/types.js +2 -0
- package/utils/index.d.ts +2 -0
- package/utils/index.js +18 -0
- package/wrapper/AirtopClient.d.ts +3 -0
- package/wrapper/AirtopClient.js +16 -0
- package/api/types/EnvelopeStatusDefaultMeta.d.ts +0 -8
- package/api/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -9
- package/api/types/EnvelopeStatusDefaultMetaStatus.js +0 -11
- package/dist/api/types/EnvelopeStatusDefaultMeta.d.ts +0 -8
- package/dist/api/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -9
- package/dist/api/types/EnvelopeStatusDefaultMetaStatus.js +0 -11
- package/dist/serialization/types/EmptyResponse.d.ts +0 -18
- package/dist/serialization/types/EnvelopeStatusDefaultMeta.d.ts +0 -14
- package/dist/serialization/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -10
- package/serialization/types/EmptyResponse.d.ts +0 -18
- package/serialization/types/EnvelopeStatusDefaultMeta.d.ts +0 -14
- package/serialization/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -10
- /package/api/{types/EmptyResponse.js → resources/windows/client/requests/SessionClickHandlerRequestBody.js} +0 -0
- /package/api/{types/EmptyResponseJson.js → resources/windows/client/requests/SessionHoverHandlerRequestBody.js} +0 -0
- /package/api/{types/EnvelopeStatusDefaultMeta.js → resources/windows/client/requests/SessionTypeHandlerRequestBody.js} +0 -0
- /package/{dist/api/types/EmptyResponse.js → api/types/ClickConfig.js} +0 -0
- /package/{dist/api/types/EmptyResponseJson.js → api/types/OperationOutcome.js} +0 -0
- /package/{dist/api/types/EnvelopeStatusDefaultMeta.js → api/types/OperationOutcomeResponse.js} +0 -0
@@ -66,8 +66,8 @@ class Windows {
|
|
66
66
|
Authorization: yield this._getAuthorizationHeader(),
|
67
67
|
"X-Fern-Language": "JavaScript",
|
68
68
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
69
|
-
"X-Fern-SDK-Version": "0.1.
|
70
|
-
"User-Agent": "@airtop/sdk/0.1.
|
69
|
+
"X-Fern-SDK-Version": "0.1.7",
|
70
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
71
71
|
"X-Fern-Runtime": core.RUNTIME.type,
|
72
72
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
73
73
|
},
|
@@ -140,8 +140,8 @@ class Windows {
|
|
140
140
|
Authorization: yield this._getAuthorizationHeader(),
|
141
141
|
"X-Fern-Language": "JavaScript",
|
142
142
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
143
|
-
"X-Fern-SDK-Version": "0.1.
|
144
|
-
"User-Agent": "@airtop/sdk/0.1.
|
143
|
+
"X-Fern-SDK-Version": "0.1.7",
|
144
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
145
145
|
"X-Fern-Runtime": core.RUNTIME.type,
|
146
146
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
147
147
|
},
|
@@ -203,8 +203,8 @@ class Windows {
|
|
203
203
|
Authorization: yield this._getAuthorizationHeader(),
|
204
204
|
"X-Fern-Language": "JavaScript",
|
205
205
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
206
|
-
"X-Fern-SDK-Version": "0.1.
|
207
|
-
"User-Agent": "@airtop/sdk/0.1.
|
206
|
+
"X-Fern-SDK-Version": "0.1.7",
|
207
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
208
208
|
"X-Fern-Runtime": core.RUNTIME.type,
|
209
209
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
210
210
|
},
|
@@ -216,7 +216,7 @@ class Windows {
|
|
216
216
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
217
217
|
});
|
218
218
|
if (_response.ok) {
|
219
|
-
return serializers.
|
219
|
+
return serializers.OperationOutcomeResponse.parseOrThrow(_response.body, {
|
220
220
|
unrecognizedObjectKeys: "passthrough",
|
221
221
|
allowUnrecognizedUnionMembers: true,
|
222
222
|
allowUnrecognizedEnumValues: true,
|
@@ -263,8 +263,8 @@ class Windows {
|
|
263
263
|
Authorization: yield this._getAuthorizationHeader(),
|
264
264
|
"X-Fern-Language": "JavaScript",
|
265
265
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
266
|
-
"X-Fern-SDK-Version": "0.1.
|
267
|
-
"User-Agent": "@airtop/sdk/0.1.
|
266
|
+
"X-Fern-SDK-Version": "0.1.7",
|
267
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
268
268
|
"X-Fern-Runtime": core.RUNTIME.type,
|
269
269
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
270
270
|
},
|
@@ -306,7 +306,131 @@ class Windows {
|
|
306
306
|
}
|
307
307
|
/**
|
308
308
|
* @param {string} sessionId - The session id for the window.
|
309
|
-
* @param {string} windowId - The Airtop window id of the browser window
|
309
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
310
|
+
* @param {Airtop.SessionClickHandlerRequestBody} request
|
311
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
312
|
+
*
|
313
|
+
* @example
|
314
|
+
* await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
315
|
+
* elementDescription: "The login button"
|
316
|
+
* })
|
317
|
+
*/
|
318
|
+
click(sessionId, windowId, request, requestOptions) {
|
319
|
+
var _a, _b;
|
320
|
+
return __awaiter(this, void 0, void 0, function* () {
|
321
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
322
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `sessions/${encodeURIComponent(sessionId)}/windows/${encodeURIComponent(windowId)}/click`),
|
323
|
+
method: "POST",
|
324
|
+
headers: {
|
325
|
+
Authorization: yield this._getAuthorizationHeader(),
|
326
|
+
"X-Fern-Language": "JavaScript",
|
327
|
+
"X-Fern-SDK-Name": "@airtop/sdk",
|
328
|
+
"X-Fern-SDK-Version": "0.1.7",
|
329
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
330
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
331
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
332
|
+
},
|
333
|
+
contentType: "application/json",
|
334
|
+
requestType: "json",
|
335
|
+
body: serializers.SessionClickHandlerRequestBody.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
|
336
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
337
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
338
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
339
|
+
});
|
340
|
+
if (_response.ok) {
|
341
|
+
return serializers.AiPromptResponse.parseOrThrow(_response.body, {
|
342
|
+
unrecognizedObjectKeys: "passthrough",
|
343
|
+
allowUnrecognizedUnionMembers: true,
|
344
|
+
allowUnrecognizedEnumValues: true,
|
345
|
+
skipValidation: true,
|
346
|
+
breadcrumbsPrefix: ["response"],
|
347
|
+
});
|
348
|
+
}
|
349
|
+
if (_response.error.reason === "status-code") {
|
350
|
+
throw new errors.AirtopError({
|
351
|
+
statusCode: _response.error.statusCode,
|
352
|
+
body: _response.error.body,
|
353
|
+
});
|
354
|
+
}
|
355
|
+
switch (_response.error.reason) {
|
356
|
+
case "non-json":
|
357
|
+
throw new errors.AirtopError({
|
358
|
+
statusCode: _response.error.statusCode,
|
359
|
+
body: _response.error.rawBody,
|
360
|
+
});
|
361
|
+
case "timeout":
|
362
|
+
throw new errors.AirtopTimeoutError();
|
363
|
+
case "unknown":
|
364
|
+
throw new errors.AirtopError({
|
365
|
+
message: _response.error.errorMessage,
|
366
|
+
});
|
367
|
+
}
|
368
|
+
});
|
369
|
+
}
|
370
|
+
/**
|
371
|
+
* @param {string} sessionId - The session id for the window.
|
372
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
373
|
+
* @param {Airtop.SessionHoverHandlerRequestBody} request
|
374
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
375
|
+
*
|
376
|
+
* @example
|
377
|
+
* await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
|
378
|
+
*/
|
379
|
+
hover(sessionId, windowId, request = {}, requestOptions) {
|
380
|
+
var _a, _b;
|
381
|
+
return __awaiter(this, void 0, void 0, function* () {
|
382
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
383
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `sessions/${encodeURIComponent(sessionId)}/windows/${encodeURIComponent(windowId)}/hover`),
|
384
|
+
method: "POST",
|
385
|
+
headers: {
|
386
|
+
Authorization: yield this._getAuthorizationHeader(),
|
387
|
+
"X-Fern-Language": "JavaScript",
|
388
|
+
"X-Fern-SDK-Name": "@airtop/sdk",
|
389
|
+
"X-Fern-SDK-Version": "0.1.7",
|
390
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
391
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
392
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
393
|
+
},
|
394
|
+
contentType: "application/json",
|
395
|
+
requestType: "json",
|
396
|
+
body: serializers.SessionHoverHandlerRequestBody.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
|
397
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
398
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
399
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
400
|
+
});
|
401
|
+
if (_response.ok) {
|
402
|
+
return serializers.AiPromptResponse.parseOrThrow(_response.body, {
|
403
|
+
unrecognizedObjectKeys: "passthrough",
|
404
|
+
allowUnrecognizedUnionMembers: true,
|
405
|
+
allowUnrecognizedEnumValues: true,
|
406
|
+
skipValidation: true,
|
407
|
+
breadcrumbsPrefix: ["response"],
|
408
|
+
});
|
409
|
+
}
|
410
|
+
if (_response.error.reason === "status-code") {
|
411
|
+
throw new errors.AirtopError({
|
412
|
+
statusCode: _response.error.statusCode,
|
413
|
+
body: _response.error.body,
|
414
|
+
});
|
415
|
+
}
|
416
|
+
switch (_response.error.reason) {
|
417
|
+
case "non-json":
|
418
|
+
throw new errors.AirtopError({
|
419
|
+
statusCode: _response.error.statusCode,
|
420
|
+
body: _response.error.rawBody,
|
421
|
+
});
|
422
|
+
case "timeout":
|
423
|
+
throw new errors.AirtopTimeoutError();
|
424
|
+
case "unknown":
|
425
|
+
throw new errors.AirtopError({
|
426
|
+
message: _response.error.errorMessage,
|
427
|
+
});
|
428
|
+
}
|
429
|
+
});
|
430
|
+
}
|
431
|
+
/**
|
432
|
+
* @param {string} sessionId - The session id for the window.
|
433
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
310
434
|
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
311
435
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
312
436
|
*
|
@@ -325,8 +449,8 @@ class Windows {
|
|
325
449
|
Authorization: yield this._getAuthorizationHeader(),
|
326
450
|
"X-Fern-Language": "JavaScript",
|
327
451
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
328
|
-
"X-Fern-SDK-Version": "0.1.
|
329
|
-
"User-Agent": "@airtop/sdk/0.1.
|
452
|
+
"X-Fern-SDK-Version": "0.1.7",
|
453
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
330
454
|
"X-Fern-Runtime": core.RUNTIME.type,
|
331
455
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
332
456
|
},
|
@@ -373,7 +497,7 @@ class Windows {
|
|
373
497
|
* This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
374
498
|
*
|
375
499
|
* @param {string} sessionId - The session id for the window.
|
376
|
-
* @param {string} windowId - The Airtop window id of the browser window
|
500
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
377
501
|
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
378
502
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
379
503
|
*
|
@@ -392,8 +516,8 @@ class Windows {
|
|
392
516
|
Authorization: yield this._getAuthorizationHeader(),
|
393
517
|
"X-Fern-Language": "JavaScript",
|
394
518
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
395
|
-
"X-Fern-SDK-Version": "0.1.
|
396
|
-
"User-Agent": "@airtop/sdk/0.1.
|
519
|
+
"X-Fern-SDK-Version": "0.1.7",
|
520
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
397
521
|
"X-Fern-Runtime": core.RUNTIME.type,
|
398
522
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
399
523
|
},
|
@@ -455,8 +579,8 @@ class Windows {
|
|
455
579
|
Authorization: yield this._getAuthorizationHeader(),
|
456
580
|
"X-Fern-Language": "JavaScript",
|
457
581
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
458
|
-
"X-Fern-SDK-Version": "0.1.
|
459
|
-
"User-Agent": "@airtop/sdk/0.1.
|
582
|
+
"X-Fern-SDK-Version": "0.1.7",
|
583
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
460
584
|
"X-Fern-Runtime": core.RUNTIME.type,
|
461
585
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
462
586
|
},
|
@@ -518,8 +642,8 @@ class Windows {
|
|
518
642
|
Authorization: yield this._getAuthorizationHeader(),
|
519
643
|
"X-Fern-Language": "JavaScript",
|
520
644
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
521
|
-
"X-Fern-SDK-Version": "0.1.
|
522
|
-
"User-Agent": "@airtop/sdk/0.1.
|
645
|
+
"X-Fern-SDK-Version": "0.1.7",
|
646
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
523
647
|
"X-Fern-Runtime": core.RUNTIME.type,
|
524
648
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
525
649
|
},
|
@@ -562,6 +686,69 @@ class Windows {
|
|
562
686
|
}
|
563
687
|
});
|
564
688
|
}
|
689
|
+
/**
|
690
|
+
* @param {string} sessionId - The session id for the window.
|
691
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
692
|
+
* @param {Airtop.SessionTypeHandlerRequestBody} request
|
693
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
694
|
+
*
|
695
|
+
* @example
|
696
|
+
* await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
697
|
+
* text: "Example text"
|
698
|
+
* })
|
699
|
+
*/
|
700
|
+
type(sessionId, windowId, request, requestOptions) {
|
701
|
+
var _a, _b;
|
702
|
+
return __awaiter(this, void 0, void 0, function* () {
|
703
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
704
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `sessions/${encodeURIComponent(sessionId)}/windows/${encodeURIComponent(windowId)}/type`),
|
705
|
+
method: "POST",
|
706
|
+
headers: {
|
707
|
+
Authorization: yield this._getAuthorizationHeader(),
|
708
|
+
"X-Fern-Language": "JavaScript",
|
709
|
+
"X-Fern-SDK-Name": "@airtop/sdk",
|
710
|
+
"X-Fern-SDK-Version": "0.1.7",
|
711
|
+
"User-Agent": "@airtop/sdk/0.1.7",
|
712
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
713
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
714
|
+
},
|
715
|
+
contentType: "application/json",
|
716
|
+
requestType: "json",
|
717
|
+
body: serializers.SessionTypeHandlerRequestBody.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
|
718
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
719
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
720
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
721
|
+
});
|
722
|
+
if (_response.ok) {
|
723
|
+
return serializers.AiPromptResponse.parseOrThrow(_response.body, {
|
724
|
+
unrecognizedObjectKeys: "passthrough",
|
725
|
+
allowUnrecognizedUnionMembers: true,
|
726
|
+
allowUnrecognizedEnumValues: true,
|
727
|
+
skipValidation: true,
|
728
|
+
breadcrumbsPrefix: ["response"],
|
729
|
+
});
|
730
|
+
}
|
731
|
+
if (_response.error.reason === "status-code") {
|
732
|
+
throw new errors.AirtopError({
|
733
|
+
statusCode: _response.error.statusCode,
|
734
|
+
body: _response.error.body,
|
735
|
+
});
|
736
|
+
}
|
737
|
+
switch (_response.error.reason) {
|
738
|
+
case "non-json":
|
739
|
+
throw new errors.AirtopError({
|
740
|
+
statusCode: _response.error.statusCode,
|
741
|
+
body: _response.error.rawBody,
|
742
|
+
});
|
743
|
+
case "timeout":
|
744
|
+
throw new errors.AirtopTimeoutError();
|
745
|
+
case "unknown":
|
746
|
+
throw new errors.AirtopError({
|
747
|
+
message: _response.error.errorMessage,
|
748
|
+
});
|
749
|
+
}
|
750
|
+
});
|
751
|
+
}
|
565
752
|
_getAuthorizationHeader() {
|
566
753
|
return __awaiter(this, void 0, void 0, function* () {
|
567
754
|
return `Bearer ${yield core.Supplier.get(this._options.apiKey)}`;
|
@@ -11,7 +11,7 @@ export interface CreateWindowInputV1Body {
|
|
11
11
|
screenResolution?: string;
|
12
12
|
/** Initial url to navigate to */
|
13
13
|
url?: string;
|
14
|
-
/** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded,
|
14
|
+
/** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately. */
|
15
15
|
waitUntil?: Airtop.CreateWindowInputV1BodyWaitUntil;
|
16
16
|
/** Maximum time in seconds to wait for the specified loading event to occur before timing out. */
|
17
17
|
waitUntilTimeoutSeconds?: number;
|
@@ -0,0 +1,25 @@
|
|
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
|
+
* elementDescription: "The login button"
|
9
|
+
* }
|
10
|
+
*/
|
11
|
+
export interface SessionClickHandlerRequestBody {
|
12
|
+
clientRequestId?: string;
|
13
|
+
/** Request configuration */
|
14
|
+
configuration?: Airtop.ClickConfig;
|
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
|
+
/** A natural language description of the element to click. */
|
18
|
+
elementDescription: string;
|
19
|
+
/**
|
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).
|
21
|
+
*
|
22
|
+
* This setting does not extend the maximum session duration provided at the time of session creation.
|
23
|
+
*/
|
24
|
+
timeThresholdSeconds?: number;
|
25
|
+
}
|
@@ -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 SessionHoverHandlerRequestBody {
|
10
|
+
clientRequestId?: string;
|
11
|
+
/** Request configuration */
|
12
|
+
configuration?: Airtop.ClickConfig;
|
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
|
+
costThresholdCredits?: number;
|
15
|
+
/** 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;
|
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,29 @@
|
|
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
|
+
* text: "Example text"
|
9
|
+
* }
|
10
|
+
*/
|
11
|
+
export interface SessionTypeHandlerRequestBody {
|
12
|
+
clientRequestId?: string;
|
13
|
+
/** Request configuration */
|
14
|
+
configuration?: Airtop.ClickConfig;
|
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
|
+
/** A natural language description of where to type (e.g. 'the search box', 'username field'). The interaction will be aborted if the target element cannot be found. */
|
18
|
+
elementDescription?: string;
|
19
|
+
/** If true, simulates pressing the Enter key after typing the text. */
|
20
|
+
pressEnterKey?: boolean;
|
21
|
+
/** The text to type into the browser window. */
|
22
|
+
text: string;
|
23
|
+
/**
|
24
|
+
* 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).
|
25
|
+
*
|
26
|
+
* This setting does not extend the maximum session duration provided at the time of session creation.
|
27
|
+
*/
|
28
|
+
timeThresholdSeconds?: number;
|
29
|
+
}
|
@@ -11,7 +11,7 @@ import * as Airtop from "../../../../index";
|
|
11
11
|
export interface WindowLoadUrlV1Body {
|
12
12
|
/** Url to navigate to */
|
13
13
|
url: string;
|
14
|
-
/** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded,
|
14
|
+
/** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately. */
|
15
15
|
waitUntil?: Airtop.WindowLoadUrlV1BodyWaitUntil;
|
16
16
|
/** Maximum time in seconds to wait for the specified loading event to occur before timing out. */
|
17
17
|
waitUntilTimeoutSeconds?: number;
|
@@ -1,5 +1,8 @@
|
|
1
1
|
export { type CreateWindowInputV1Body } from "./CreateWindowInputV1Body";
|
2
2
|
export { type GetWindowInfoRequest } from "./GetWindowInfoRequest";
|
3
3
|
export { type WindowLoadUrlV1Body } from "./WindowLoadUrlV1Body";
|
4
|
+
export { type SessionClickHandlerRequestBody } from "./SessionClickHandlerRequestBody";
|
5
|
+
export { type SessionHoverHandlerRequestBody } from "./SessionHoverHandlerRequestBody";
|
4
6
|
export { type ScrapeContentRequest } from "./ScrapeContentRequest";
|
5
7
|
export { type SessionSummaryHandlerRequestBody } from "./SessionSummaryHandlerRequestBody";
|
8
|
+
export { type SessionTypeHandlerRequestBody } from "./SessionTypeHandlerRequestBody";
|
@@ -2,11 +2,12 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
/**
|
5
|
-
* Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded,
|
5
|
+
* Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately.
|
6
6
|
*/
|
7
|
-
export declare type CreateWindowInputV1BodyWaitUntil = "load" | "domContentLoaded" | "complete";
|
7
|
+
export declare type CreateWindowInputV1BodyWaitUntil = "load" | "domContentLoaded" | "complete" | "noWait";
|
8
8
|
export declare const CreateWindowInputV1BodyWaitUntil: {
|
9
9
|
readonly Load: "load";
|
10
10
|
readonly DomContentLoaded: "domContentLoaded";
|
11
11
|
readonly Complete: "complete";
|
12
|
+
readonly NoWait: "noWait";
|
12
13
|
};
|
@@ -2,11 +2,12 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
/**
|
5
|
-
* Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded,
|
5
|
+
* Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately.
|
6
6
|
*/
|
7
|
-
export declare type WindowLoadUrlV1BodyWaitUntil = "load" | "domContentLoaded" | "complete";
|
7
|
+
export declare type WindowLoadUrlV1BodyWaitUntil = "load" | "domContentLoaded" | "complete" | "noWait";
|
8
8
|
export declare const WindowLoadUrlV1BodyWaitUntil: {
|
9
9
|
readonly Load: "load";
|
10
10
|
readonly DomContentLoaded: "domContentLoaded";
|
11
11
|
readonly Complete: "complete";
|
12
|
+
readonly NoWait: "noWait";
|
12
13
|
};
|
@@ -0,0 +1,8 @@
|
|
1
|
+
/**
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
3
|
+
*/
|
4
|
+
import * as Airtop from "../index";
|
5
|
+
export interface ClickConfig {
|
6
|
+
/** Optional configuration for visual analysis when locating specified content. */
|
7
|
+
visualAnalysis?: Airtop.VisualAnalysisConfig;
|
8
|
+
}
|
@@ -7,7 +7,7 @@ import * as Airtop from "../index";
|
|
7
7
|
*/
|
8
8
|
export declare type CustomProxy =
|
9
9
|
/**
|
10
|
-
*
|
10
|
+
* url of the proxy. Or "default" to use airtop provided proxy. */
|
11
11
|
string
|
12
12
|
/**
|
13
13
|
* Proxy object with url of the proxy as a parameter. Takes optional username and password. */
|
@@ -2,9 +2,9 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
import * as Airtop from "../index";
|
5
|
-
export interface
|
6
|
-
data: Airtop.
|
5
|
+
export interface OperationOutcomeResponse {
|
6
|
+
data: Airtop.OperationOutcome;
|
7
7
|
errors?: Airtop.Issue[];
|
8
|
-
meta: Airtop.
|
8
|
+
meta: Airtop.EnvelopeDefaultMeta;
|
9
9
|
warnings?: Airtop.Issue[];
|
10
10
|
}
|
@@ -1,7 +1,10 @@
|
|
1
1
|
/**
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
|
+
import * as Airtop from "../index";
|
4
5
|
export interface PageQueryConfig {
|
6
|
+
/** Experimental configuration options. These may be subject to change and are not guaranteed to be stable across versions. */
|
7
|
+
experimental?: Airtop.PageQueryExperimentalConfig;
|
5
8
|
/** JSON schema defining the structure of the output. If not provided, the format of the output might vary. */
|
6
9
|
outputSchema?: string;
|
7
10
|
}
|
@@ -6,9 +6,12 @@ import * as Airtop from "../index";
|
|
6
6
|
* Proxy configuration.
|
7
7
|
*/
|
8
8
|
export declare type SessionConfigV1Proxy =
|
9
|
+
/**
|
10
|
+
* True to use airtop provided proxy */
|
11
|
+
boolean
|
9
12
|
/**
|
10
13
|
* Configuration for a single custom proxy. */
|
11
|
-
Airtop.CustomProxy
|
14
|
+
| Airtop.CustomProxy
|
12
15
|
/**
|
13
16
|
* Array of proxy configurations. Includes a domain pattern and a proxy configuration to assign proxies to specific domains. */
|
14
17
|
| Airtop.SessionConfigV1ProxyItem[];
|
@@ -1,7 +1,9 @@
|
|
1
1
|
/**
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
|
+
import * as Airtop from "../index";
|
4
5
|
export interface SummaryConfig {
|
6
|
+
experimental?: Airtop.SummaryExperimentalConfig;
|
5
7
|
/** JSON schema defining the structure of the output. If not provided, the format of the output might vary. */
|
6
8
|
outputSchema?: string;
|
7
9
|
}
|
@@ -0,0 +1,12 @@
|
|
1
|
+
/**
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
3
|
+
*/
|
4
|
+
import * as Airtop from "../index";
|
5
|
+
export interface VisualAnalysisConfig {
|
6
|
+
/** The percentage of overlap between screenshot chunks. Defaults to 30 (percent). */
|
7
|
+
overlapPercentage?: number;
|
8
|
+
/** The direction to partition the screenshot into chunks: 'vertical', 'horizontal', or 'bidirectional'. Defaults to 'vertical', which is recommended for most web pages. For optimal results when partitioning in a single direction, ensure the perpendicular dimension does not exceed 1920 pixels. */
|
9
|
+
partitionDirection?: Airtop.VisualAnalysisConfigPartitionDirection;
|
10
|
+
/** Whether to analyze the current viewport or the whole page. Can be 'viewport' or 'page'. Defaults to 'page', which provides the simplest out-of-the-box experience for most web pages. Use 'viewport' for full control over the analyzed content. */
|
11
|
+
scope?: Airtop.VisualAnalysisConfigScope;
|
12
|
+
}
|
@@ -0,0 +1,12 @@
|
|
1
|
+
/**
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
3
|
+
*/
|
4
|
+
/**
|
5
|
+
* The direction to partition the screenshot into chunks: 'vertical', 'horizontal', or 'bidirectional'. Defaults to 'vertical', which is recommended for most web pages. For optimal results when partitioning in a single direction, ensure the perpendicular dimension does not exceed 1920 pixels.
|
6
|
+
*/
|
7
|
+
export declare type VisualAnalysisConfigPartitionDirection = "vertical" | "horizontal" | "bidirectional";
|
8
|
+
export declare const VisualAnalysisConfigPartitionDirection: {
|
9
|
+
readonly Vertical: "vertical";
|
10
|
+
readonly Horizontal: "horizontal";
|
11
|
+
readonly Bidirectional: "bidirectional";
|
12
|
+
};
|