@airtop/sdk 0.0.12 → 0.0.13
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/profiles/client/requests/ProfilesDeleteRequest.d.ts +1 -1
- package/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +1 -1
- package/api/resources/sessions/client/Client.d.ts +1 -1
- package/api/resources/sessions/client/Client.js +11 -11
- package/api/resources/sessions/client/requests/SessionsListRequest.d.ts +4 -4
- package/api/resources/sessions/types/SessionsListRequestStatus.d.ts +3 -3
- package/api/resources/sessions/types/SessionsListRequestStatus.js +1 -1
- package/api/resources/windows/client/Client.d.ts +9 -9
- package/api/resources/windows/client/Client.js +18 -18
- package/api/resources/windows/client/requests/GetWindowInfoRequest.d.ts +4 -4
- package/api/resources/windows/client/requests/PromptContentRequest.d.ts +8 -2
- package/api/resources/windows/client/requests/ScrapeContentRequest.d.ts +6 -0
- package/api/resources/windows/client/requests/SummarizeContentRequest.d.ts +7 -1
- package/api/types/ExternalProfileV1.d.ts +2 -2
- package/api/types/ExternalSessionAiResponseMetadata.d.ts +1 -0
- package/api/types/ExternalSessionAiResponseMetadataStatus.d.ts +3 -0
- package/api/types/ExternalSessionConfig.d.ts +3 -3
- package/api/types/ExternalSessionWithConnectionInfo.d.ts +10 -10
- package/api/types/Issue.d.ts +3 -3
- package/api/types/ScrapeResponseContent.d.ts +2 -2
- package/api/types/ScrapeResponseEnvelope.d.ts +1 -0
- package/api/types/ScrapeResponseOutput.d.ts +3 -3
- package/api/types/SessionConfigV1.d.ts +3 -3
- package/api/types/SessionsWithPagination.d.ts +2 -2
- package/api/types/Window.d.ts +2 -2
- package/dist/api/resources/profiles/client/Client.js +4 -4
- package/dist/api/resources/profiles/client/requests/ProfilesDeleteRequest.d.ts +1 -1
- package/dist/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +1 -1
- package/dist/api/resources/sessions/client/Client.d.ts +1 -1
- package/dist/api/resources/sessions/client/Client.js +11 -11
- package/dist/api/resources/sessions/client/requests/SessionsListRequest.d.ts +4 -4
- package/dist/api/resources/sessions/types/SessionsListRequestStatus.d.ts +3 -3
- package/dist/api/resources/sessions/types/SessionsListRequestStatus.js +1 -1
- package/dist/api/resources/windows/client/Client.d.ts +9 -9
- package/dist/api/resources/windows/client/Client.js +18 -18
- package/dist/api/resources/windows/client/requests/GetWindowInfoRequest.d.ts +4 -4
- package/dist/api/resources/windows/client/requests/PromptContentRequest.d.ts +8 -2
- package/dist/api/resources/windows/client/requests/ScrapeContentRequest.d.ts +6 -0
- package/dist/api/resources/windows/client/requests/SummarizeContentRequest.d.ts +7 -1
- package/dist/api/types/ExternalProfileV1.d.ts +2 -2
- package/dist/api/types/ExternalSessionAiResponseMetadata.d.ts +1 -0
- package/dist/api/types/ExternalSessionAiResponseMetadataStatus.d.ts +3 -0
- package/dist/api/types/ExternalSessionConfig.d.ts +3 -3
- package/dist/api/types/ExternalSessionWithConnectionInfo.d.ts +10 -10
- package/dist/api/types/Issue.d.ts +3 -3
- package/dist/api/types/ScrapeResponseContent.d.ts +2 -2
- package/dist/api/types/ScrapeResponseEnvelope.d.ts +1 -0
- package/dist/api/types/ScrapeResponseOutput.d.ts +3 -3
- package/dist/api/types/SessionConfigV1.d.ts +3 -3
- package/dist/api/types/SessionsWithPagination.d.ts +2 -2
- package/dist/api/types/Window.d.ts +2 -2
- package/dist/serialization/resources/sessions/types/SessionsListRequestStatus.d.ts +1 -1
- package/dist/serialization/resources/sessions/types/SessionsListRequestStatus.js +1 -1
- package/dist/wrapper/AirtopClient.js +1 -1
- package/dist/wrapper/AirtopWindows.d.ts +8 -4
- package/dist/wrapper/AirtopWindows.js +62 -11
- package/package.json +1 -1
- package/reference.md +10 -10
- package/serialization/resources/sessions/types/SessionsListRequestStatus.d.ts +1 -1
- package/serialization/resources/sessions/types/SessionsListRequestStatus.js +1 -1
- package/wrapper/AirtopClient.js +1 -1
- package/wrapper/AirtopWindows.d.ts +8 -4
- package/wrapper/AirtopWindows.js +62 -11
@@ -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.0.
|
81
|
-
"User-Agent": "@airtop/sdk/0.0.
|
80
|
+
"X-Fern-SDK-Version": "0.0.13",
|
81
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
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.0.
|
152
|
-
"User-Agent": "@airtop/sdk/0.0.
|
151
|
+
"X-Fern-SDK-Version": "0.0.13",
|
152
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
153
153
|
"X-Fern-Runtime": core.RUNTIME.type,
|
154
154
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
155
155
|
},
|
@@ -64,7 +64,7 @@ export declare class Sessions {
|
|
64
64
|
/**
|
65
65
|
* Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
|
66
66
|
*
|
67
|
-
* @param {string} id - ID of the session to delete
|
67
|
+
* @param {string} id - ID of the session to delete.
|
68
68
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
69
69
|
*
|
70
70
|
* @example
|
@@ -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.0.
|
98
|
-
"User-Agent": "@airtop/sdk/0.0.
|
97
|
+
"X-Fern-SDK-Version": "0.0.13",
|
98
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
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.0.
|
184
|
-
"User-Agent": "@airtop/sdk/0.0.
|
183
|
+
"X-Fern-SDK-Version": "0.0.13",
|
184
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
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.0.
|
249
|
-
"User-Agent": "@airtop/sdk/0.0.
|
248
|
+
"X-Fern-SDK-Version": "0.0.13",
|
249
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
250
250
|
"X-Fern-Runtime": core.RUNTIME.type,
|
251
251
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
252
252
|
},
|
@@ -316,7 +316,7 @@ class Sessions {
|
|
316
316
|
/**
|
317
317
|
* Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
|
318
318
|
*
|
319
|
-
* @param {string} id - ID of the session to delete
|
319
|
+
* @param {string} id - ID of the session to delete.
|
320
320
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
321
321
|
*
|
322
322
|
* @example
|
@@ -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.0.
|
336
|
-
"User-Agent": "@airtop/sdk/0.0.
|
335
|
+
"X-Fern-SDK-Version": "0.0.13",
|
336
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
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.0.
|
384
|
-
"User-Agent": "@airtop/sdk/0.0.
|
383
|
+
"X-Fern-SDK-Version": "0.0.13",
|
384
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
385
385
|
"X-Fern-Runtime": core.RUNTIME.type,
|
386
386
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
387
387
|
},
|
@@ -11,19 +11,19 @@ import * as Airtop from "../../../../index";
|
|
11
11
|
*/
|
12
12
|
export interface SessionsListRequest {
|
13
13
|
/**
|
14
|
-
*
|
14
|
+
* A comma-separated list of IDs of the sessions to retrieve.
|
15
15
|
*/
|
16
16
|
sessionIds?: string | string[];
|
17
17
|
/**
|
18
|
-
*
|
18
|
+
* Status of the session to get.
|
19
19
|
*/
|
20
20
|
status?: Airtop.SessionsListRequestStatus;
|
21
21
|
/**
|
22
|
-
*
|
22
|
+
* Offset for pagination.
|
23
23
|
*/
|
24
24
|
offset?: number;
|
25
25
|
/**
|
26
|
-
*
|
26
|
+
* Limit for pagination.
|
27
27
|
*/
|
28
28
|
limit?: number;
|
29
29
|
}
|
@@ -2,11 +2,11 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
/**
|
5
|
-
*
|
5
|
+
* Status of the session to get.
|
6
6
|
*/
|
7
|
-
export declare type SessionsListRequestStatus = "
|
7
|
+
export declare type SessionsListRequestStatus = "awaitingCapacity" | "initializing" | "running" | "ended";
|
8
8
|
export declare const SessionsListRequestStatus: {
|
9
|
-
readonly AwaitingCapacity: "
|
9
|
+
readonly AwaitingCapacity: "awaitingCapacity";
|
10
10
|
readonly Initializing: "initializing";
|
11
11
|
readonly Running: "running";
|
12
12
|
readonly Ended: "ended";
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
6
6
|
exports.SessionsListRequestStatus = void 0;
|
7
7
|
exports.SessionsListRequestStatus = {
|
8
|
-
AwaitingCapacity: "
|
8
|
+
AwaitingCapacity: "awaitingCapacity",
|
9
9
|
Initializing: "initializing",
|
10
10
|
Running: "running",
|
11
11
|
Ended: "ended",
|
@@ -23,20 +23,20 @@ export declare class Windows {
|
|
23
23
|
protected readonly _options: Windows.Options;
|
24
24
|
constructor(_options?: Windows.Options);
|
25
25
|
/**
|
26
|
-
* @param {string} sessionId - ID of the session that owns the window
|
27
|
-
* @param {string} windowId -
|
26
|
+
* @param {string} sessionId - ID of the session that owns the window.
|
27
|
+
* @param {string} windowId - ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
|
28
28
|
* @param {Airtop.GetWindowInfoRequest} request
|
29
29
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
30
30
|
*
|
31
31
|
* @example
|
32
32
|
* await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
33
|
-
* screenResolution: "
|
33
|
+
* screenResolution: "1280x720"
|
34
34
|
* })
|
35
35
|
*/
|
36
36
|
getWindowInfo(sessionId: string, windowId: string, request?: Airtop.GetWindowInfoRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.WindowEnvelopeDefaultMetaWrapper>;
|
37
37
|
/**
|
38
|
-
* @param {string} sessionId - The session id
|
39
|
-
* @param {string} windowId - The window id to
|
38
|
+
* @param {string} sessionId - The session id for the window.
|
39
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
40
40
|
* @param {Airtop.PromptContentRequest} request
|
41
41
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
42
42
|
*
|
@@ -47,8 +47,8 @@ export declare class Windows {
|
|
47
47
|
*/
|
48
48
|
promptContent(sessionId: string, windowId: string, request: Airtop.PromptContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiResponseEnvelopeExternalSessionAiResponseMetadataWrapper>;
|
49
49
|
/**
|
50
|
-
* @param {string} sessionId - The session id
|
51
|
-
* @param {string} windowId - The window id to scrape
|
50
|
+
* @param {string} sessionId - The session id for the window.
|
51
|
+
* @param {string} windowId - The Airtop window id of the browser window to scrape.
|
52
52
|
* @param {Airtop.ScrapeContentRequest} request
|
53
53
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
54
54
|
*
|
@@ -57,8 +57,8 @@ export declare class Windows {
|
|
57
57
|
*/
|
58
58
|
scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.ScrapeResponseEnvelopeExternalSessionAiResponseMetadataWrapper>;
|
59
59
|
/**
|
60
|
-
* @param {string} sessionId - The session id
|
61
|
-
* @param {string} windowId - The window id to summarize
|
60
|
+
* @param {string} sessionId - The session id for the window.
|
61
|
+
* @param {string} windowId - The Airtop window id of the browser window to summarize.
|
62
62
|
* @param {Airtop.SummarizeContentRequest} request
|
63
63
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
64
64
|
*
|
@@ -49,14 +49,14 @@ class Windows {
|
|
49
49
|
this._options = _options;
|
50
50
|
}
|
51
51
|
/**
|
52
|
-
* @param {string} sessionId - ID of the session that owns the window
|
53
|
-
* @param {string} windowId -
|
52
|
+
* @param {string} sessionId - ID of the session that owns the window.
|
53
|
+
* @param {string} windowId - ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
|
54
54
|
* @param {Airtop.GetWindowInfoRequest} request
|
55
55
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
56
56
|
*
|
57
57
|
* @example
|
58
58
|
* await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
59
|
-
* screenResolution: "
|
59
|
+
* screenResolution: "1280x720"
|
60
60
|
* })
|
61
61
|
*/
|
62
62
|
getWindowInfo(sessionId, windowId, request = {}, requestOptions) {
|
@@ -71,7 +71,7 @@ class Windows {
|
|
71
71
|
_queryParams["disableResize"] = disableResize.toString();
|
72
72
|
}
|
73
73
|
if (screenResolution != null) {
|
74
|
-
_queryParams["
|
74
|
+
_queryParams["screenResolution"] = screenResolution;
|
75
75
|
}
|
76
76
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
77
77
|
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)}`),
|
@@ -80,8 +80,8 @@ class Windows {
|
|
80
80
|
Authorization: yield this._getAuthorizationHeader(),
|
81
81
|
"X-Fern-Language": "JavaScript",
|
82
82
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
83
|
-
"X-Fern-SDK-Version": "0.0.
|
84
|
-
"User-Agent": "@airtop/sdk/0.0.
|
83
|
+
"X-Fern-SDK-Version": "0.0.13",
|
84
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
85
85
|
"X-Fern-Runtime": core.RUNTIME.type,
|
86
86
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
87
87
|
},
|
@@ -123,8 +123,8 @@ class Windows {
|
|
123
123
|
});
|
124
124
|
}
|
125
125
|
/**
|
126
|
-
* @param {string} sessionId - The session id
|
127
|
-
* @param {string} windowId - The window id to
|
126
|
+
* @param {string} sessionId - The session id for the window.
|
127
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
128
128
|
* @param {Airtop.PromptContentRequest} request
|
129
129
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
130
130
|
*
|
@@ -143,8 +143,8 @@ class Windows {
|
|
143
143
|
Authorization: yield this._getAuthorizationHeader(),
|
144
144
|
"X-Fern-Language": "JavaScript",
|
145
145
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
146
|
-
"X-Fern-SDK-Version": "0.0.
|
147
|
-
"User-Agent": "@airtop/sdk/0.0.
|
146
|
+
"X-Fern-SDK-Version": "0.0.13",
|
147
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
148
148
|
"X-Fern-Runtime": core.RUNTIME.type,
|
149
149
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
150
150
|
},
|
@@ -186,8 +186,8 @@ class Windows {
|
|
186
186
|
});
|
187
187
|
}
|
188
188
|
/**
|
189
|
-
* @param {string} sessionId - The session id
|
190
|
-
* @param {string} windowId - The window id to scrape
|
189
|
+
* @param {string} sessionId - The session id for the window.
|
190
|
+
* @param {string} windowId - The Airtop window id of the browser window to scrape.
|
191
191
|
* @param {Airtop.ScrapeContentRequest} request
|
192
192
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
193
193
|
*
|
@@ -204,8 +204,8 @@ class Windows {
|
|
204
204
|
Authorization: yield this._getAuthorizationHeader(),
|
205
205
|
"X-Fern-Language": "JavaScript",
|
206
206
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
207
|
-
"X-Fern-SDK-Version": "0.0.
|
208
|
-
"User-Agent": "@airtop/sdk/0.0.
|
207
|
+
"X-Fern-SDK-Version": "0.0.13",
|
208
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
209
209
|
"X-Fern-Runtime": core.RUNTIME.type,
|
210
210
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
211
211
|
},
|
@@ -247,8 +247,8 @@ class Windows {
|
|
247
247
|
});
|
248
248
|
}
|
249
249
|
/**
|
250
|
-
* @param {string} sessionId - The session id
|
251
|
-
* @param {string} windowId - The window id to summarize
|
250
|
+
* @param {string} sessionId - The session id for the window.
|
251
|
+
* @param {string} windowId - The Airtop window id of the browser window to summarize.
|
252
252
|
* @param {Airtop.SummarizeContentRequest} request
|
253
253
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
254
254
|
*
|
@@ -265,8 +265,8 @@ class Windows {
|
|
265
265
|
Authorization: yield this._getAuthorizationHeader(),
|
266
266
|
"X-Fern-Language": "JavaScript",
|
267
267
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
268
|
-
"X-Fern-SDK-Version": "0.0.
|
269
|
-
"User-Agent": "@airtop/sdk/0.0.
|
268
|
+
"X-Fern-SDK-Version": "0.0.13",
|
269
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
270
270
|
"X-Fern-Runtime": core.RUNTIME.type,
|
271
271
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
272
272
|
},
|
@@ -4,20 +4,20 @@
|
|
4
4
|
/**
|
5
5
|
* @example
|
6
6
|
* {
|
7
|
-
* screenResolution: "
|
7
|
+
* screenResolution: "1280x720"
|
8
8
|
* }
|
9
9
|
*/
|
10
10
|
export interface GetWindowInfoRequest {
|
11
11
|
/**
|
12
|
-
*
|
12
|
+
* Affects the live view configuration. A navigation bar is not shown in the live view of a browser by default. Set this to true to configure the returned liveViewUrl so that a navigation bar is rendered, allowing users to easily navigate the browser to other pages from the live view.
|
13
13
|
*/
|
14
14
|
includeNavigationBar?: boolean;
|
15
15
|
/**
|
16
|
-
*
|
16
|
+
* Affects the live view configuration. Set to true to configure the returned liveViewUrl so that the ability to resize the browser window from the live view is disabled (resizing is allowed by default). Note that, at initial load, the live view will automatically fill the parent frame (or local window if loaded directly) and cause the browser window to be resized to match. This parameter does not affect that initial load behavior. See screenResolution for a way to set a fixed size for the live view.
|
17
17
|
*/
|
18
18
|
disableResize?: boolean;
|
19
19
|
/**
|
20
|
-
*
|
20
|
+
* Affects the live view configuration. By default, a live view will fill the parent frame (or local window if loaded directly) when initially loaded, causing the browser window to be resized to match. This parameter can be used to instead configure the returned liveViewUrl so that the live view is loaded with fixed dimensions (e.g. 1280x720), resizing the browser window to match, and then disallows any further resizing from the live view.
|
21
21
|
*/
|
22
22
|
screenResolution?: string;
|
23
23
|
}
|
@@ -9,10 +9,16 @@
|
|
9
9
|
*/
|
10
10
|
export interface PromptContentRequest {
|
11
11
|
clientRequestId?: string;
|
12
|
+
/** 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). */
|
12
13
|
costThresholdCredits?: number;
|
13
|
-
/**
|
14
|
+
/** Make a best effort attempt to load more content items than are originally displayed on the page, e.g. by following pagination links, clicking controls to load more content, utilizing infinite scrolling, etc. This can be quite a bit more costly, but may be necessary for sites that require additional interaction to show the needed results. You can provide constraints in your prompt (e.g. on the total number of pages or results to consider). */
|
14
15
|
followPaginationLinks?: boolean;
|
15
|
-
/** The prompt to submit about the content in the browser window */
|
16
|
+
/** The prompt to submit about the content in the browser window. */
|
16
17
|
prompt: string;
|
18
|
+
/**
|
19
|
+
* 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).
|
20
|
+
*
|
21
|
+
* This setting does not extend the maximum session duration provided at the time of session creation.
|
22
|
+
*/
|
17
23
|
timeThresholdSeconds?: number;
|
18
24
|
}
|
@@ -7,6 +7,12 @@
|
|
7
7
|
*/
|
8
8
|
export interface ScrapeContentRequest {
|
9
9
|
clientRequestId?: string;
|
10
|
+
/** 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). */
|
10
11
|
costThresholdCredits?: number;
|
12
|
+
/**
|
13
|
+
* 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).
|
14
|
+
*
|
15
|
+
* This setting does not extend the maximum session duration provided at the time of session creation.
|
16
|
+
*/
|
11
17
|
timeThresholdSeconds?: number;
|
12
18
|
}
|
@@ -7,8 +7,14 @@
|
|
7
7
|
*/
|
8
8
|
export interface SummarizeContentRequest {
|
9
9
|
clientRequestId?: string;
|
10
|
+
/** 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). */
|
10
11
|
costThresholdCredits?: number;
|
11
|
-
/**
|
12
|
+
/** An optional prompt providing the Airtop AI model with additional direction or constraints about the summary (such as desired length). */
|
12
13
|
prompt?: string;
|
14
|
+
/**
|
15
|
+
* 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).
|
16
|
+
*
|
17
|
+
* This setting does not extend the maximum session duration provided at the time of session creation.
|
18
|
+
*/
|
13
19
|
timeThresholdSeconds?: number;
|
14
20
|
}
|
@@ -2,8 +2,8 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
export interface ExternalProfileV1 {
|
5
|
-
/** Id of the profile */
|
5
|
+
/** Id of the profile. */
|
6
6
|
profileId: string;
|
7
|
-
/** Status of the profile */
|
7
|
+
/** Status of the profile. */
|
8
8
|
status?: string;
|
9
9
|
}
|
@@ -5,6 +5,7 @@ import * as Airtop from "../index";
|
|
5
5
|
export interface ExternalSessionAiResponseMetadata {
|
6
6
|
clientProvided?: Airtop.ClientProvidedResponseMetadata;
|
7
7
|
requestId?: string;
|
8
|
+
/** Outcome of the operation. */
|
8
9
|
status: Airtop.ExternalSessionAiResponseMetadataStatus;
|
9
10
|
usage: Airtop.ExternalSessionAiResponseMetadataUsage;
|
10
11
|
}
|
@@ -1,6 +1,9 @@
|
|
1
1
|
/**
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
|
+
/**
|
5
|
+
* Outcome of the operation.
|
6
|
+
*/
|
4
7
|
export declare type ExternalSessionAiResponseMetadataStatus = "success" | "partial" | "failure";
|
5
8
|
export declare const ExternalSessionAiResponseMetadataStatus: {
|
6
9
|
readonly Success: "success";
|
@@ -2,10 +2,10 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
export interface ExternalSessionConfig {
|
5
|
-
/** Id of a profile to load into the session */
|
5
|
+
/** Id of a profile to load into the session. */
|
6
6
|
baseProfileId?: string;
|
7
|
-
/** Persist the profile */
|
7
|
+
/** Persist the profile. */
|
8
8
|
persistProfile?: boolean;
|
9
|
-
/** Max length of session in minutes, after which it will terminate if not already deleted */
|
9
|
+
/** Max length of session in minutes, after which it will terminate if not already deleted. */
|
10
10
|
timeoutMinutes?: number;
|
11
11
|
}
|
@@ -3,24 +3,24 @@
|
|
3
3
|
*/
|
4
4
|
import * as Airtop from "../index";
|
5
5
|
export interface ExternalSessionWithConnectionInfo {
|
6
|
-
/** Url to connect to chrome devtools protocol port on the
|
6
|
+
/** Url to connect to chrome devtools protocol port on the Airtop browser. Include the header 'Authorization: Bearer <api-key>.' */
|
7
7
|
cdpUrl?: string;
|
8
|
-
/** Websocket url to connect to CDP
|
8
|
+
/** Websocket url to connect to the Airtop browser for CDP-based automation frameworks (e.g. Puppeteer or Playwright). Include the header 'Authorization: Bearer <airtop-api-key>.' */
|
9
9
|
cdpWsUrl?: string;
|
10
|
-
/** Websocket url to connect to the
|
10
|
+
/** Websocket url to connect to the Airtop browser for webdriver-based automation frameworks (e.g. Selenium). Include the header 'Authorization: Bearer <airtop-api-key>.' */
|
11
11
|
chromedriverUrl?: string;
|
12
|
-
/** Session configuration */
|
12
|
+
/** Session configuration details. */
|
13
13
|
configuration: Airtop.ExternalSessionConfig;
|
14
|
-
/** Current usage in minutes */
|
14
|
+
/** Current usage in minutes. */
|
15
15
|
currentUsage?: number;
|
16
|
-
/** Date the session was created */
|
16
|
+
/** Date the session was created. */
|
17
17
|
dateCreated?: Date;
|
18
|
-
/**
|
18
|
+
/** Id of the session. */
|
19
19
|
id: string;
|
20
|
-
/** Date of the last activity */
|
20
|
+
/** Date of the last activity. */
|
21
21
|
lastActivity?: Date;
|
22
|
-
/** Id of a newly persisted profile */
|
22
|
+
/** Id of a newly persisted profile. */
|
23
23
|
profileId?: string;
|
24
|
-
/** Session status */
|
24
|
+
/** Session status. */
|
25
25
|
status: string;
|
26
26
|
}
|
package/api/types/Issue.d.ts
CHANGED
@@ -2,10 +2,10 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
export interface Issue {
|
5
|
-
/** Issue code */
|
5
|
+
/** Issue code. */
|
6
6
|
code?: string;
|
7
|
-
/** Any associated details */
|
7
|
+
/** Any associated details. */
|
8
8
|
details?: Record<string, unknown>;
|
9
|
-
/** Message describing the issue */
|
9
|
+
/** Message describing the issue. */
|
10
10
|
message: string;
|
11
11
|
}
|
@@ -2,8 +2,8 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
export interface ScrapeResponseContent {
|
5
|
-
/** The mime type of content extracted from the browser window */
|
5
|
+
/** The mime type of content extracted from the browser window (usually text/plain but could be text/csv or other types depending on the site). */
|
6
6
|
contentType: string;
|
7
|
-
/** The text content of the browser window */
|
7
|
+
/** The text content of the browser window. */
|
8
8
|
text: string;
|
9
9
|
}
|
@@ -3,10 +3,10 @@
|
|
3
3
|
*/
|
4
4
|
import * as Airtop from "../index";
|
5
5
|
export interface ScrapeResponseOutput {
|
6
|
-
/** The scraped content of the browser window */
|
6
|
+
/** The scraped content of the browser window. */
|
7
7
|
scrapedContent: Airtop.ScrapeResponseContent;
|
8
|
-
/** Any text that was highlighted in the browser window */
|
8
|
+
/** Any text that was highlighted in the browser window. */
|
9
9
|
selectedText?: string;
|
10
|
-
/** The title of the browser page */
|
10
|
+
/** The title of the browser page. */
|
11
11
|
title: string;
|
12
12
|
}
|
@@ -2,10 +2,10 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
export interface SessionConfigV1 {
|
5
|
-
/** Id of a profile to load into the session */
|
5
|
+
/** Id of a profile to load into the session. */
|
6
6
|
baseProfileId?: string;
|
7
|
-
/** Persist the profile */
|
7
|
+
/** Persist the profile. */
|
8
8
|
persistProfile?: boolean;
|
9
|
-
/** Max length of session in minutes, after which it will terminate if not already deleted */
|
9
|
+
/** Max length of session in minutes, after which it will terminate if not already deleted. */
|
10
10
|
timeoutMinutes?: number;
|
11
11
|
}
|
@@ -3,8 +3,8 @@
|
|
3
3
|
*/
|
4
4
|
import * as Airtop from "../index";
|
5
5
|
export interface SessionsWithPagination {
|
6
|
-
/** Pagination
|
6
|
+
/** Pagination details. */
|
7
7
|
pagination: Airtop.Pagination;
|
8
|
-
/** List of sessions */
|
8
|
+
/** List of sessions. */
|
9
9
|
sessions?: Airtop.ExternalSessionWithConnectionInfo[];
|
10
10
|
}
|
package/api/types/Window.d.ts
CHANGED
@@ -2,8 +2,8 @@
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
4
|
export interface Window {
|
5
|
-
/** Url for live view
|
5
|
+
/** Url for loading a browser window live view that is configured according to the request options like screenResolution, disableResize, etc. */
|
6
6
|
liveViewUrl: string;
|
7
|
-
/**
|
7
|
+
/** Airtop window ID of the browser window */
|
8
8
|
windowId: string;
|
9
9
|
}
|
@@ -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.0.
|
81
|
-
"User-Agent": "@airtop/sdk/0.0.
|
80
|
+
"X-Fern-SDK-Version": "0.0.13",
|
81
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
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.0.
|
152
|
-
"User-Agent": "@airtop/sdk/0.0.
|
151
|
+
"X-Fern-SDK-Version": "0.0.13",
|
152
|
+
"User-Agent": "@airtop/sdk/0.0.13",
|
153
153
|
"X-Fern-Runtime": core.RUNTIME.type,
|
154
154
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
155
155
|
},
|
@@ -64,7 +64,7 @@ export declare class Sessions {
|
|
64
64
|
/**
|
65
65
|
* Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
|
66
66
|
*
|
67
|
-
* @param {string} id - ID of the session to delete
|
67
|
+
* @param {string} id - ID of the session to delete.
|
68
68
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
69
69
|
*
|
70
70
|
* @example
|