@airtop/sdk 0.1.5 → 0.1.6
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/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 +34 -0
- package/api/resources/windows/client/Client.js +203 -16
- package/api/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +25 -0
- package/api/resources/windows/client/requests/SessionClickHandlerRequestBody.js +5 -0
- package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +23 -0
- package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +5 -0
- package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +29 -0
- package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +3 -0
- package/api/types/ClickConfig.d.ts +4 -0
- package/api/types/ClickConfig.js +5 -0
- package/api/types/CustomProxy.d.ts +1 -1
- package/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/api/types/index.d.ts +1 -0
- package/api/types/index.js +1 -0
- 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 +34 -0
- package/dist/api/resources/windows/client/Client.js +203 -16
- 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/index.d.ts +3 -0
- package/dist/api/types/ClickConfig.d.ts +4 -0
- package/dist/api/types/ClickConfig.js +5 -0
- package/dist/api/types/CustomProxy.d.ts +1 -1
- package/dist/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/dist/api/types/index.d.ts +1 -0
- package/dist/api/types/index.js +1 -0
- package/dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js +38 -0
- 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/types/ClickConfig.d.ts +10 -0
- package/dist/serialization/types/ClickConfig.js +31 -0
- package/dist/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/dist/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/dist/serialization/types/index.d.ts +1 -0
- package/dist/serialization/types/index.js +1 -0
- package/package.json +1 -1
- package/reference.md +196 -0
- 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/types/ClickConfig.d.ts +10 -0
- package/serialization/types/ClickConfig.js +31 -0
- package/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/serialization/types/index.d.ts +1 -0
- package/serialization/types/index.js +1 -0
@@ -77,8 +77,8 @@ class Profiles {
|
|
77
77
|
Authorization: yield this._getAuthorizationHeader(),
|
78
78
|
"X-Fern-Language": "JavaScript",
|
79
79
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
80
|
-
"X-Fern-SDK-Version": "0.1.
|
81
|
-
"User-Agent": "@airtop/sdk/0.1.
|
80
|
+
"X-Fern-SDK-Version": "0.1.6",
|
81
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
82
82
|
"X-Fern-Runtime": core.RUNTIME.type,
|
83
83
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
84
84
|
},
|
@@ -148,8 +148,8 @@ class Profiles {
|
|
148
148
|
Authorization: yield this._getAuthorizationHeader(),
|
149
149
|
"X-Fern-Language": "JavaScript",
|
150
150
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
151
|
-
"X-Fern-SDK-Version": "0.1.
|
152
|
-
"User-Agent": "@airtop/sdk/0.1.
|
151
|
+
"X-Fern-SDK-Version": "0.1.6",
|
152
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
153
153
|
"X-Fern-Runtime": core.RUNTIME.type,
|
154
154
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
155
155
|
},
|
@@ -94,8 +94,8 @@ class Sessions {
|
|
94
94
|
Authorization: yield this._getAuthorizationHeader(),
|
95
95
|
"X-Fern-Language": "JavaScript",
|
96
96
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
97
|
-
"X-Fern-SDK-Version": "0.1.
|
98
|
-
"User-Agent": "@airtop/sdk/0.1.
|
97
|
+
"X-Fern-SDK-Version": "0.1.6",
|
98
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
99
99
|
"X-Fern-Runtime": core.RUNTIME.type,
|
100
100
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
101
101
|
},
|
@@ -180,8 +180,8 @@ class Sessions {
|
|
180
180
|
Authorization: yield this._getAuthorizationHeader(),
|
181
181
|
"X-Fern-Language": "JavaScript",
|
182
182
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
183
|
-
"X-Fern-SDK-Version": "0.1.
|
184
|
-
"User-Agent": "@airtop/sdk/0.1.
|
183
|
+
"X-Fern-SDK-Version": "0.1.6",
|
184
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
185
185
|
"X-Fern-Runtime": core.RUNTIME.type,
|
186
186
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
187
187
|
},
|
@@ -245,8 +245,8 @@ class Sessions {
|
|
245
245
|
Authorization: yield this._getAuthorizationHeader(),
|
246
246
|
"X-Fern-Language": "JavaScript",
|
247
247
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
248
|
-
"X-Fern-SDK-Version": "0.1.
|
249
|
-
"User-Agent": "@airtop/sdk/0.1.
|
248
|
+
"X-Fern-SDK-Version": "0.1.6",
|
249
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
250
250
|
"X-Fern-Runtime": core.RUNTIME.type,
|
251
251
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
252
252
|
},
|
@@ -332,8 +332,8 @@ class Sessions {
|
|
332
332
|
Authorization: yield this._getAuthorizationHeader(),
|
333
333
|
"X-Fern-Language": "JavaScript",
|
334
334
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
335
|
-
"X-Fern-SDK-Version": "0.1.
|
336
|
-
"User-Agent": "@airtop/sdk/0.1.
|
335
|
+
"X-Fern-SDK-Version": "0.1.6",
|
336
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
337
337
|
"X-Fern-Runtime": core.RUNTIME.type,
|
338
338
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
339
339
|
},
|
@@ -380,8 +380,8 @@ class Sessions {
|
|
380
380
|
Authorization: yield this._getAuthorizationHeader(),
|
381
381
|
"X-Fern-Language": "JavaScript",
|
382
382
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
383
|
-
"X-Fern-SDK-Version": "0.1.
|
384
|
-
"User-Agent": "@airtop/sdk/0.1.
|
383
|
+
"X-Fern-SDK-Version": "0.1.6",
|
384
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
385
385
|
"X-Fern-Runtime": core.RUNTIME.type,
|
386
386
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
387
387
|
},
|
@@ -64,6 +64,28 @@ export declare class Windows {
|
|
64
64
|
* await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430")
|
65
65
|
*/
|
66
66
|
close(sessionId: string, windowId: string, requestOptions?: Windows.RequestOptions): Promise<Airtop.WindowIdResponse>;
|
67
|
+
/**
|
68
|
+
* @param {string} sessionId - The session id for the window.
|
69
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
70
|
+
* @param {Airtop.SessionClickHandlerRequestBody} request
|
71
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
72
|
+
*
|
73
|
+
* @example
|
74
|
+
* await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
75
|
+
* elementDescription: "The login button"
|
76
|
+
* })
|
77
|
+
*/
|
78
|
+
click(sessionId: string, windowId: string, request: Airtop.SessionClickHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
79
|
+
/**
|
80
|
+
* @param {string} sessionId - The session id for the window.
|
81
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
82
|
+
* @param {Airtop.SessionHoverHandlerRequestBody} request
|
83
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
84
|
+
*
|
85
|
+
* @example
|
86
|
+
* await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
|
87
|
+
*/
|
88
|
+
hover(sessionId: string, windowId: string, request?: Airtop.SessionHoverHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
67
89
|
/**
|
68
90
|
* @param {string} sessionId - The session id for the window.
|
69
91
|
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
@@ -112,5 +134,17 @@ export declare class Windows {
|
|
112
134
|
* await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
|
113
135
|
*/
|
114
136
|
summarizeContent(sessionId: string, windowId: string, request?: Airtop.SessionSummaryHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
137
|
+
/**
|
138
|
+
* @param {string} sessionId - The session id for the window.
|
139
|
+
* @param {string} windowId - The Airtop window id of the browser window.
|
140
|
+
* @param {Airtop.SessionTypeHandlerRequestBody} request
|
141
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
142
|
+
*
|
143
|
+
* @example
|
144
|
+
* await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
145
|
+
* text: "Example text"
|
146
|
+
* })
|
147
|
+
*/
|
148
|
+
type(sessionId: string, windowId: string, request: Airtop.SessionTypeHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
115
149
|
protected _getAuthorizationHeader(): Promise<string>;
|
116
150
|
}
|
@@ -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.6",
|
70
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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.6",
|
144
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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.6",
|
207
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
208
208
|
"X-Fern-Runtime": core.RUNTIME.type,
|
209
209
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
210
210
|
},
|
@@ -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.6",
|
267
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
268
268
|
"X-Fern-Runtime": core.RUNTIME.type,
|
269
269
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
270
270
|
},
|
@@ -304,6 +304,130 @@ class Windows {
|
|
304
304
|
}
|
305
305
|
});
|
306
306
|
}
|
307
|
+
/**
|
308
|
+
* @param {string} sessionId - The session id for the 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.6",
|
329
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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.6",
|
390
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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
|
+
}
|
307
431
|
/**
|
308
432
|
* @param {string} sessionId - The session id for the window.
|
309
433
|
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
@@ -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.6",
|
453
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
330
454
|
"X-Fern-Runtime": core.RUNTIME.type,
|
331
455
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
332
456
|
},
|
@@ -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.6",
|
520
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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.6",
|
583
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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.6",
|
646
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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.6",
|
711
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
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)}`;
|
@@ -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
|
+
}
|
@@ -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";
|
@@ -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. */
|
@@ -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[];
|
package/api/types/index.d.ts
CHANGED
package/api/types/index.js
CHANGED
@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
17
17
|
__exportStar(require("./AiPromptResponse"), exports);
|
18
18
|
__exportStar(require("./AiResponseEnvelope"), exports);
|
19
|
+
__exportStar(require("./ClickConfig"), exports);
|
19
20
|
__exportStar(require("./ClientProvidedResponseMetadata"), exports);
|
20
21
|
__exportStar(require("./EmptyResponse"), exports);
|
21
22
|
__exportStar(require("./EmptyResponseJson"), exports);
|
@@ -77,8 +77,8 @@ class Profiles {
|
|
77
77
|
Authorization: yield this._getAuthorizationHeader(),
|
78
78
|
"X-Fern-Language": "JavaScript",
|
79
79
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
80
|
-
"X-Fern-SDK-Version": "0.1.
|
81
|
-
"User-Agent": "@airtop/sdk/0.1.
|
80
|
+
"X-Fern-SDK-Version": "0.1.6",
|
81
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
82
82
|
"X-Fern-Runtime": core.RUNTIME.type,
|
83
83
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
84
84
|
},
|
@@ -148,8 +148,8 @@ class Profiles {
|
|
148
148
|
Authorization: yield this._getAuthorizationHeader(),
|
149
149
|
"X-Fern-Language": "JavaScript",
|
150
150
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
151
|
-
"X-Fern-SDK-Version": "0.1.
|
152
|
-
"User-Agent": "@airtop/sdk/0.1.
|
151
|
+
"X-Fern-SDK-Version": "0.1.6",
|
152
|
+
"User-Agent": "@airtop/sdk/0.1.6",
|
153
153
|
"X-Fern-Runtime": core.RUNTIME.type,
|
154
154
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
155
155
|
},
|