airbrowser-client 1.1.8
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/.openapi-generator/FILES +74 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +165 -0
- package/api.ts +4299 -0
- package/base.ts +62 -0
- package/common.ts +113 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +2543 -0
- package/dist/api.js +3260 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +28 -0
- package/dist/common.js +124 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +2543 -0
- package/dist/esm/api.js +3241 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +28 -0
- package/dist/esm/common.js +112 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/ActionResult.md +26 -0
- package/docs/AttributeResponse.md +26 -0
- package/docs/BaseResponse.md +24 -0
- package/docs/BrowserApi.md +1922 -0
- package/docs/BrowserConfig.md +36 -0
- package/docs/BrowserCreated.md +26 -0
- package/docs/BrowserCreationData.md +22 -0
- package/docs/BrowserInfoResponse.md +26 -0
- package/docs/BrowserList.md +26 -0
- package/docs/BrowserListData.md +22 -0
- package/docs/CheckElementRequest.md +24 -0
- package/docs/ClickRequest.md +26 -0
- package/docs/CombinedDialogRequest.md +22 -0
- package/docs/CombinedEmulateRequest.md +32 -0
- package/docs/CombinedGuiClickRequest.md +30 -0
- package/docs/CombinedScrollRequest.md +32 -0
- package/docs/ConsoleLogsRequest.md +22 -0
- package/docs/ContentData.md +24 -0
- package/docs/ContentResponse.md +26 -0
- package/docs/CreateProfileRequest.md +20 -0
- package/docs/DetectCoordinatesRequest.md +20 -0
- package/docs/DetectCoordinatesResult.md +44 -0
- package/docs/ElementDataRequest.md +26 -0
- package/docs/ErrorResponse.md +24 -0
- package/docs/ExecuteData.md +20 -0
- package/docs/ExecuteRequest.md +22 -0
- package/docs/ExecuteResponse.md +26 -0
- package/docs/FillFormRequest.md +22 -0
- package/docs/FormField.md +22 -0
- package/docs/HealthApi.md +95 -0
- package/docs/HealthStatus.md +24 -0
- package/docs/HistoryRequest.md +20 -0
- package/docs/LogsResponse.md +26 -0
- package/docs/MouseRequest.md +28 -0
- package/docs/NavigateRequest.md +22 -0
- package/docs/NetworkLogsRequest.md +22 -0
- package/docs/PerformanceRequest.md +22 -0
- package/docs/PoolApi.md +104 -0
- package/docs/PoolScaled.md +26 -0
- package/docs/PoolStatusResponse.md +26 -0
- package/docs/PressKeysRequest.md +24 -0
- package/docs/ProfileInfo.md +28 -0
- package/docs/ProfileListData.md +20 -0
- package/docs/ProfileListResponse.md +26 -0
- package/docs/ProfileResponse.md +26 -0
- package/docs/ProfilesApi.md +209 -0
- package/docs/ResizeRequest.md +22 -0
- package/docs/ScaleData.md +20 -0
- package/docs/ScalePool.md +20 -0
- package/docs/ScreenshotData.md +22 -0
- package/docs/ScreenshotResponse.md +26 -0
- package/docs/SelectRequest.md +30 -0
- package/docs/SnapshotRequest.md +20 -0
- package/docs/SuccessResponse.md +26 -0
- package/docs/TabsRequest.md +26 -0
- package/docs/TypeRequest.md +26 -0
- package/docs/UploadFileRequest.md +24 -0
- package/docs/UrlData.md +20 -0
- package/docs/UrlResponse.md +26 -0
- package/docs/WaitElementRequest.md +26 -0
- package/docs/WhatIsVisibleResult.md +34 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,2543 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Airbrowser API
|
|
3
|
+
* Undetectable Chrome-in-Docker for developers and agents (REST + MCP)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
export interface ActionResult {
|
|
17
|
+
/**
|
|
18
|
+
* Operation success
|
|
19
|
+
*/
|
|
20
|
+
'success': boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Status message
|
|
23
|
+
*/
|
|
24
|
+
'message': string;
|
|
25
|
+
/**
|
|
26
|
+
* Unix timestamp
|
|
27
|
+
*/
|
|
28
|
+
'timestamp': number;
|
|
29
|
+
/**
|
|
30
|
+
* Action result data
|
|
31
|
+
*/
|
|
32
|
+
'data'?: object;
|
|
33
|
+
}
|
|
34
|
+
export interface AttributeResponse {
|
|
35
|
+
/**
|
|
36
|
+
* Operation success
|
|
37
|
+
*/
|
|
38
|
+
'success'?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Status message
|
|
41
|
+
*/
|
|
42
|
+
'message'?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Unix timestamp
|
|
45
|
+
*/
|
|
46
|
+
'timestamp'?: number;
|
|
47
|
+
/**
|
|
48
|
+
* Attribute/property data
|
|
49
|
+
*/
|
|
50
|
+
'data'?: object;
|
|
51
|
+
}
|
|
52
|
+
export interface BaseResponse {
|
|
53
|
+
/**
|
|
54
|
+
* Operation success
|
|
55
|
+
*/
|
|
56
|
+
'success': boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Status message
|
|
59
|
+
*/
|
|
60
|
+
'message': string;
|
|
61
|
+
/**
|
|
62
|
+
* Unix timestamp
|
|
63
|
+
*/
|
|
64
|
+
'timestamp': number;
|
|
65
|
+
}
|
|
66
|
+
export interface BrowserConfig {
|
|
67
|
+
/**
|
|
68
|
+
* Profile name for persistent data. Omit for fresh session.
|
|
69
|
+
*/
|
|
70
|
+
'profile_name'?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Proxy server URL
|
|
73
|
+
*/
|
|
74
|
+
'proxy'?: string;
|
|
75
|
+
/**
|
|
76
|
+
* Custom user agent string
|
|
77
|
+
*/
|
|
78
|
+
'user_agent'?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Browser window size [width, height]
|
|
81
|
+
*/
|
|
82
|
+
'window_size'?: Array<number>;
|
|
83
|
+
/**
|
|
84
|
+
* Disable GPU acceleration
|
|
85
|
+
*/
|
|
86
|
+
'disable_gpu'?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* Disable image loading
|
|
89
|
+
*/
|
|
90
|
+
'disable_images'?: boolean;
|
|
91
|
+
/**
|
|
92
|
+
* Disable JavaScript
|
|
93
|
+
*/
|
|
94
|
+
'disable_javascript'?: boolean;
|
|
95
|
+
/**
|
|
96
|
+
* Chrome extension paths
|
|
97
|
+
*/
|
|
98
|
+
'extensions'?: Array<string>;
|
|
99
|
+
/**
|
|
100
|
+
* Custom Chrome arguments
|
|
101
|
+
*/
|
|
102
|
+
'custom_args'?: Array<string>;
|
|
103
|
+
}
|
|
104
|
+
export interface BrowserCreated {
|
|
105
|
+
/**
|
|
106
|
+
* Operation success
|
|
107
|
+
*/
|
|
108
|
+
'success': boolean;
|
|
109
|
+
/**
|
|
110
|
+
* Status message
|
|
111
|
+
*/
|
|
112
|
+
'message': string;
|
|
113
|
+
/**
|
|
114
|
+
* Unix timestamp
|
|
115
|
+
*/
|
|
116
|
+
'timestamp': number;
|
|
117
|
+
/**
|
|
118
|
+
* Browser creation data
|
|
119
|
+
*/
|
|
120
|
+
'data'?: BrowserCreationData;
|
|
121
|
+
}
|
|
122
|
+
export interface BrowserCreationData {
|
|
123
|
+
/**
|
|
124
|
+
* Unique browser identifier
|
|
125
|
+
*/
|
|
126
|
+
'browser_id': string;
|
|
127
|
+
/**
|
|
128
|
+
* Browser configuration used
|
|
129
|
+
*/
|
|
130
|
+
'config'?: object;
|
|
131
|
+
}
|
|
132
|
+
export interface BrowserInfoResponse {
|
|
133
|
+
/**
|
|
134
|
+
* Operation success
|
|
135
|
+
*/
|
|
136
|
+
'success': boolean;
|
|
137
|
+
/**
|
|
138
|
+
* Status message
|
|
139
|
+
*/
|
|
140
|
+
'message': string;
|
|
141
|
+
/**
|
|
142
|
+
* Unix timestamp
|
|
143
|
+
*/
|
|
144
|
+
'timestamp': number;
|
|
145
|
+
/**
|
|
146
|
+
* Browser information
|
|
147
|
+
*/
|
|
148
|
+
'data'?: object;
|
|
149
|
+
}
|
|
150
|
+
export interface BrowserList {
|
|
151
|
+
/**
|
|
152
|
+
* Operation success
|
|
153
|
+
*/
|
|
154
|
+
'success': boolean;
|
|
155
|
+
/**
|
|
156
|
+
* Status message
|
|
157
|
+
*/
|
|
158
|
+
'message': string;
|
|
159
|
+
/**
|
|
160
|
+
* Unix timestamp
|
|
161
|
+
*/
|
|
162
|
+
'timestamp': number;
|
|
163
|
+
/**
|
|
164
|
+
* Browser list data
|
|
165
|
+
*/
|
|
166
|
+
'data'?: BrowserListData;
|
|
167
|
+
}
|
|
168
|
+
export interface BrowserListData {
|
|
169
|
+
/**
|
|
170
|
+
* List of active browsers
|
|
171
|
+
*/
|
|
172
|
+
'browsers'?: Array<object>;
|
|
173
|
+
/**
|
|
174
|
+
* Total browser count
|
|
175
|
+
*/
|
|
176
|
+
'count'?: number;
|
|
177
|
+
}
|
|
178
|
+
export interface CheckElementRequest {
|
|
179
|
+
/**
|
|
180
|
+
* Element selector
|
|
181
|
+
*/
|
|
182
|
+
'selector': string;
|
|
183
|
+
/**
|
|
184
|
+
* Selector type (css, id, name, xpath)
|
|
185
|
+
*/
|
|
186
|
+
'by'?: string;
|
|
187
|
+
/**
|
|
188
|
+
* Check type: exists or visible
|
|
189
|
+
*/
|
|
190
|
+
'check': CheckElementRequestCheckEnum;
|
|
191
|
+
}
|
|
192
|
+
export declare const CheckElementRequestCheckEnum: {
|
|
193
|
+
readonly Exists: "exists";
|
|
194
|
+
readonly Visible: "visible";
|
|
195
|
+
};
|
|
196
|
+
export type CheckElementRequestCheckEnum = typeof CheckElementRequestCheckEnum[keyof typeof CheckElementRequestCheckEnum];
|
|
197
|
+
export interface ClickRequest {
|
|
198
|
+
/**
|
|
199
|
+
* Element selector
|
|
200
|
+
*/
|
|
201
|
+
'selector': string;
|
|
202
|
+
/**
|
|
203
|
+
* Selector type: css, id, name, xpath
|
|
204
|
+
*/
|
|
205
|
+
'by'?: string;
|
|
206
|
+
/**
|
|
207
|
+
* Timeout in seconds
|
|
208
|
+
*/
|
|
209
|
+
'timeout'?: number;
|
|
210
|
+
/**
|
|
211
|
+
* Only click if element is visible
|
|
212
|
+
*/
|
|
213
|
+
'if_visible'?: boolean;
|
|
214
|
+
}
|
|
215
|
+
export interface CombinedDialogRequest {
|
|
216
|
+
/**
|
|
217
|
+
* Dialog action: get, accept, or dismiss
|
|
218
|
+
*/
|
|
219
|
+
'action': CombinedDialogRequestActionEnum;
|
|
220
|
+
/**
|
|
221
|
+
* Text to enter for prompt dialogs (for \'accept\' action)
|
|
222
|
+
*/
|
|
223
|
+
'text'?: string;
|
|
224
|
+
}
|
|
225
|
+
export declare const CombinedDialogRequestActionEnum: {
|
|
226
|
+
readonly Get: "get";
|
|
227
|
+
readonly Accept: "accept";
|
|
228
|
+
readonly Dismiss: "dismiss";
|
|
229
|
+
};
|
|
230
|
+
export type CombinedDialogRequestActionEnum = typeof CombinedDialogRequestActionEnum[keyof typeof CombinedDialogRequestActionEnum];
|
|
231
|
+
export interface CombinedEmulateRequest {
|
|
232
|
+
/**
|
|
233
|
+
* Emulation action: set, clear, or list_devices
|
|
234
|
+
*/
|
|
235
|
+
'action'?: CombinedEmulateRequestActionEnum;
|
|
236
|
+
/**
|
|
237
|
+
* Device preset name (e.g., iPhone 14, iPad)
|
|
238
|
+
*/
|
|
239
|
+
'device'?: string;
|
|
240
|
+
/**
|
|
241
|
+
* Custom viewport width
|
|
242
|
+
*/
|
|
243
|
+
'width'?: number;
|
|
244
|
+
/**
|
|
245
|
+
* Custom viewport height
|
|
246
|
+
*/
|
|
247
|
+
'height'?: number;
|
|
248
|
+
/**
|
|
249
|
+
* Device pixel ratio
|
|
250
|
+
*/
|
|
251
|
+
'device_scale_factor'?: number;
|
|
252
|
+
/**
|
|
253
|
+
* Enable touch events
|
|
254
|
+
*/
|
|
255
|
+
'mobile'?: boolean;
|
|
256
|
+
/**
|
|
257
|
+
* Custom user agent
|
|
258
|
+
*/
|
|
259
|
+
'user_agent'?: string;
|
|
260
|
+
}
|
|
261
|
+
export declare const CombinedEmulateRequestActionEnum: {
|
|
262
|
+
readonly Set: "set";
|
|
263
|
+
readonly Clear: "clear";
|
|
264
|
+
readonly ListDevices: "list_devices";
|
|
265
|
+
};
|
|
266
|
+
export type CombinedEmulateRequestActionEnum = typeof CombinedEmulateRequestActionEnum[keyof typeof CombinedEmulateRequestActionEnum];
|
|
267
|
+
export interface CombinedGuiClickRequest {
|
|
268
|
+
/**
|
|
269
|
+
* Element selector (for selector mode)
|
|
270
|
+
*/
|
|
271
|
+
'selector'?: string;
|
|
272
|
+
/**
|
|
273
|
+
* Screen X coordinate (for coordinate mode)
|
|
274
|
+
*/
|
|
275
|
+
'x'?: number;
|
|
276
|
+
/**
|
|
277
|
+
* Screen Y coordinate (for coordinate mode)
|
|
278
|
+
*/
|
|
279
|
+
'y'?: number;
|
|
280
|
+
/**
|
|
281
|
+
* Mouse move duration (seconds)
|
|
282
|
+
*/
|
|
283
|
+
'timeframe'?: number;
|
|
284
|
+
/**
|
|
285
|
+
* Relative X (0..1) within element to click
|
|
286
|
+
*/
|
|
287
|
+
'fx'?: number;
|
|
288
|
+
/**
|
|
289
|
+
* Relative Y (0..1) within element to click
|
|
290
|
+
*/
|
|
291
|
+
'fy'?: number;
|
|
292
|
+
}
|
|
293
|
+
export interface CombinedScrollRequest {
|
|
294
|
+
/**
|
|
295
|
+
* Element selector to scroll to
|
|
296
|
+
*/
|
|
297
|
+
'selector'?: string;
|
|
298
|
+
/**
|
|
299
|
+
* Selector type (css, id, name, xpath)
|
|
300
|
+
*/
|
|
301
|
+
'by'?: string;
|
|
302
|
+
/**
|
|
303
|
+
* X coordinate to scroll to (absolute)
|
|
304
|
+
*/
|
|
305
|
+
'x'?: number;
|
|
306
|
+
/**
|
|
307
|
+
* Y coordinate to scroll to (absolute)
|
|
308
|
+
*/
|
|
309
|
+
'y'?: number;
|
|
310
|
+
/**
|
|
311
|
+
* Horizontal scroll amount (relative)
|
|
312
|
+
*/
|
|
313
|
+
'delta_x'?: number;
|
|
314
|
+
/**
|
|
315
|
+
* Vertical scroll amount (relative)
|
|
316
|
+
*/
|
|
317
|
+
'delta_y'?: number;
|
|
318
|
+
/**
|
|
319
|
+
* Scroll behavior: smooth or instant
|
|
320
|
+
*/
|
|
321
|
+
'behavior'?: string;
|
|
322
|
+
}
|
|
323
|
+
export interface ConsoleLogsRequest {
|
|
324
|
+
/**
|
|
325
|
+
* Action: get or clear
|
|
326
|
+
*/
|
|
327
|
+
'action': ConsoleLogsRequestActionEnum;
|
|
328
|
+
/**
|
|
329
|
+
* Max number of logs to return (for get)
|
|
330
|
+
*/
|
|
331
|
+
'limit'?: number;
|
|
332
|
+
}
|
|
333
|
+
export declare const ConsoleLogsRequestActionEnum: {
|
|
334
|
+
readonly Get: "get";
|
|
335
|
+
readonly Clear: "clear";
|
|
336
|
+
};
|
|
337
|
+
export type ConsoleLogsRequestActionEnum = typeof ConsoleLogsRequestActionEnum[keyof typeof ConsoleLogsRequestActionEnum];
|
|
338
|
+
export interface ContentData {
|
|
339
|
+
/**
|
|
340
|
+
* Page HTML content
|
|
341
|
+
*/
|
|
342
|
+
'html'?: string;
|
|
343
|
+
/**
|
|
344
|
+
* Page title
|
|
345
|
+
*/
|
|
346
|
+
'title'?: string;
|
|
347
|
+
/**
|
|
348
|
+
* Current URL
|
|
349
|
+
*/
|
|
350
|
+
'url'?: string;
|
|
351
|
+
}
|
|
352
|
+
export interface ContentResponse {
|
|
353
|
+
/**
|
|
354
|
+
* Operation success
|
|
355
|
+
*/
|
|
356
|
+
'success': boolean;
|
|
357
|
+
/**
|
|
358
|
+
* Status message
|
|
359
|
+
*/
|
|
360
|
+
'message': string;
|
|
361
|
+
/**
|
|
362
|
+
* Unix timestamp
|
|
363
|
+
*/
|
|
364
|
+
'timestamp': number;
|
|
365
|
+
/**
|
|
366
|
+
* Page content data
|
|
367
|
+
*/
|
|
368
|
+
'data'?: ContentData;
|
|
369
|
+
}
|
|
370
|
+
export interface CreateProfileRequest {
|
|
371
|
+
/**
|
|
372
|
+
* Profile name
|
|
373
|
+
*/
|
|
374
|
+
'name': string;
|
|
375
|
+
}
|
|
376
|
+
export interface DetectCoordinatesRequest {
|
|
377
|
+
/**
|
|
378
|
+
* Natural language description of element to find
|
|
379
|
+
*/
|
|
380
|
+
'prompt': string;
|
|
381
|
+
}
|
|
382
|
+
export interface DetectCoordinatesResult {
|
|
383
|
+
/**
|
|
384
|
+
* Operation success
|
|
385
|
+
*/
|
|
386
|
+
'success'?: boolean;
|
|
387
|
+
/**
|
|
388
|
+
* Success message
|
|
389
|
+
*/
|
|
390
|
+
'message'?: string;
|
|
391
|
+
/**
|
|
392
|
+
* Unix timestamp
|
|
393
|
+
*/
|
|
394
|
+
'timestamp'?: number;
|
|
395
|
+
/**
|
|
396
|
+
* Element description used
|
|
397
|
+
*/
|
|
398
|
+
'prompt'?: string;
|
|
399
|
+
/**
|
|
400
|
+
* Full coordinate information
|
|
401
|
+
*/
|
|
402
|
+
'coordinates'?: object;
|
|
403
|
+
/**
|
|
404
|
+
* Element bounding box {x, y, width, height}
|
|
405
|
+
*/
|
|
406
|
+
'bounding_box'?: object;
|
|
407
|
+
/**
|
|
408
|
+
* Recommended click point {x, y}
|
|
409
|
+
*/
|
|
410
|
+
'click_point'?: object;
|
|
411
|
+
/**
|
|
412
|
+
* Path to screenshot analyzed
|
|
413
|
+
*/
|
|
414
|
+
'screenshot_path'?: string;
|
|
415
|
+
/**
|
|
416
|
+
* Vision model used for detection
|
|
417
|
+
*/
|
|
418
|
+
'model_used'?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Detection confidence (0.0-1.0)
|
|
421
|
+
*/
|
|
422
|
+
'confidence'?: number;
|
|
423
|
+
/**
|
|
424
|
+
* Models attempted if detection failed
|
|
425
|
+
*/
|
|
426
|
+
'models_tried'?: Array<string>;
|
|
427
|
+
/**
|
|
428
|
+
* Additional result data
|
|
429
|
+
*/
|
|
430
|
+
'data'?: object;
|
|
431
|
+
/**
|
|
432
|
+
* Error message if failed
|
|
433
|
+
*/
|
|
434
|
+
'error'?: string;
|
|
435
|
+
}
|
|
436
|
+
export interface ElementDataRequest {
|
|
437
|
+
/**
|
|
438
|
+
* Element selector
|
|
439
|
+
*/
|
|
440
|
+
'selector': string;
|
|
441
|
+
/**
|
|
442
|
+
* Selector type (css, id, name, xpath)
|
|
443
|
+
*/
|
|
444
|
+
'by'?: string;
|
|
445
|
+
/**
|
|
446
|
+
* Data type: text, attribute, or property
|
|
447
|
+
*/
|
|
448
|
+
'type': ElementDataRequestTypeEnum;
|
|
449
|
+
/**
|
|
450
|
+
* Attribute/property name (required for attribute/property)
|
|
451
|
+
*/
|
|
452
|
+
'name'?: string;
|
|
453
|
+
}
|
|
454
|
+
export declare const ElementDataRequestTypeEnum: {
|
|
455
|
+
readonly Text: "text";
|
|
456
|
+
readonly Attribute: "attribute";
|
|
457
|
+
readonly Property: "property";
|
|
458
|
+
};
|
|
459
|
+
export type ElementDataRequestTypeEnum = typeof ElementDataRequestTypeEnum[keyof typeof ElementDataRequestTypeEnum];
|
|
460
|
+
export interface ErrorResponse {
|
|
461
|
+
/**
|
|
462
|
+
* Operation success (false)
|
|
463
|
+
*/
|
|
464
|
+
'success'?: boolean;
|
|
465
|
+
/**
|
|
466
|
+
* Error message
|
|
467
|
+
*/
|
|
468
|
+
'message'?: string;
|
|
469
|
+
/**
|
|
470
|
+
* Unix timestamp
|
|
471
|
+
*/
|
|
472
|
+
'timestamp'?: number;
|
|
473
|
+
}
|
|
474
|
+
export interface ExecuteData {
|
|
475
|
+
/**
|
|
476
|
+
* Script execution result
|
|
477
|
+
*/
|
|
478
|
+
'result'?: object;
|
|
479
|
+
}
|
|
480
|
+
export interface ExecuteRequest {
|
|
481
|
+
/**
|
|
482
|
+
* JavaScript code to execute
|
|
483
|
+
*/
|
|
484
|
+
'script': string;
|
|
485
|
+
/**
|
|
486
|
+
* Timeout in seconds
|
|
487
|
+
*/
|
|
488
|
+
'timeout'?: number;
|
|
489
|
+
}
|
|
490
|
+
export interface ExecuteResponse {
|
|
491
|
+
/**
|
|
492
|
+
* Operation success
|
|
493
|
+
*/
|
|
494
|
+
'success': boolean;
|
|
495
|
+
/**
|
|
496
|
+
* Status message
|
|
497
|
+
*/
|
|
498
|
+
'message': string;
|
|
499
|
+
/**
|
|
500
|
+
* Unix timestamp
|
|
501
|
+
*/
|
|
502
|
+
'timestamp': number;
|
|
503
|
+
/**
|
|
504
|
+
* Execution result
|
|
505
|
+
*/
|
|
506
|
+
'data'?: ExecuteData;
|
|
507
|
+
}
|
|
508
|
+
export interface FillFormRequest {
|
|
509
|
+
/**
|
|
510
|
+
* Fields to fill
|
|
511
|
+
*/
|
|
512
|
+
'fields': Array<FormField>;
|
|
513
|
+
/**
|
|
514
|
+
* Selector type (css, id, name, xpath)
|
|
515
|
+
*/
|
|
516
|
+
'by'?: string;
|
|
517
|
+
}
|
|
518
|
+
export interface FormField {
|
|
519
|
+
/**
|
|
520
|
+
* Field selector
|
|
521
|
+
*/
|
|
522
|
+
'selector': string;
|
|
523
|
+
/**
|
|
524
|
+
* Value to fill
|
|
525
|
+
*/
|
|
526
|
+
'value': string;
|
|
527
|
+
}
|
|
528
|
+
export interface HealthStatus {
|
|
529
|
+
/**
|
|
530
|
+
* Health status
|
|
531
|
+
*/
|
|
532
|
+
'status'?: string;
|
|
533
|
+
/**
|
|
534
|
+
* Pool status information
|
|
535
|
+
*/
|
|
536
|
+
'pool'?: object;
|
|
537
|
+
/**
|
|
538
|
+
* Unix timestamp
|
|
539
|
+
*/
|
|
540
|
+
'timestamp'?: number;
|
|
541
|
+
}
|
|
542
|
+
export interface HistoryRequest {
|
|
543
|
+
/**
|
|
544
|
+
* History action: back, forward, or refresh
|
|
545
|
+
*/
|
|
546
|
+
'action': HistoryRequestActionEnum;
|
|
547
|
+
}
|
|
548
|
+
export declare const HistoryRequestActionEnum: {
|
|
549
|
+
readonly Back: "back";
|
|
550
|
+
readonly Forward: "forward";
|
|
551
|
+
readonly Refresh: "refresh";
|
|
552
|
+
};
|
|
553
|
+
export type HistoryRequestActionEnum = typeof HistoryRequestActionEnum[keyof typeof HistoryRequestActionEnum];
|
|
554
|
+
export interface LogsResponse {
|
|
555
|
+
/**
|
|
556
|
+
* Operation success
|
|
557
|
+
*/
|
|
558
|
+
'success': boolean;
|
|
559
|
+
/**
|
|
560
|
+
* Status message
|
|
561
|
+
*/
|
|
562
|
+
'message': string;
|
|
563
|
+
/**
|
|
564
|
+
* Unix timestamp
|
|
565
|
+
*/
|
|
566
|
+
'timestamp': number;
|
|
567
|
+
/**
|
|
568
|
+
* Log entries
|
|
569
|
+
*/
|
|
570
|
+
'data'?: object;
|
|
571
|
+
}
|
|
572
|
+
export interface MouseRequest {
|
|
573
|
+
/**
|
|
574
|
+
* Action: hover or drag
|
|
575
|
+
*/
|
|
576
|
+
'action': string;
|
|
577
|
+
/**
|
|
578
|
+
* Element selector (for hover)
|
|
579
|
+
*/
|
|
580
|
+
'selector'?: string;
|
|
581
|
+
/**
|
|
582
|
+
* Source selector (for drag)
|
|
583
|
+
*/
|
|
584
|
+
'source'?: string;
|
|
585
|
+
/**
|
|
586
|
+
* Target selector (for drag)
|
|
587
|
+
*/
|
|
588
|
+
'target'?: string;
|
|
589
|
+
/**
|
|
590
|
+
* Selector type: css, id, name, xpath
|
|
591
|
+
*/
|
|
592
|
+
'by'?: string;
|
|
593
|
+
}
|
|
594
|
+
export interface NavigateRequest {
|
|
595
|
+
/**
|
|
596
|
+
* URL to navigate to
|
|
597
|
+
*/
|
|
598
|
+
'url': string;
|
|
599
|
+
/**
|
|
600
|
+
* Navigation timeout in seconds
|
|
601
|
+
*/
|
|
602
|
+
'timeout'?: number;
|
|
603
|
+
}
|
|
604
|
+
export interface NetworkLogsRequest {
|
|
605
|
+
/**
|
|
606
|
+
* Action: get or clear
|
|
607
|
+
*/
|
|
608
|
+
'action': NetworkLogsRequestActionEnum;
|
|
609
|
+
/**
|
|
610
|
+
* Max number of logs to return (for get)
|
|
611
|
+
*/
|
|
612
|
+
'limit'?: number;
|
|
613
|
+
}
|
|
614
|
+
export declare const NetworkLogsRequestActionEnum: {
|
|
615
|
+
readonly Get: "get";
|
|
616
|
+
readonly Clear: "clear";
|
|
617
|
+
};
|
|
618
|
+
export type NetworkLogsRequestActionEnum = typeof NetworkLogsRequestActionEnum[keyof typeof NetworkLogsRequestActionEnum];
|
|
619
|
+
export interface PerformanceRequest {
|
|
620
|
+
/**
|
|
621
|
+
* Performance action: start_trace, stop_trace, metrics, or analyze
|
|
622
|
+
*/
|
|
623
|
+
'action': PerformanceRequestActionEnum;
|
|
624
|
+
/**
|
|
625
|
+
* Comma-separated trace categories (for start_trace)
|
|
626
|
+
*/
|
|
627
|
+
'categories'?: string;
|
|
628
|
+
}
|
|
629
|
+
export declare const PerformanceRequestActionEnum: {
|
|
630
|
+
readonly StartTrace: "start_trace";
|
|
631
|
+
readonly StopTrace: "stop_trace";
|
|
632
|
+
readonly Metrics: "metrics";
|
|
633
|
+
readonly Analyze: "analyze";
|
|
634
|
+
};
|
|
635
|
+
export type PerformanceRequestActionEnum = typeof PerformanceRequestActionEnum[keyof typeof PerformanceRequestActionEnum];
|
|
636
|
+
export interface PoolScaled {
|
|
637
|
+
/**
|
|
638
|
+
* Operation success
|
|
639
|
+
*/
|
|
640
|
+
'success': boolean;
|
|
641
|
+
/**
|
|
642
|
+
* Status message
|
|
643
|
+
*/
|
|
644
|
+
'message': string;
|
|
645
|
+
/**
|
|
646
|
+
* Unix timestamp
|
|
647
|
+
*/
|
|
648
|
+
'timestamp': number;
|
|
649
|
+
/**
|
|
650
|
+
* Scale result
|
|
651
|
+
*/
|
|
652
|
+
'data'?: ScaleData;
|
|
653
|
+
}
|
|
654
|
+
export interface PoolStatusResponse {
|
|
655
|
+
/**
|
|
656
|
+
* Operation success
|
|
657
|
+
*/
|
|
658
|
+
'success': boolean;
|
|
659
|
+
/**
|
|
660
|
+
* Status message
|
|
661
|
+
*/
|
|
662
|
+
'message': string;
|
|
663
|
+
/**
|
|
664
|
+
* Unix timestamp
|
|
665
|
+
*/
|
|
666
|
+
'timestamp': number;
|
|
667
|
+
/**
|
|
668
|
+
* Pool status information
|
|
669
|
+
*/
|
|
670
|
+
'data'?: object;
|
|
671
|
+
}
|
|
672
|
+
export interface PressKeysRequest {
|
|
673
|
+
/**
|
|
674
|
+
* Element selector
|
|
675
|
+
*/
|
|
676
|
+
'selector': string;
|
|
677
|
+
/**
|
|
678
|
+
* Selector type: css, id, name, xpath
|
|
679
|
+
*/
|
|
680
|
+
'by'?: string;
|
|
681
|
+
/**
|
|
682
|
+
* Keys to press
|
|
683
|
+
*/
|
|
684
|
+
'keys': string;
|
|
685
|
+
}
|
|
686
|
+
export interface ProfileInfo {
|
|
687
|
+
/**
|
|
688
|
+
* Profile name
|
|
689
|
+
*/
|
|
690
|
+
'name'?: string;
|
|
691
|
+
/**
|
|
692
|
+
* Profile storage path
|
|
693
|
+
*/
|
|
694
|
+
'path'?: string;
|
|
695
|
+
/**
|
|
696
|
+
* Profile size in MB
|
|
697
|
+
*/
|
|
698
|
+
'size_mb'?: number;
|
|
699
|
+
/**
|
|
700
|
+
* Last used timestamp (ISO format)
|
|
701
|
+
*/
|
|
702
|
+
'last_used'?: string;
|
|
703
|
+
/**
|
|
704
|
+
* Whether profile is currently in use by a browser
|
|
705
|
+
*/
|
|
706
|
+
'in_use'?: boolean;
|
|
707
|
+
}
|
|
708
|
+
export interface ProfileListData {
|
|
709
|
+
/**
|
|
710
|
+
* List of profiles
|
|
711
|
+
*/
|
|
712
|
+
'profiles'?: Array<ProfileInfo>;
|
|
713
|
+
}
|
|
714
|
+
export interface ProfileListResponse {
|
|
715
|
+
/**
|
|
716
|
+
* Operation success
|
|
717
|
+
*/
|
|
718
|
+
'success'?: boolean;
|
|
719
|
+
/**
|
|
720
|
+
* Status message
|
|
721
|
+
*/
|
|
722
|
+
'message'?: string;
|
|
723
|
+
/**
|
|
724
|
+
* Unix timestamp
|
|
725
|
+
*/
|
|
726
|
+
'timestamp'?: number;
|
|
727
|
+
'data'?: ProfileListData;
|
|
728
|
+
}
|
|
729
|
+
export interface ProfileResponse {
|
|
730
|
+
/**
|
|
731
|
+
* Operation success
|
|
732
|
+
*/
|
|
733
|
+
'success'?: boolean;
|
|
734
|
+
/**
|
|
735
|
+
* Status message
|
|
736
|
+
*/
|
|
737
|
+
'message'?: string;
|
|
738
|
+
/**
|
|
739
|
+
* Unix timestamp
|
|
740
|
+
*/
|
|
741
|
+
'timestamp'?: number;
|
|
742
|
+
'data'?: ProfileInfo;
|
|
743
|
+
}
|
|
744
|
+
export interface ResizeRequest {
|
|
745
|
+
/**
|
|
746
|
+
* Viewport width
|
|
747
|
+
*/
|
|
748
|
+
'width': number;
|
|
749
|
+
/**
|
|
750
|
+
* Viewport height
|
|
751
|
+
*/
|
|
752
|
+
'height': number;
|
|
753
|
+
}
|
|
754
|
+
export interface ScaleData {
|
|
755
|
+
/**
|
|
756
|
+
* New maximum browser count
|
|
757
|
+
*/
|
|
758
|
+
'new_max_browsers'?: number;
|
|
759
|
+
}
|
|
760
|
+
export interface ScalePool {
|
|
761
|
+
/**
|
|
762
|
+
* New maximum number of browsers
|
|
763
|
+
*/
|
|
764
|
+
'target_size': number;
|
|
765
|
+
}
|
|
766
|
+
export interface ScreenshotData {
|
|
767
|
+
/**
|
|
768
|
+
* URL to screenshot
|
|
769
|
+
*/
|
|
770
|
+
'screenshot_url'?: string;
|
|
771
|
+
/**
|
|
772
|
+
* Path to screenshot file
|
|
773
|
+
*/
|
|
774
|
+
'screenshot_path'?: string;
|
|
775
|
+
}
|
|
776
|
+
export interface ScreenshotResponse {
|
|
777
|
+
/**
|
|
778
|
+
* Operation success
|
|
779
|
+
*/
|
|
780
|
+
'success': boolean;
|
|
781
|
+
/**
|
|
782
|
+
* Status message
|
|
783
|
+
*/
|
|
784
|
+
'message': string;
|
|
785
|
+
/**
|
|
786
|
+
* Unix timestamp
|
|
787
|
+
*/
|
|
788
|
+
'timestamp': number;
|
|
789
|
+
/**
|
|
790
|
+
* Screenshot data
|
|
791
|
+
*/
|
|
792
|
+
'data'?: ScreenshotData;
|
|
793
|
+
}
|
|
794
|
+
export interface SelectRequest {
|
|
795
|
+
/**
|
|
796
|
+
* Select element selector
|
|
797
|
+
*/
|
|
798
|
+
'selector': string;
|
|
799
|
+
/**
|
|
800
|
+
* Selector type (css, id, name, xpath)
|
|
801
|
+
*/
|
|
802
|
+
'by'?: string;
|
|
803
|
+
/**
|
|
804
|
+
* Action: select or options
|
|
805
|
+
*/
|
|
806
|
+
'action'?: SelectRequestActionEnum;
|
|
807
|
+
/**
|
|
808
|
+
* Option value to select
|
|
809
|
+
*/
|
|
810
|
+
'value'?: string;
|
|
811
|
+
/**
|
|
812
|
+
* Option text to select
|
|
813
|
+
*/
|
|
814
|
+
'text'?: string;
|
|
815
|
+
/**
|
|
816
|
+
* Option index to select
|
|
817
|
+
*/
|
|
818
|
+
'index'?: number;
|
|
819
|
+
}
|
|
820
|
+
export declare const SelectRequestActionEnum: {
|
|
821
|
+
readonly Select: "select";
|
|
822
|
+
readonly Options: "options";
|
|
823
|
+
};
|
|
824
|
+
export type SelectRequestActionEnum = typeof SelectRequestActionEnum[keyof typeof SelectRequestActionEnum];
|
|
825
|
+
export interface SnapshotRequest {
|
|
826
|
+
/**
|
|
827
|
+
* Snapshot type: dom or accessibility
|
|
828
|
+
*/
|
|
829
|
+
'type'?: string;
|
|
830
|
+
}
|
|
831
|
+
export interface SuccessResponse {
|
|
832
|
+
/**
|
|
833
|
+
* Operation success
|
|
834
|
+
*/
|
|
835
|
+
'success'?: boolean;
|
|
836
|
+
/**
|
|
837
|
+
* Success message
|
|
838
|
+
*/
|
|
839
|
+
'message'?: string;
|
|
840
|
+
/**
|
|
841
|
+
* Unix timestamp
|
|
842
|
+
*/
|
|
843
|
+
'timestamp'?: number;
|
|
844
|
+
/**
|
|
845
|
+
* Additional result data
|
|
846
|
+
*/
|
|
847
|
+
'data'?: object;
|
|
848
|
+
}
|
|
849
|
+
export interface TabsRequest {
|
|
850
|
+
/**
|
|
851
|
+
* Tab action: list, new, switch, close, or current
|
|
852
|
+
*/
|
|
853
|
+
'action': TabsRequestActionEnum;
|
|
854
|
+
/**
|
|
855
|
+
* URL for new tab (for \'new\' action)
|
|
856
|
+
*/
|
|
857
|
+
'url'?: string;
|
|
858
|
+
/**
|
|
859
|
+
* Tab index (for \'switch\' or \'close\' actions)
|
|
860
|
+
*/
|
|
861
|
+
'index'?: number;
|
|
862
|
+
/**
|
|
863
|
+
* Tab handle (for \'switch\' or \'close\' actions)
|
|
864
|
+
*/
|
|
865
|
+
'handle'?: string;
|
|
866
|
+
}
|
|
867
|
+
export declare const TabsRequestActionEnum: {
|
|
868
|
+
readonly List: "list";
|
|
869
|
+
readonly New: "new";
|
|
870
|
+
readonly Switch: "switch";
|
|
871
|
+
readonly Close: "close";
|
|
872
|
+
readonly Current: "current";
|
|
873
|
+
};
|
|
874
|
+
export type TabsRequestActionEnum = typeof TabsRequestActionEnum[keyof typeof TabsRequestActionEnum];
|
|
875
|
+
export interface TypeRequest {
|
|
876
|
+
/**
|
|
877
|
+
* Element selector
|
|
878
|
+
*/
|
|
879
|
+
'selector': string;
|
|
880
|
+
/**
|
|
881
|
+
* Selector type: css, id, name, xpath
|
|
882
|
+
*/
|
|
883
|
+
'by'?: string;
|
|
884
|
+
/**
|
|
885
|
+
* Text to type
|
|
886
|
+
*/
|
|
887
|
+
'text': string;
|
|
888
|
+
/**
|
|
889
|
+
* Timeout in seconds
|
|
890
|
+
*/
|
|
891
|
+
'timeout'?: number;
|
|
892
|
+
}
|
|
893
|
+
export interface UploadFileRequest {
|
|
894
|
+
/**
|
|
895
|
+
* File input selector
|
|
896
|
+
*/
|
|
897
|
+
'selector': string;
|
|
898
|
+
/**
|
|
899
|
+
* Path to file to upload
|
|
900
|
+
*/
|
|
901
|
+
'file_path': string;
|
|
902
|
+
/**
|
|
903
|
+
* Selector type (css, id, name, xpath)
|
|
904
|
+
*/
|
|
905
|
+
'by'?: string;
|
|
906
|
+
}
|
|
907
|
+
export interface UrlData {
|
|
908
|
+
/**
|
|
909
|
+
* Current URL
|
|
910
|
+
*/
|
|
911
|
+
'url'?: string;
|
|
912
|
+
}
|
|
913
|
+
export interface UrlResponse {
|
|
914
|
+
/**
|
|
915
|
+
* Operation success
|
|
916
|
+
*/
|
|
917
|
+
'success': boolean;
|
|
918
|
+
/**
|
|
919
|
+
* Status message
|
|
920
|
+
*/
|
|
921
|
+
'message': string;
|
|
922
|
+
/**
|
|
923
|
+
* Unix timestamp
|
|
924
|
+
*/
|
|
925
|
+
'timestamp': number;
|
|
926
|
+
/**
|
|
927
|
+
* URL data
|
|
928
|
+
*/
|
|
929
|
+
'data'?: UrlData;
|
|
930
|
+
}
|
|
931
|
+
export interface WaitElementRequest {
|
|
932
|
+
/**
|
|
933
|
+
* Element selector
|
|
934
|
+
*/
|
|
935
|
+
'selector': string;
|
|
936
|
+
/**
|
|
937
|
+
* Selector type (css, id, name, xpath)
|
|
938
|
+
*/
|
|
939
|
+
'by'?: string;
|
|
940
|
+
/**
|
|
941
|
+
* Wait until: visible or hidden
|
|
942
|
+
*/
|
|
943
|
+
'until': WaitElementRequestUntilEnum;
|
|
944
|
+
/**
|
|
945
|
+
* Timeout in seconds
|
|
946
|
+
*/
|
|
947
|
+
'timeout'?: number;
|
|
948
|
+
}
|
|
949
|
+
export declare const WaitElementRequestUntilEnum: {
|
|
950
|
+
readonly Visible: "visible";
|
|
951
|
+
readonly Hidden: "hidden";
|
|
952
|
+
};
|
|
953
|
+
export type WaitElementRequestUntilEnum = typeof WaitElementRequestUntilEnum[keyof typeof WaitElementRequestUntilEnum];
|
|
954
|
+
export interface WhatIsVisibleResult {
|
|
955
|
+
/**
|
|
956
|
+
* Operation success
|
|
957
|
+
*/
|
|
958
|
+
'success'?: boolean;
|
|
959
|
+
/**
|
|
960
|
+
* Success message
|
|
961
|
+
*/
|
|
962
|
+
'message'?: string;
|
|
963
|
+
/**
|
|
964
|
+
* Unix timestamp
|
|
965
|
+
*/
|
|
966
|
+
'timestamp'?: number;
|
|
967
|
+
/**
|
|
968
|
+
* Comprehensive page state analysis
|
|
969
|
+
*/
|
|
970
|
+
'analysis'?: string;
|
|
971
|
+
/**
|
|
972
|
+
* AI model used for analysis
|
|
973
|
+
*/
|
|
974
|
+
'model'?: string;
|
|
975
|
+
/**
|
|
976
|
+
* URL to the screenshot
|
|
977
|
+
*/
|
|
978
|
+
'screenshot_url'?: string;
|
|
979
|
+
/**
|
|
980
|
+
* Path to the screenshot file
|
|
981
|
+
*/
|
|
982
|
+
'screenshot_path'?: string;
|
|
983
|
+
/**
|
|
984
|
+
* Error message if failed
|
|
985
|
+
*/
|
|
986
|
+
'error'?: string;
|
|
987
|
+
}
|
|
988
|
+
/**
|
|
989
|
+
* BrowserApi - axios parameter creator
|
|
990
|
+
*/
|
|
991
|
+
export declare const BrowserApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
992
|
+
/**
|
|
993
|
+
*
|
|
994
|
+
* @summary Check if element exists or is visible
|
|
995
|
+
* @param {string} browserId Unique browser identifier
|
|
996
|
+
* @param {CheckElementRequest} payload
|
|
997
|
+
* @param {*} [options] Override http request option.
|
|
998
|
+
* @throws {RequiredError}
|
|
999
|
+
*/
|
|
1000
|
+
checkElement: (browserId: string, payload: CheckElementRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Use if_visible=true to only click if visible.
|
|
1003
|
+
* @summary Click element
|
|
1004
|
+
* @param {string} browserId Unique browser identifier
|
|
1005
|
+
* @param {ClickRequest} payload
|
|
1006
|
+
* @param {*} [options] Override http request option.
|
|
1007
|
+
* @throws {RequiredError}
|
|
1008
|
+
*/
|
|
1009
|
+
click: (browserId: string, payload: ClickRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1010
|
+
/**
|
|
1011
|
+
*
|
|
1012
|
+
* @summary Close all active browser instances
|
|
1013
|
+
* @param {*} [options] Override http request option.
|
|
1014
|
+
* @throws {RequiredError}
|
|
1015
|
+
*/
|
|
1016
|
+
closeAllBrowsers: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1017
|
+
/**
|
|
1018
|
+
*
|
|
1019
|
+
* @summary Close a browser instance
|
|
1020
|
+
* @param {string} browserId Unique browser identifier
|
|
1021
|
+
* @param {*} [options] Override http request option.
|
|
1022
|
+
* @throws {RequiredError}
|
|
1023
|
+
*/
|
|
1024
|
+
closeBrowser: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1025
|
+
/**
|
|
1026
|
+
*
|
|
1027
|
+
* @summary Get or clear console logs
|
|
1028
|
+
* @param {string} browserId Unique browser identifier
|
|
1029
|
+
* @param {ConsoleLogsRequest} payload
|
|
1030
|
+
* @param {*} [options] Override http request option.
|
|
1031
|
+
* @throws {RequiredError}
|
|
1032
|
+
*/
|
|
1033
|
+
consoleLogs: (browserId: string, payload: ConsoleLogsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1034
|
+
/**
|
|
1035
|
+
*
|
|
1036
|
+
* @summary Create a new browser instance
|
|
1037
|
+
* @param {BrowserConfig} payload
|
|
1038
|
+
* @param {*} [options] Override http request option.
|
|
1039
|
+
* @throws {RequiredError}
|
|
1040
|
+
*/
|
|
1041
|
+
createBrowser: (payload: BrowserConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1042
|
+
/**
|
|
1043
|
+
*
|
|
1044
|
+
* @summary Close and remove a browser instance
|
|
1045
|
+
* @param {string} browserId Unique browser identifier
|
|
1046
|
+
* @param {*} [options] Override http request option.
|
|
1047
|
+
* @throws {RequiredError}
|
|
1048
|
+
*/
|
|
1049
|
+
deleteBrowser: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1050
|
+
/**
|
|
1051
|
+
*
|
|
1052
|
+
* @summary Detect element coordinates using AI vision
|
|
1053
|
+
* @param {string} browserId Unique browser identifier
|
|
1054
|
+
* @param {DetectCoordinatesRequest} payload
|
|
1055
|
+
* @param {*} [options] Override http request option.
|
|
1056
|
+
* @throws {RequiredError}
|
|
1057
|
+
*/
|
|
1058
|
+
detectCoordinates: (browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1059
|
+
/**
|
|
1060
|
+
*
|
|
1061
|
+
* @summary Manage browser dialogs: get, accept, or dismiss
|
|
1062
|
+
* @param {string} browserId Unique browser identifier
|
|
1063
|
+
* @param {CombinedDialogRequest} payload
|
|
1064
|
+
* @param {*} [options] Override http request option.
|
|
1065
|
+
* @throws {RequiredError}
|
|
1066
|
+
*/
|
|
1067
|
+
dialog: (browserId: string, payload: CombinedDialogRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1068
|
+
/**
|
|
1069
|
+
*
|
|
1070
|
+
* @summary Manage device emulation: set, clear, or list_devices
|
|
1071
|
+
* @param {string} browserId Unique browser identifier
|
|
1072
|
+
* @param {CombinedEmulateRequest} payload
|
|
1073
|
+
* @param {*} [options] Override http request option.
|
|
1074
|
+
* @throws {RequiredError}
|
|
1075
|
+
*/
|
|
1076
|
+
emulate: (browserId: string, payload: CombinedEmulateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1077
|
+
/**
|
|
1078
|
+
*
|
|
1079
|
+
* @summary Execute JavaScript
|
|
1080
|
+
* @param {string} browserId Unique browser identifier
|
|
1081
|
+
* @param {ExecuteRequest} payload
|
|
1082
|
+
* @param {*} [options] Override http request option.
|
|
1083
|
+
* @throws {RequiredError}
|
|
1084
|
+
*/
|
|
1085
|
+
executeScript: (browserId: string, payload: ExecuteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1086
|
+
/**
|
|
1087
|
+
*
|
|
1088
|
+
* @summary Fill multiple form fields
|
|
1089
|
+
* @param {string} browserId Unique browser identifier
|
|
1090
|
+
* @param {FillFormRequest} payload
|
|
1091
|
+
* @param {*} [options] Override http request option.
|
|
1092
|
+
* @throws {RequiredError}
|
|
1093
|
+
*/
|
|
1094
|
+
fillForm: (browserId: string, payload: FillFormRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1095
|
+
/**
|
|
1096
|
+
*
|
|
1097
|
+
* @summary Get browser instance details
|
|
1098
|
+
* @param {string} browserId Unique browser identifier
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
*/
|
|
1102
|
+
getBrowser: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1103
|
+
/**
|
|
1104
|
+
*
|
|
1105
|
+
* @summary Get browser status
|
|
1106
|
+
* @param {string} browserId Unique browser identifier
|
|
1107
|
+
* @param {*} [options] Override http request option.
|
|
1108
|
+
* @throws {RequiredError}
|
|
1109
|
+
*/
|
|
1110
|
+
getBrowserStatus: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1111
|
+
/**
|
|
1112
|
+
*
|
|
1113
|
+
* @summary Get page HTML content
|
|
1114
|
+
* @param {string} browserId Unique browser identifier
|
|
1115
|
+
* @param {*} [options] Override http request option.
|
|
1116
|
+
* @throws {RequiredError}
|
|
1117
|
+
*/
|
|
1118
|
+
getContent: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1119
|
+
/**
|
|
1120
|
+
*
|
|
1121
|
+
* @summary Get element text, attribute, or property
|
|
1122
|
+
* @param {string} browserId Unique browser identifier
|
|
1123
|
+
* @param {ElementDataRequest} payload
|
|
1124
|
+
* @param {*} [options] Override http request option.
|
|
1125
|
+
* @throws {RequiredError}
|
|
1126
|
+
*/
|
|
1127
|
+
getElementData: (browserId: string, payload: ElementDataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1128
|
+
/**
|
|
1129
|
+
*
|
|
1130
|
+
* @summary Get browser pool status
|
|
1131
|
+
* @param {*} [options] Override http request option.
|
|
1132
|
+
* @throws {RequiredError}
|
|
1133
|
+
*/
|
|
1134
|
+
getPoolStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1135
|
+
/**
|
|
1136
|
+
*
|
|
1137
|
+
* @summary Get current page URL
|
|
1138
|
+
* @param {string} browserId Unique browser identifier
|
|
1139
|
+
* @param {*} [options] Override http request option.
|
|
1140
|
+
* @throws {RequiredError}
|
|
1141
|
+
*/
|
|
1142
|
+
getUrl: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1143
|
+
/**
|
|
1144
|
+
*
|
|
1145
|
+
* @summary Click using selector or screen coordinates
|
|
1146
|
+
* @param {string} browserId Unique browser identifier
|
|
1147
|
+
* @param {CombinedGuiClickRequest} payload
|
|
1148
|
+
* @param {*} [options] Override http request option.
|
|
1149
|
+
* @throws {RequiredError}
|
|
1150
|
+
*/
|
|
1151
|
+
guiClick: (browserId: string, payload: CombinedGuiClickRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1152
|
+
/**
|
|
1153
|
+
*
|
|
1154
|
+
* @summary Execute history action: back, forward, or refresh
|
|
1155
|
+
* @param {string} browserId Unique browser identifier
|
|
1156
|
+
* @param {HistoryRequest} payload
|
|
1157
|
+
* @param {*} [options] Override http request option.
|
|
1158
|
+
* @throws {RequiredError}
|
|
1159
|
+
*/
|
|
1160
|
+
history: (browserId: string, payload: HistoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1161
|
+
/**
|
|
1162
|
+
*
|
|
1163
|
+
* @summary List all active browser instances
|
|
1164
|
+
* @param {*} [options] Override http request option.
|
|
1165
|
+
* @throws {RequiredError}
|
|
1166
|
+
*/
|
|
1167
|
+
listBrowsers: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1168
|
+
/**
|
|
1169
|
+
*
|
|
1170
|
+
* @summary Mouse action: hover or drag
|
|
1171
|
+
* @param {string} browserId Unique browser identifier
|
|
1172
|
+
* @param {MouseRequest} payload
|
|
1173
|
+
* @param {*} [options] Override http request option.
|
|
1174
|
+
* @throws {RequiredError}
|
|
1175
|
+
*/
|
|
1176
|
+
mouse: (browserId: string, payload: MouseRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1177
|
+
/**
|
|
1178
|
+
*
|
|
1179
|
+
* @summary Navigate to a URL
|
|
1180
|
+
* @param {string} browserId Unique browser identifier
|
|
1181
|
+
* @param {NavigateRequest} payload
|
|
1182
|
+
* @param {*} [options] Override http request option.
|
|
1183
|
+
* @throws {RequiredError}
|
|
1184
|
+
*/
|
|
1185
|
+
navigateBrowser: (browserId: string, payload: NavigateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1186
|
+
/**
|
|
1187
|
+
*
|
|
1188
|
+
* @summary Get or clear network logs
|
|
1189
|
+
* @param {string} browserId Unique browser identifier
|
|
1190
|
+
* @param {NetworkLogsRequest} payload
|
|
1191
|
+
* @param {*} [options] Override http request option.
|
|
1192
|
+
* @throws {RequiredError}
|
|
1193
|
+
*/
|
|
1194
|
+
networkLogs: (browserId: string, payload: NetworkLogsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @summary Manage performance: start_trace, stop_trace, metrics, or analyze
|
|
1198
|
+
* @param {string} browserId Unique browser identifier
|
|
1199
|
+
* @param {PerformanceRequest} payload
|
|
1200
|
+
* @param {*} [options] Override http request option.
|
|
1201
|
+
* @throws {RequiredError}
|
|
1202
|
+
*/
|
|
1203
|
+
performance: (browserId: string, payload: PerformanceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1204
|
+
/**
|
|
1205
|
+
*
|
|
1206
|
+
* @summary Press keys on an element
|
|
1207
|
+
* @param {string} browserId Unique browser identifier
|
|
1208
|
+
* @param {PressKeysRequest} payload
|
|
1209
|
+
* @param {*} [options] Override http request option.
|
|
1210
|
+
* @throws {RequiredError}
|
|
1211
|
+
*/
|
|
1212
|
+
pressKeys: (browserId: string, payload: PressKeysRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1213
|
+
/**
|
|
1214
|
+
*
|
|
1215
|
+
* @summary Resize viewport
|
|
1216
|
+
* @param {string} browserId Unique browser identifier
|
|
1217
|
+
* @param {ResizeRequest} payload
|
|
1218
|
+
* @param {*} [options] Override http request option.
|
|
1219
|
+
* @throws {RequiredError}
|
|
1220
|
+
*/
|
|
1221
|
+
resize: (browserId: string, payload: ResizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1222
|
+
/**
|
|
1223
|
+
*
|
|
1224
|
+
* @summary Scroll to element/coordinates (absolute) or by delta (relative)
|
|
1225
|
+
* @param {string} browserId Unique browser identifier
|
|
1226
|
+
* @param {CombinedScrollRequest} payload
|
|
1227
|
+
* @param {*} [options] Override http request option.
|
|
1228
|
+
* @throws {RequiredError}
|
|
1229
|
+
*/
|
|
1230
|
+
scroll: (browserId: string, payload: CombinedScrollRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1231
|
+
/**
|
|
1232
|
+
*
|
|
1233
|
+
* @summary Select dropdown: select option or get options
|
|
1234
|
+
* @param {string} browserId Unique browser identifier
|
|
1235
|
+
* @param {SelectRequest} payload
|
|
1236
|
+
* @param {*} [options] Override http request option.
|
|
1237
|
+
* @throws {RequiredError}
|
|
1238
|
+
*/
|
|
1239
|
+
select: (browserId: string, payload: SelectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1240
|
+
/**
|
|
1241
|
+
*
|
|
1242
|
+
* @summary Manage browser tabs: list, new, switch, close, or current
|
|
1243
|
+
* @param {string} browserId Unique browser identifier
|
|
1244
|
+
* @param {TabsRequest} payload
|
|
1245
|
+
* @param {*} [options] Override http request option.
|
|
1246
|
+
* @throws {RequiredError}
|
|
1247
|
+
*/
|
|
1248
|
+
tabs: (browserId: string, payload: TabsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1249
|
+
/**
|
|
1250
|
+
*
|
|
1251
|
+
* @summary Take a screenshot
|
|
1252
|
+
* @param {string} browserId Unique browser identifier
|
|
1253
|
+
* @param {*} [options] Override http request option.
|
|
1254
|
+
* @throws {RequiredError}
|
|
1255
|
+
*/
|
|
1256
|
+
takeScreenshot: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1257
|
+
/**
|
|
1258
|
+
*
|
|
1259
|
+
* @summary Take DOM/accessibility snapshot
|
|
1260
|
+
* @param {string} browserId Unique browser identifier
|
|
1261
|
+
* @param {SnapshotRequest} payload
|
|
1262
|
+
* @param {*} [options] Override http request option.
|
|
1263
|
+
* @throws {RequiredError}
|
|
1264
|
+
*/
|
|
1265
|
+
takeSnapshot: (browserId: string, payload: SnapshotRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1266
|
+
/**
|
|
1267
|
+
*
|
|
1268
|
+
* @summary Type text into an element
|
|
1269
|
+
* @param {string} browserId Unique browser identifier
|
|
1270
|
+
* @param {TypeRequest} payload
|
|
1271
|
+
* @param {*} [options] Override http request option.
|
|
1272
|
+
* @throws {RequiredError}
|
|
1273
|
+
*/
|
|
1274
|
+
typeText: (browserId: string, payload: TypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1275
|
+
/**
|
|
1276
|
+
*
|
|
1277
|
+
* @summary Upload a file
|
|
1278
|
+
* @param {string} browserId Unique browser identifier
|
|
1279
|
+
* @param {UploadFileRequest} payload
|
|
1280
|
+
* @param {*} [options] Override http request option.
|
|
1281
|
+
* @throws {RequiredError}
|
|
1282
|
+
*/
|
|
1283
|
+
uploadFile: (browserId: string, payload: UploadFileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1284
|
+
/**
|
|
1285
|
+
*
|
|
1286
|
+
* @summary Wait for element to become visible or hidden
|
|
1287
|
+
* @param {string} browserId Unique browser identifier
|
|
1288
|
+
* @param {WaitElementRequest} payload
|
|
1289
|
+
* @param {*} [options] Override http request option.
|
|
1290
|
+
* @throws {RequiredError}
|
|
1291
|
+
*/
|
|
1292
|
+
waitElement: (browserId: string, payload: WaitElementRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1293
|
+
/**
|
|
1294
|
+
*
|
|
1295
|
+
* @summary Analyze visible page content using AI
|
|
1296
|
+
* @param {string} browserId Unique browser identifier
|
|
1297
|
+
* @param {*} [options] Override http request option.
|
|
1298
|
+
* @throws {RequiredError}
|
|
1299
|
+
*/
|
|
1300
|
+
whatIsVisible: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1301
|
+
};
|
|
1302
|
+
/**
|
|
1303
|
+
* BrowserApi - functional programming interface
|
|
1304
|
+
*/
|
|
1305
|
+
export declare const BrowserApiFp: (configuration?: Configuration) => {
|
|
1306
|
+
/**
|
|
1307
|
+
*
|
|
1308
|
+
* @summary Check if element exists or is visible
|
|
1309
|
+
* @param {string} browserId Unique browser identifier
|
|
1310
|
+
* @param {CheckElementRequest} payload
|
|
1311
|
+
* @param {*} [options] Override http request option.
|
|
1312
|
+
* @throws {RequiredError}
|
|
1313
|
+
*/
|
|
1314
|
+
checkElement(browserId: string, payload: CheckElementRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1315
|
+
/**
|
|
1316
|
+
* Use if_visible=true to only click if visible.
|
|
1317
|
+
* @summary Click element
|
|
1318
|
+
* @param {string} browserId Unique browser identifier
|
|
1319
|
+
* @param {ClickRequest} payload
|
|
1320
|
+
* @param {*} [options] Override http request option.
|
|
1321
|
+
* @throws {RequiredError}
|
|
1322
|
+
*/
|
|
1323
|
+
click(browserId: string, payload: ClickRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionResult>>;
|
|
1324
|
+
/**
|
|
1325
|
+
*
|
|
1326
|
+
* @summary Close all active browser instances
|
|
1327
|
+
* @param {*} [options] Override http request option.
|
|
1328
|
+
* @throws {RequiredError}
|
|
1329
|
+
*/
|
|
1330
|
+
closeAllBrowsers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseResponse>>;
|
|
1331
|
+
/**
|
|
1332
|
+
*
|
|
1333
|
+
* @summary Close a browser instance
|
|
1334
|
+
* @param {string} browserId Unique browser identifier
|
|
1335
|
+
* @param {*} [options] Override http request option.
|
|
1336
|
+
* @throws {RequiredError}
|
|
1337
|
+
*/
|
|
1338
|
+
closeBrowser(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseResponse>>;
|
|
1339
|
+
/**
|
|
1340
|
+
*
|
|
1341
|
+
* @summary Get or clear console logs
|
|
1342
|
+
* @param {string} browserId Unique browser identifier
|
|
1343
|
+
* @param {ConsoleLogsRequest} payload
|
|
1344
|
+
* @param {*} [options] Override http request option.
|
|
1345
|
+
* @throws {RequiredError}
|
|
1346
|
+
*/
|
|
1347
|
+
consoleLogs(browserId: string, payload: ConsoleLogsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogsResponse>>;
|
|
1348
|
+
/**
|
|
1349
|
+
*
|
|
1350
|
+
* @summary Create a new browser instance
|
|
1351
|
+
* @param {BrowserConfig} payload
|
|
1352
|
+
* @param {*} [options] Override http request option.
|
|
1353
|
+
* @throws {RequiredError}
|
|
1354
|
+
*/
|
|
1355
|
+
createBrowser(payload: BrowserConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowserCreated>>;
|
|
1356
|
+
/**
|
|
1357
|
+
*
|
|
1358
|
+
* @summary Close and remove a browser instance
|
|
1359
|
+
* @param {string} browserId Unique browser identifier
|
|
1360
|
+
* @param {*} [options] Override http request option.
|
|
1361
|
+
* @throws {RequiredError}
|
|
1362
|
+
*/
|
|
1363
|
+
deleteBrowser(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseResponse>>;
|
|
1364
|
+
/**
|
|
1365
|
+
*
|
|
1366
|
+
* @summary Detect element coordinates using AI vision
|
|
1367
|
+
* @param {string} browserId Unique browser identifier
|
|
1368
|
+
* @param {DetectCoordinatesRequest} payload
|
|
1369
|
+
* @param {*} [options] Override http request option.
|
|
1370
|
+
* @throws {RequiredError}
|
|
1371
|
+
*/
|
|
1372
|
+
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetectCoordinatesResult>>;
|
|
1373
|
+
/**
|
|
1374
|
+
*
|
|
1375
|
+
* @summary Manage browser dialogs: get, accept, or dismiss
|
|
1376
|
+
* @param {string} browserId Unique browser identifier
|
|
1377
|
+
* @param {CombinedDialogRequest} payload
|
|
1378
|
+
* @param {*} [options] Override http request option.
|
|
1379
|
+
* @throws {RequiredError}
|
|
1380
|
+
*/
|
|
1381
|
+
dialog(browserId: string, payload: CombinedDialogRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1382
|
+
/**
|
|
1383
|
+
*
|
|
1384
|
+
* @summary Manage device emulation: set, clear, or list_devices
|
|
1385
|
+
* @param {string} browserId Unique browser identifier
|
|
1386
|
+
* @param {CombinedEmulateRequest} payload
|
|
1387
|
+
* @param {*} [options] Override http request option.
|
|
1388
|
+
* @throws {RequiredError}
|
|
1389
|
+
*/
|
|
1390
|
+
emulate(browserId: string, payload: CombinedEmulateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1391
|
+
/**
|
|
1392
|
+
*
|
|
1393
|
+
* @summary Execute JavaScript
|
|
1394
|
+
* @param {string} browserId Unique browser identifier
|
|
1395
|
+
* @param {ExecuteRequest} payload
|
|
1396
|
+
* @param {*} [options] Override http request option.
|
|
1397
|
+
* @throws {RequiredError}
|
|
1398
|
+
*/
|
|
1399
|
+
executeScript(browserId: string, payload: ExecuteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteResponse>>;
|
|
1400
|
+
/**
|
|
1401
|
+
*
|
|
1402
|
+
* @summary Fill multiple form fields
|
|
1403
|
+
* @param {string} browserId Unique browser identifier
|
|
1404
|
+
* @param {FillFormRequest} payload
|
|
1405
|
+
* @param {*} [options] Override http request option.
|
|
1406
|
+
* @throws {RequiredError}
|
|
1407
|
+
*/
|
|
1408
|
+
fillForm(browserId: string, payload: FillFormRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1409
|
+
/**
|
|
1410
|
+
*
|
|
1411
|
+
* @summary Get browser instance details
|
|
1412
|
+
* @param {string} browserId Unique browser identifier
|
|
1413
|
+
* @param {*} [options] Override http request option.
|
|
1414
|
+
* @throws {RequiredError}
|
|
1415
|
+
*/
|
|
1416
|
+
getBrowser(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowserInfoResponse>>;
|
|
1417
|
+
/**
|
|
1418
|
+
*
|
|
1419
|
+
* @summary Get browser status
|
|
1420
|
+
* @param {string} browserId Unique browser identifier
|
|
1421
|
+
* @param {*} [options] Override http request option.
|
|
1422
|
+
* @throws {RequiredError}
|
|
1423
|
+
*/
|
|
1424
|
+
getBrowserStatus(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowserInfoResponse>>;
|
|
1425
|
+
/**
|
|
1426
|
+
*
|
|
1427
|
+
* @summary Get page HTML content
|
|
1428
|
+
* @param {string} browserId Unique browser identifier
|
|
1429
|
+
* @param {*} [options] Override http request option.
|
|
1430
|
+
* @throws {RequiredError}
|
|
1431
|
+
*/
|
|
1432
|
+
getContent(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentResponse>>;
|
|
1433
|
+
/**
|
|
1434
|
+
*
|
|
1435
|
+
* @summary Get element text, attribute, or property
|
|
1436
|
+
* @param {string} browserId Unique browser identifier
|
|
1437
|
+
* @param {ElementDataRequest} payload
|
|
1438
|
+
* @param {*} [options] Override http request option.
|
|
1439
|
+
* @throws {RequiredError}
|
|
1440
|
+
*/
|
|
1441
|
+
getElementData(browserId: string, payload: ElementDataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AttributeResponse>>;
|
|
1442
|
+
/**
|
|
1443
|
+
*
|
|
1444
|
+
* @summary Get browser pool status
|
|
1445
|
+
* @param {*} [options] Override http request option.
|
|
1446
|
+
* @throws {RequiredError}
|
|
1447
|
+
*/
|
|
1448
|
+
getPoolStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolStatusResponse>>;
|
|
1449
|
+
/**
|
|
1450
|
+
*
|
|
1451
|
+
* @summary Get current page URL
|
|
1452
|
+
* @param {string} browserId Unique browser identifier
|
|
1453
|
+
* @param {*} [options] Override http request option.
|
|
1454
|
+
* @throws {RequiredError}
|
|
1455
|
+
*/
|
|
1456
|
+
getUrl(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UrlResponse>>;
|
|
1457
|
+
/**
|
|
1458
|
+
*
|
|
1459
|
+
* @summary Click using selector or screen coordinates
|
|
1460
|
+
* @param {string} browserId Unique browser identifier
|
|
1461
|
+
* @param {CombinedGuiClickRequest} payload
|
|
1462
|
+
* @param {*} [options] Override http request option.
|
|
1463
|
+
* @throws {RequiredError}
|
|
1464
|
+
*/
|
|
1465
|
+
guiClick(browserId: string, payload: CombinedGuiClickRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionResult>>;
|
|
1466
|
+
/**
|
|
1467
|
+
*
|
|
1468
|
+
* @summary Execute history action: back, forward, or refresh
|
|
1469
|
+
* @param {string} browserId Unique browser identifier
|
|
1470
|
+
* @param {HistoryRequest} payload
|
|
1471
|
+
* @param {*} [options] Override http request option.
|
|
1472
|
+
* @throws {RequiredError}
|
|
1473
|
+
*/
|
|
1474
|
+
history(browserId: string, payload: HistoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionResult>>;
|
|
1475
|
+
/**
|
|
1476
|
+
*
|
|
1477
|
+
* @summary List all active browser instances
|
|
1478
|
+
* @param {*} [options] Override http request option.
|
|
1479
|
+
* @throws {RequiredError}
|
|
1480
|
+
*/
|
|
1481
|
+
listBrowsers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrowserList>>;
|
|
1482
|
+
/**
|
|
1483
|
+
*
|
|
1484
|
+
* @summary Mouse action: hover or drag
|
|
1485
|
+
* @param {string} browserId Unique browser identifier
|
|
1486
|
+
* @param {MouseRequest} payload
|
|
1487
|
+
* @param {*} [options] Override http request option.
|
|
1488
|
+
* @throws {RequiredError}
|
|
1489
|
+
*/
|
|
1490
|
+
mouse(browserId: string, payload: MouseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1491
|
+
/**
|
|
1492
|
+
*
|
|
1493
|
+
* @summary Navigate to a URL
|
|
1494
|
+
* @param {string} browserId Unique browser identifier
|
|
1495
|
+
* @param {NavigateRequest} payload
|
|
1496
|
+
* @param {*} [options] Override http request option.
|
|
1497
|
+
* @throws {RequiredError}
|
|
1498
|
+
*/
|
|
1499
|
+
navigateBrowser(browserId: string, payload: NavigateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionResult>>;
|
|
1500
|
+
/**
|
|
1501
|
+
*
|
|
1502
|
+
* @summary Get or clear network logs
|
|
1503
|
+
* @param {string} browserId Unique browser identifier
|
|
1504
|
+
* @param {NetworkLogsRequest} payload
|
|
1505
|
+
* @param {*} [options] Override http request option.
|
|
1506
|
+
* @throws {RequiredError}
|
|
1507
|
+
*/
|
|
1508
|
+
networkLogs(browserId: string, payload: NetworkLogsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogsResponse>>;
|
|
1509
|
+
/**
|
|
1510
|
+
*
|
|
1511
|
+
* @summary Manage performance: start_trace, stop_trace, metrics, or analyze
|
|
1512
|
+
* @param {string} browserId Unique browser identifier
|
|
1513
|
+
* @param {PerformanceRequest} payload
|
|
1514
|
+
* @param {*} [options] Override http request option.
|
|
1515
|
+
* @throws {RequiredError}
|
|
1516
|
+
*/
|
|
1517
|
+
performance(browserId: string, payload: PerformanceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1518
|
+
/**
|
|
1519
|
+
*
|
|
1520
|
+
* @summary Press keys on an element
|
|
1521
|
+
* @param {string} browserId Unique browser identifier
|
|
1522
|
+
* @param {PressKeysRequest} payload
|
|
1523
|
+
* @param {*} [options] Override http request option.
|
|
1524
|
+
* @throws {RequiredError}
|
|
1525
|
+
*/
|
|
1526
|
+
pressKeys(browserId: string, payload: PressKeysRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionResult>>;
|
|
1527
|
+
/**
|
|
1528
|
+
*
|
|
1529
|
+
* @summary Resize viewport
|
|
1530
|
+
* @param {string} browserId Unique browser identifier
|
|
1531
|
+
* @param {ResizeRequest} payload
|
|
1532
|
+
* @param {*} [options] Override http request option.
|
|
1533
|
+
* @throws {RequiredError}
|
|
1534
|
+
*/
|
|
1535
|
+
resize(browserId: string, payload: ResizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1536
|
+
/**
|
|
1537
|
+
*
|
|
1538
|
+
* @summary Scroll to element/coordinates (absolute) or by delta (relative)
|
|
1539
|
+
* @param {string} browserId Unique browser identifier
|
|
1540
|
+
* @param {CombinedScrollRequest} payload
|
|
1541
|
+
* @param {*} [options] Override http request option.
|
|
1542
|
+
* @throws {RequiredError}
|
|
1543
|
+
*/
|
|
1544
|
+
scroll(browserId: string, payload: CombinedScrollRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1545
|
+
/**
|
|
1546
|
+
*
|
|
1547
|
+
* @summary Select dropdown: select option or get options
|
|
1548
|
+
* @param {string} browserId Unique browser identifier
|
|
1549
|
+
* @param {SelectRequest} payload
|
|
1550
|
+
* @param {*} [options] Override http request option.
|
|
1551
|
+
* @throws {RequiredError}
|
|
1552
|
+
*/
|
|
1553
|
+
select(browserId: string, payload: SelectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1554
|
+
/**
|
|
1555
|
+
*
|
|
1556
|
+
* @summary Manage browser tabs: list, new, switch, close, or current
|
|
1557
|
+
* @param {string} browserId Unique browser identifier
|
|
1558
|
+
* @param {TabsRequest} payload
|
|
1559
|
+
* @param {*} [options] Override http request option.
|
|
1560
|
+
* @throws {RequiredError}
|
|
1561
|
+
*/
|
|
1562
|
+
tabs(browserId: string, payload: TabsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1563
|
+
/**
|
|
1564
|
+
*
|
|
1565
|
+
* @summary Take a screenshot
|
|
1566
|
+
* @param {string} browserId Unique browser identifier
|
|
1567
|
+
* @param {*} [options] Override http request option.
|
|
1568
|
+
* @throws {RequiredError}
|
|
1569
|
+
*/
|
|
1570
|
+
takeScreenshot(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScreenshotResponse>>;
|
|
1571
|
+
/**
|
|
1572
|
+
*
|
|
1573
|
+
* @summary Take DOM/accessibility snapshot
|
|
1574
|
+
* @param {string} browserId Unique browser identifier
|
|
1575
|
+
* @param {SnapshotRequest} payload
|
|
1576
|
+
* @param {*} [options] Override http request option.
|
|
1577
|
+
* @throws {RequiredError}
|
|
1578
|
+
*/
|
|
1579
|
+
takeSnapshot(browserId: string, payload: SnapshotRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1580
|
+
/**
|
|
1581
|
+
*
|
|
1582
|
+
* @summary Type text into an element
|
|
1583
|
+
* @param {string} browserId Unique browser identifier
|
|
1584
|
+
* @param {TypeRequest} payload
|
|
1585
|
+
* @param {*} [options] Override http request option.
|
|
1586
|
+
* @throws {RequiredError}
|
|
1587
|
+
*/
|
|
1588
|
+
typeText(browserId: string, payload: TypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionResult>>;
|
|
1589
|
+
/**
|
|
1590
|
+
*
|
|
1591
|
+
* @summary Upload a file
|
|
1592
|
+
* @param {string} browserId Unique browser identifier
|
|
1593
|
+
* @param {UploadFileRequest} payload
|
|
1594
|
+
* @param {*} [options] Override http request option.
|
|
1595
|
+
* @throws {RequiredError}
|
|
1596
|
+
*/
|
|
1597
|
+
uploadFile(browserId: string, payload: UploadFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
|
|
1598
|
+
/**
|
|
1599
|
+
*
|
|
1600
|
+
* @summary Wait for element to become visible or hidden
|
|
1601
|
+
* @param {string} browserId Unique browser identifier
|
|
1602
|
+
* @param {WaitElementRequest} payload
|
|
1603
|
+
* @param {*} [options] Override http request option.
|
|
1604
|
+
* @throws {RequiredError}
|
|
1605
|
+
*/
|
|
1606
|
+
waitElement(browserId: string, payload: WaitElementRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionResult>>;
|
|
1607
|
+
/**
|
|
1608
|
+
*
|
|
1609
|
+
* @summary Analyze visible page content using AI
|
|
1610
|
+
* @param {string} browserId Unique browser identifier
|
|
1611
|
+
* @param {*} [options] Override http request option.
|
|
1612
|
+
* @throws {RequiredError}
|
|
1613
|
+
*/
|
|
1614
|
+
whatIsVisible(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WhatIsVisibleResult>>;
|
|
1615
|
+
};
|
|
1616
|
+
/**
|
|
1617
|
+
* BrowserApi - factory interface
|
|
1618
|
+
*/
|
|
1619
|
+
export declare const BrowserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1620
|
+
/**
|
|
1621
|
+
*
|
|
1622
|
+
* @summary Check if element exists or is visible
|
|
1623
|
+
* @param {string} browserId Unique browser identifier
|
|
1624
|
+
* @param {CheckElementRequest} payload
|
|
1625
|
+
* @param {*} [options] Override http request option.
|
|
1626
|
+
* @throws {RequiredError}
|
|
1627
|
+
*/
|
|
1628
|
+
checkElement(browserId: string, payload: CheckElementRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1629
|
+
/**
|
|
1630
|
+
* Use if_visible=true to only click if visible.
|
|
1631
|
+
* @summary Click element
|
|
1632
|
+
* @param {string} browserId Unique browser identifier
|
|
1633
|
+
* @param {ClickRequest} payload
|
|
1634
|
+
* @param {*} [options] Override http request option.
|
|
1635
|
+
* @throws {RequiredError}
|
|
1636
|
+
*/
|
|
1637
|
+
click(browserId: string, payload: ClickRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActionResult>;
|
|
1638
|
+
/**
|
|
1639
|
+
*
|
|
1640
|
+
* @summary Close all active browser instances
|
|
1641
|
+
* @param {*} [options] Override http request option.
|
|
1642
|
+
* @throws {RequiredError}
|
|
1643
|
+
*/
|
|
1644
|
+
closeAllBrowsers(options?: RawAxiosRequestConfig): AxiosPromise<BaseResponse>;
|
|
1645
|
+
/**
|
|
1646
|
+
*
|
|
1647
|
+
* @summary Close a browser instance
|
|
1648
|
+
* @param {string} browserId Unique browser identifier
|
|
1649
|
+
* @param {*} [options] Override http request option.
|
|
1650
|
+
* @throws {RequiredError}
|
|
1651
|
+
*/
|
|
1652
|
+
closeBrowser(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<BaseResponse>;
|
|
1653
|
+
/**
|
|
1654
|
+
*
|
|
1655
|
+
* @summary Get or clear console logs
|
|
1656
|
+
* @param {string} browserId Unique browser identifier
|
|
1657
|
+
* @param {ConsoleLogsRequest} payload
|
|
1658
|
+
* @param {*} [options] Override http request option.
|
|
1659
|
+
* @throws {RequiredError}
|
|
1660
|
+
*/
|
|
1661
|
+
consoleLogs(browserId: string, payload: ConsoleLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<LogsResponse>;
|
|
1662
|
+
/**
|
|
1663
|
+
*
|
|
1664
|
+
* @summary Create a new browser instance
|
|
1665
|
+
* @param {BrowserConfig} payload
|
|
1666
|
+
* @param {*} [options] Override http request option.
|
|
1667
|
+
* @throws {RequiredError}
|
|
1668
|
+
*/
|
|
1669
|
+
createBrowser(payload: BrowserConfig, options?: RawAxiosRequestConfig): AxiosPromise<BrowserCreated>;
|
|
1670
|
+
/**
|
|
1671
|
+
*
|
|
1672
|
+
* @summary Close and remove a browser instance
|
|
1673
|
+
* @param {string} browserId Unique browser identifier
|
|
1674
|
+
* @param {*} [options] Override http request option.
|
|
1675
|
+
* @throws {RequiredError}
|
|
1676
|
+
*/
|
|
1677
|
+
deleteBrowser(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<BaseResponse>;
|
|
1678
|
+
/**
|
|
1679
|
+
*
|
|
1680
|
+
* @summary Detect element coordinates using AI vision
|
|
1681
|
+
* @param {string} browserId Unique browser identifier
|
|
1682
|
+
* @param {DetectCoordinatesRequest} payload
|
|
1683
|
+
* @param {*} [options] Override http request option.
|
|
1684
|
+
* @throws {RequiredError}
|
|
1685
|
+
*/
|
|
1686
|
+
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetectCoordinatesResult>;
|
|
1687
|
+
/**
|
|
1688
|
+
*
|
|
1689
|
+
* @summary Manage browser dialogs: get, accept, or dismiss
|
|
1690
|
+
* @param {string} browserId Unique browser identifier
|
|
1691
|
+
* @param {CombinedDialogRequest} payload
|
|
1692
|
+
* @param {*} [options] Override http request option.
|
|
1693
|
+
* @throws {RequiredError}
|
|
1694
|
+
*/
|
|
1695
|
+
dialog(browserId: string, payload: CombinedDialogRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1696
|
+
/**
|
|
1697
|
+
*
|
|
1698
|
+
* @summary Manage device emulation: set, clear, or list_devices
|
|
1699
|
+
* @param {string} browserId Unique browser identifier
|
|
1700
|
+
* @param {CombinedEmulateRequest} payload
|
|
1701
|
+
* @param {*} [options] Override http request option.
|
|
1702
|
+
* @throws {RequiredError}
|
|
1703
|
+
*/
|
|
1704
|
+
emulate(browserId: string, payload: CombinedEmulateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1705
|
+
/**
|
|
1706
|
+
*
|
|
1707
|
+
* @summary Execute JavaScript
|
|
1708
|
+
* @param {string} browserId Unique browser identifier
|
|
1709
|
+
* @param {ExecuteRequest} payload
|
|
1710
|
+
* @param {*} [options] Override http request option.
|
|
1711
|
+
* @throws {RequiredError}
|
|
1712
|
+
*/
|
|
1713
|
+
executeScript(browserId: string, payload: ExecuteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteResponse>;
|
|
1714
|
+
/**
|
|
1715
|
+
*
|
|
1716
|
+
* @summary Fill multiple form fields
|
|
1717
|
+
* @param {string} browserId Unique browser identifier
|
|
1718
|
+
* @param {FillFormRequest} payload
|
|
1719
|
+
* @param {*} [options] Override http request option.
|
|
1720
|
+
* @throws {RequiredError}
|
|
1721
|
+
*/
|
|
1722
|
+
fillForm(browserId: string, payload: FillFormRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1723
|
+
/**
|
|
1724
|
+
*
|
|
1725
|
+
* @summary Get browser instance details
|
|
1726
|
+
* @param {string} browserId Unique browser identifier
|
|
1727
|
+
* @param {*} [options] Override http request option.
|
|
1728
|
+
* @throws {RequiredError}
|
|
1729
|
+
*/
|
|
1730
|
+
getBrowser(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<BrowserInfoResponse>;
|
|
1731
|
+
/**
|
|
1732
|
+
*
|
|
1733
|
+
* @summary Get browser status
|
|
1734
|
+
* @param {string} browserId Unique browser identifier
|
|
1735
|
+
* @param {*} [options] Override http request option.
|
|
1736
|
+
* @throws {RequiredError}
|
|
1737
|
+
*/
|
|
1738
|
+
getBrowserStatus(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<BrowserInfoResponse>;
|
|
1739
|
+
/**
|
|
1740
|
+
*
|
|
1741
|
+
* @summary Get page HTML content
|
|
1742
|
+
* @param {string} browserId Unique browser identifier
|
|
1743
|
+
* @param {*} [options] Override http request option.
|
|
1744
|
+
* @throws {RequiredError}
|
|
1745
|
+
*/
|
|
1746
|
+
getContent(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<ContentResponse>;
|
|
1747
|
+
/**
|
|
1748
|
+
*
|
|
1749
|
+
* @summary Get element text, attribute, or property
|
|
1750
|
+
* @param {string} browserId Unique browser identifier
|
|
1751
|
+
* @param {ElementDataRequest} payload
|
|
1752
|
+
* @param {*} [options] Override http request option.
|
|
1753
|
+
* @throws {RequiredError}
|
|
1754
|
+
*/
|
|
1755
|
+
getElementData(browserId: string, payload: ElementDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<AttributeResponse>;
|
|
1756
|
+
/**
|
|
1757
|
+
*
|
|
1758
|
+
* @summary Get browser pool status
|
|
1759
|
+
* @param {*} [options] Override http request option.
|
|
1760
|
+
* @throws {RequiredError}
|
|
1761
|
+
*/
|
|
1762
|
+
getPoolStatus(options?: RawAxiosRequestConfig): AxiosPromise<PoolStatusResponse>;
|
|
1763
|
+
/**
|
|
1764
|
+
*
|
|
1765
|
+
* @summary Get current page URL
|
|
1766
|
+
* @param {string} browserId Unique browser identifier
|
|
1767
|
+
* @param {*} [options] Override http request option.
|
|
1768
|
+
* @throws {RequiredError}
|
|
1769
|
+
*/
|
|
1770
|
+
getUrl(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<UrlResponse>;
|
|
1771
|
+
/**
|
|
1772
|
+
*
|
|
1773
|
+
* @summary Click using selector or screen coordinates
|
|
1774
|
+
* @param {string} browserId Unique browser identifier
|
|
1775
|
+
* @param {CombinedGuiClickRequest} payload
|
|
1776
|
+
* @param {*} [options] Override http request option.
|
|
1777
|
+
* @throws {RequiredError}
|
|
1778
|
+
*/
|
|
1779
|
+
guiClick(browserId: string, payload: CombinedGuiClickRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActionResult>;
|
|
1780
|
+
/**
|
|
1781
|
+
*
|
|
1782
|
+
* @summary Execute history action: back, forward, or refresh
|
|
1783
|
+
* @param {string} browserId Unique browser identifier
|
|
1784
|
+
* @param {HistoryRequest} payload
|
|
1785
|
+
* @param {*} [options] Override http request option.
|
|
1786
|
+
* @throws {RequiredError}
|
|
1787
|
+
*/
|
|
1788
|
+
history(browserId: string, payload: HistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActionResult>;
|
|
1789
|
+
/**
|
|
1790
|
+
*
|
|
1791
|
+
* @summary List all active browser instances
|
|
1792
|
+
* @param {*} [options] Override http request option.
|
|
1793
|
+
* @throws {RequiredError}
|
|
1794
|
+
*/
|
|
1795
|
+
listBrowsers(options?: RawAxiosRequestConfig): AxiosPromise<BrowserList>;
|
|
1796
|
+
/**
|
|
1797
|
+
*
|
|
1798
|
+
* @summary Mouse action: hover or drag
|
|
1799
|
+
* @param {string} browserId Unique browser identifier
|
|
1800
|
+
* @param {MouseRequest} payload
|
|
1801
|
+
* @param {*} [options] Override http request option.
|
|
1802
|
+
* @throws {RequiredError}
|
|
1803
|
+
*/
|
|
1804
|
+
mouse(browserId: string, payload: MouseRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1805
|
+
/**
|
|
1806
|
+
*
|
|
1807
|
+
* @summary Navigate to a URL
|
|
1808
|
+
* @param {string} browserId Unique browser identifier
|
|
1809
|
+
* @param {NavigateRequest} payload
|
|
1810
|
+
* @param {*} [options] Override http request option.
|
|
1811
|
+
* @throws {RequiredError}
|
|
1812
|
+
*/
|
|
1813
|
+
navigateBrowser(browserId: string, payload: NavigateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActionResult>;
|
|
1814
|
+
/**
|
|
1815
|
+
*
|
|
1816
|
+
* @summary Get or clear network logs
|
|
1817
|
+
* @param {string} browserId Unique browser identifier
|
|
1818
|
+
* @param {NetworkLogsRequest} payload
|
|
1819
|
+
* @param {*} [options] Override http request option.
|
|
1820
|
+
* @throws {RequiredError}
|
|
1821
|
+
*/
|
|
1822
|
+
networkLogs(browserId: string, payload: NetworkLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<LogsResponse>;
|
|
1823
|
+
/**
|
|
1824
|
+
*
|
|
1825
|
+
* @summary Manage performance: start_trace, stop_trace, metrics, or analyze
|
|
1826
|
+
* @param {string} browserId Unique browser identifier
|
|
1827
|
+
* @param {PerformanceRequest} payload
|
|
1828
|
+
* @param {*} [options] Override http request option.
|
|
1829
|
+
* @throws {RequiredError}
|
|
1830
|
+
*/
|
|
1831
|
+
performance(browserId: string, payload: PerformanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1832
|
+
/**
|
|
1833
|
+
*
|
|
1834
|
+
* @summary Press keys on an element
|
|
1835
|
+
* @param {string} browserId Unique browser identifier
|
|
1836
|
+
* @param {PressKeysRequest} payload
|
|
1837
|
+
* @param {*} [options] Override http request option.
|
|
1838
|
+
* @throws {RequiredError}
|
|
1839
|
+
*/
|
|
1840
|
+
pressKeys(browserId: string, payload: PressKeysRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActionResult>;
|
|
1841
|
+
/**
|
|
1842
|
+
*
|
|
1843
|
+
* @summary Resize viewport
|
|
1844
|
+
* @param {string} browserId Unique browser identifier
|
|
1845
|
+
* @param {ResizeRequest} payload
|
|
1846
|
+
* @param {*} [options] Override http request option.
|
|
1847
|
+
* @throws {RequiredError}
|
|
1848
|
+
*/
|
|
1849
|
+
resize(browserId: string, payload: ResizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1850
|
+
/**
|
|
1851
|
+
*
|
|
1852
|
+
* @summary Scroll to element/coordinates (absolute) or by delta (relative)
|
|
1853
|
+
* @param {string} browserId Unique browser identifier
|
|
1854
|
+
* @param {CombinedScrollRequest} payload
|
|
1855
|
+
* @param {*} [options] Override http request option.
|
|
1856
|
+
* @throws {RequiredError}
|
|
1857
|
+
*/
|
|
1858
|
+
scroll(browserId: string, payload: CombinedScrollRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1859
|
+
/**
|
|
1860
|
+
*
|
|
1861
|
+
* @summary Select dropdown: select option or get options
|
|
1862
|
+
* @param {string} browserId Unique browser identifier
|
|
1863
|
+
* @param {SelectRequest} payload
|
|
1864
|
+
* @param {*} [options] Override http request option.
|
|
1865
|
+
* @throws {RequiredError}
|
|
1866
|
+
*/
|
|
1867
|
+
select(browserId: string, payload: SelectRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1868
|
+
/**
|
|
1869
|
+
*
|
|
1870
|
+
* @summary Manage browser tabs: list, new, switch, close, or current
|
|
1871
|
+
* @param {string} browserId Unique browser identifier
|
|
1872
|
+
* @param {TabsRequest} payload
|
|
1873
|
+
* @param {*} [options] Override http request option.
|
|
1874
|
+
* @throws {RequiredError}
|
|
1875
|
+
*/
|
|
1876
|
+
tabs(browserId: string, payload: TabsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1877
|
+
/**
|
|
1878
|
+
*
|
|
1879
|
+
* @summary Take a screenshot
|
|
1880
|
+
* @param {string} browserId Unique browser identifier
|
|
1881
|
+
* @param {*} [options] Override http request option.
|
|
1882
|
+
* @throws {RequiredError}
|
|
1883
|
+
*/
|
|
1884
|
+
takeScreenshot(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<ScreenshotResponse>;
|
|
1885
|
+
/**
|
|
1886
|
+
*
|
|
1887
|
+
* @summary Take DOM/accessibility snapshot
|
|
1888
|
+
* @param {string} browserId Unique browser identifier
|
|
1889
|
+
* @param {SnapshotRequest} payload
|
|
1890
|
+
* @param {*} [options] Override http request option.
|
|
1891
|
+
* @throws {RequiredError}
|
|
1892
|
+
*/
|
|
1893
|
+
takeSnapshot(browserId: string, payload: SnapshotRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1894
|
+
/**
|
|
1895
|
+
*
|
|
1896
|
+
* @summary Type text into an element
|
|
1897
|
+
* @param {string} browserId Unique browser identifier
|
|
1898
|
+
* @param {TypeRequest} payload
|
|
1899
|
+
* @param {*} [options] Override http request option.
|
|
1900
|
+
* @throws {RequiredError}
|
|
1901
|
+
*/
|
|
1902
|
+
typeText(browserId: string, payload: TypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActionResult>;
|
|
1903
|
+
/**
|
|
1904
|
+
*
|
|
1905
|
+
* @summary Upload a file
|
|
1906
|
+
* @param {string} browserId Unique browser identifier
|
|
1907
|
+
* @param {UploadFileRequest} payload
|
|
1908
|
+
* @param {*} [options] Override http request option.
|
|
1909
|
+
* @throws {RequiredError}
|
|
1910
|
+
*/
|
|
1911
|
+
uploadFile(browserId: string, payload: UploadFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponse>;
|
|
1912
|
+
/**
|
|
1913
|
+
*
|
|
1914
|
+
* @summary Wait for element to become visible or hidden
|
|
1915
|
+
* @param {string} browserId Unique browser identifier
|
|
1916
|
+
* @param {WaitElementRequest} payload
|
|
1917
|
+
* @param {*} [options] Override http request option.
|
|
1918
|
+
* @throws {RequiredError}
|
|
1919
|
+
*/
|
|
1920
|
+
waitElement(browserId: string, payload: WaitElementRequest, options?: RawAxiosRequestConfig): AxiosPromise<ActionResult>;
|
|
1921
|
+
/**
|
|
1922
|
+
*
|
|
1923
|
+
* @summary Analyze visible page content using AI
|
|
1924
|
+
* @param {string} browserId Unique browser identifier
|
|
1925
|
+
* @param {*} [options] Override http request option.
|
|
1926
|
+
* @throws {RequiredError}
|
|
1927
|
+
*/
|
|
1928
|
+
whatIsVisible(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<WhatIsVisibleResult>;
|
|
1929
|
+
};
|
|
1930
|
+
/**
|
|
1931
|
+
* BrowserApi - object-oriented interface
|
|
1932
|
+
*/
|
|
1933
|
+
export declare class BrowserApi extends BaseAPI {
|
|
1934
|
+
/**
|
|
1935
|
+
*
|
|
1936
|
+
* @summary Check if element exists or is visible
|
|
1937
|
+
* @param {string} browserId Unique browser identifier
|
|
1938
|
+
* @param {CheckElementRequest} payload
|
|
1939
|
+
* @param {*} [options] Override http request option.
|
|
1940
|
+
* @throws {RequiredError}
|
|
1941
|
+
*/
|
|
1942
|
+
checkElement(browserId: string, payload: CheckElementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
1943
|
+
/**
|
|
1944
|
+
* Use if_visible=true to only click if visible.
|
|
1945
|
+
* @summary Click element
|
|
1946
|
+
* @param {string} browserId Unique browser identifier
|
|
1947
|
+
* @param {ClickRequest} payload
|
|
1948
|
+
* @param {*} [options] Override http request option.
|
|
1949
|
+
* @throws {RequiredError}
|
|
1950
|
+
*/
|
|
1951
|
+
click(browserId: string, payload: ClickRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionResult, any, {}>>;
|
|
1952
|
+
/**
|
|
1953
|
+
*
|
|
1954
|
+
* @summary Close all active browser instances
|
|
1955
|
+
* @param {*} [options] Override http request option.
|
|
1956
|
+
* @throws {RequiredError}
|
|
1957
|
+
*/
|
|
1958
|
+
closeAllBrowsers(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseResponse, any, {}>>;
|
|
1959
|
+
/**
|
|
1960
|
+
*
|
|
1961
|
+
* @summary Close a browser instance
|
|
1962
|
+
* @param {string} browserId Unique browser identifier
|
|
1963
|
+
* @param {*} [options] Override http request option.
|
|
1964
|
+
* @throws {RequiredError}
|
|
1965
|
+
*/
|
|
1966
|
+
closeBrowser(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseResponse, any, {}>>;
|
|
1967
|
+
/**
|
|
1968
|
+
*
|
|
1969
|
+
* @summary Get or clear console logs
|
|
1970
|
+
* @param {string} browserId Unique browser identifier
|
|
1971
|
+
* @param {ConsoleLogsRequest} payload
|
|
1972
|
+
* @param {*} [options] Override http request option.
|
|
1973
|
+
* @throws {RequiredError}
|
|
1974
|
+
*/
|
|
1975
|
+
consoleLogs(browserId: string, payload: ConsoleLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LogsResponse, any, {}>>;
|
|
1976
|
+
/**
|
|
1977
|
+
*
|
|
1978
|
+
* @summary Create a new browser instance
|
|
1979
|
+
* @param {BrowserConfig} payload
|
|
1980
|
+
* @param {*} [options] Override http request option.
|
|
1981
|
+
* @throws {RequiredError}
|
|
1982
|
+
*/
|
|
1983
|
+
createBrowser(payload: BrowserConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowserCreated, any, {}>>;
|
|
1984
|
+
/**
|
|
1985
|
+
*
|
|
1986
|
+
* @summary Close and remove a browser instance
|
|
1987
|
+
* @param {string} browserId Unique browser identifier
|
|
1988
|
+
* @param {*} [options] Override http request option.
|
|
1989
|
+
* @throws {RequiredError}
|
|
1990
|
+
*/
|
|
1991
|
+
deleteBrowser(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseResponse, any, {}>>;
|
|
1992
|
+
/**
|
|
1993
|
+
*
|
|
1994
|
+
* @summary Detect element coordinates using AI vision
|
|
1995
|
+
* @param {string} browserId Unique browser identifier
|
|
1996
|
+
* @param {DetectCoordinatesRequest} payload
|
|
1997
|
+
* @param {*} [options] Override http request option.
|
|
1998
|
+
* @throws {RequiredError}
|
|
1999
|
+
*/
|
|
2000
|
+
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetectCoordinatesResult, any, {}>>;
|
|
2001
|
+
/**
|
|
2002
|
+
*
|
|
2003
|
+
* @summary Manage browser dialogs: get, accept, or dismiss
|
|
2004
|
+
* @param {string} browserId Unique browser identifier
|
|
2005
|
+
* @param {CombinedDialogRequest} payload
|
|
2006
|
+
* @param {*} [options] Override http request option.
|
|
2007
|
+
* @throws {RequiredError}
|
|
2008
|
+
*/
|
|
2009
|
+
dialog(browserId: string, payload: CombinedDialogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2010
|
+
/**
|
|
2011
|
+
*
|
|
2012
|
+
* @summary Manage device emulation: set, clear, or list_devices
|
|
2013
|
+
* @param {string} browserId Unique browser identifier
|
|
2014
|
+
* @param {CombinedEmulateRequest} payload
|
|
2015
|
+
* @param {*} [options] Override http request option.
|
|
2016
|
+
* @throws {RequiredError}
|
|
2017
|
+
*/
|
|
2018
|
+
emulate(browserId: string, payload: CombinedEmulateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2019
|
+
/**
|
|
2020
|
+
*
|
|
2021
|
+
* @summary Execute JavaScript
|
|
2022
|
+
* @param {string} browserId Unique browser identifier
|
|
2023
|
+
* @param {ExecuteRequest} payload
|
|
2024
|
+
* @param {*} [options] Override http request option.
|
|
2025
|
+
* @throws {RequiredError}
|
|
2026
|
+
*/
|
|
2027
|
+
executeScript(browserId: string, payload: ExecuteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteResponse, any, {}>>;
|
|
2028
|
+
/**
|
|
2029
|
+
*
|
|
2030
|
+
* @summary Fill multiple form fields
|
|
2031
|
+
* @param {string} browserId Unique browser identifier
|
|
2032
|
+
* @param {FillFormRequest} payload
|
|
2033
|
+
* @param {*} [options] Override http request option.
|
|
2034
|
+
* @throws {RequiredError}
|
|
2035
|
+
*/
|
|
2036
|
+
fillForm(browserId: string, payload: FillFormRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2037
|
+
/**
|
|
2038
|
+
*
|
|
2039
|
+
* @summary Get browser instance details
|
|
2040
|
+
* @param {string} browserId Unique browser identifier
|
|
2041
|
+
* @param {*} [options] Override http request option.
|
|
2042
|
+
* @throws {RequiredError}
|
|
2043
|
+
*/
|
|
2044
|
+
getBrowser(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowserInfoResponse, any, {}>>;
|
|
2045
|
+
/**
|
|
2046
|
+
*
|
|
2047
|
+
* @summary Get browser status
|
|
2048
|
+
* @param {string} browserId Unique browser identifier
|
|
2049
|
+
* @param {*} [options] Override http request option.
|
|
2050
|
+
* @throws {RequiredError}
|
|
2051
|
+
*/
|
|
2052
|
+
getBrowserStatus(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowserInfoResponse, any, {}>>;
|
|
2053
|
+
/**
|
|
2054
|
+
*
|
|
2055
|
+
* @summary Get page HTML content
|
|
2056
|
+
* @param {string} browserId Unique browser identifier
|
|
2057
|
+
* @param {*} [options] Override http request option.
|
|
2058
|
+
* @throws {RequiredError}
|
|
2059
|
+
*/
|
|
2060
|
+
getContent(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ContentResponse, any, {}>>;
|
|
2061
|
+
/**
|
|
2062
|
+
*
|
|
2063
|
+
* @summary Get element text, attribute, or property
|
|
2064
|
+
* @param {string} browserId Unique browser identifier
|
|
2065
|
+
* @param {ElementDataRequest} payload
|
|
2066
|
+
* @param {*} [options] Override http request option.
|
|
2067
|
+
* @throws {RequiredError}
|
|
2068
|
+
*/
|
|
2069
|
+
getElementData(browserId: string, payload: ElementDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AttributeResponse, any, {}>>;
|
|
2070
|
+
/**
|
|
2071
|
+
*
|
|
2072
|
+
* @summary Get browser pool status
|
|
2073
|
+
* @param {*} [options] Override http request option.
|
|
2074
|
+
* @throws {RequiredError}
|
|
2075
|
+
*/
|
|
2076
|
+
getPoolStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PoolStatusResponse, any, {}>>;
|
|
2077
|
+
/**
|
|
2078
|
+
*
|
|
2079
|
+
* @summary Get current page URL
|
|
2080
|
+
* @param {string} browserId Unique browser identifier
|
|
2081
|
+
* @param {*} [options] Override http request option.
|
|
2082
|
+
* @throws {RequiredError}
|
|
2083
|
+
*/
|
|
2084
|
+
getUrl(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UrlResponse, any, {}>>;
|
|
2085
|
+
/**
|
|
2086
|
+
*
|
|
2087
|
+
* @summary Click using selector or screen coordinates
|
|
2088
|
+
* @param {string} browserId Unique browser identifier
|
|
2089
|
+
* @param {CombinedGuiClickRequest} payload
|
|
2090
|
+
* @param {*} [options] Override http request option.
|
|
2091
|
+
* @throws {RequiredError}
|
|
2092
|
+
*/
|
|
2093
|
+
guiClick(browserId: string, payload: CombinedGuiClickRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionResult, any, {}>>;
|
|
2094
|
+
/**
|
|
2095
|
+
*
|
|
2096
|
+
* @summary Execute history action: back, forward, or refresh
|
|
2097
|
+
* @param {string} browserId Unique browser identifier
|
|
2098
|
+
* @param {HistoryRequest} payload
|
|
2099
|
+
* @param {*} [options] Override http request option.
|
|
2100
|
+
* @throws {RequiredError}
|
|
2101
|
+
*/
|
|
2102
|
+
history(browserId: string, payload: HistoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionResult, any, {}>>;
|
|
2103
|
+
/**
|
|
2104
|
+
*
|
|
2105
|
+
* @summary List all active browser instances
|
|
2106
|
+
* @param {*} [options] Override http request option.
|
|
2107
|
+
* @throws {RequiredError}
|
|
2108
|
+
*/
|
|
2109
|
+
listBrowsers(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrowserList, any, {}>>;
|
|
2110
|
+
/**
|
|
2111
|
+
*
|
|
2112
|
+
* @summary Mouse action: hover or drag
|
|
2113
|
+
* @param {string} browserId Unique browser identifier
|
|
2114
|
+
* @param {MouseRequest} payload
|
|
2115
|
+
* @param {*} [options] Override http request option.
|
|
2116
|
+
* @throws {RequiredError}
|
|
2117
|
+
*/
|
|
2118
|
+
mouse(browserId: string, payload: MouseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2119
|
+
/**
|
|
2120
|
+
*
|
|
2121
|
+
* @summary Navigate to a URL
|
|
2122
|
+
* @param {string} browserId Unique browser identifier
|
|
2123
|
+
* @param {NavigateRequest} payload
|
|
2124
|
+
* @param {*} [options] Override http request option.
|
|
2125
|
+
* @throws {RequiredError}
|
|
2126
|
+
*/
|
|
2127
|
+
navigateBrowser(browserId: string, payload: NavigateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionResult, any, {}>>;
|
|
2128
|
+
/**
|
|
2129
|
+
*
|
|
2130
|
+
* @summary Get or clear network logs
|
|
2131
|
+
* @param {string} browserId Unique browser identifier
|
|
2132
|
+
* @param {NetworkLogsRequest} payload
|
|
2133
|
+
* @param {*} [options] Override http request option.
|
|
2134
|
+
* @throws {RequiredError}
|
|
2135
|
+
*/
|
|
2136
|
+
networkLogs(browserId: string, payload: NetworkLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LogsResponse, any, {}>>;
|
|
2137
|
+
/**
|
|
2138
|
+
*
|
|
2139
|
+
* @summary Manage performance: start_trace, stop_trace, metrics, or analyze
|
|
2140
|
+
* @param {string} browserId Unique browser identifier
|
|
2141
|
+
* @param {PerformanceRequest} payload
|
|
2142
|
+
* @param {*} [options] Override http request option.
|
|
2143
|
+
* @throws {RequiredError}
|
|
2144
|
+
*/
|
|
2145
|
+
performance(browserId: string, payload: PerformanceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2146
|
+
/**
|
|
2147
|
+
*
|
|
2148
|
+
* @summary Press keys on an element
|
|
2149
|
+
* @param {string} browserId Unique browser identifier
|
|
2150
|
+
* @param {PressKeysRequest} payload
|
|
2151
|
+
* @param {*} [options] Override http request option.
|
|
2152
|
+
* @throws {RequiredError}
|
|
2153
|
+
*/
|
|
2154
|
+
pressKeys(browserId: string, payload: PressKeysRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionResult, any, {}>>;
|
|
2155
|
+
/**
|
|
2156
|
+
*
|
|
2157
|
+
* @summary Resize viewport
|
|
2158
|
+
* @param {string} browserId Unique browser identifier
|
|
2159
|
+
* @param {ResizeRequest} payload
|
|
2160
|
+
* @param {*} [options] Override http request option.
|
|
2161
|
+
* @throws {RequiredError}
|
|
2162
|
+
*/
|
|
2163
|
+
resize(browserId: string, payload: ResizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2164
|
+
/**
|
|
2165
|
+
*
|
|
2166
|
+
* @summary Scroll to element/coordinates (absolute) or by delta (relative)
|
|
2167
|
+
* @param {string} browserId Unique browser identifier
|
|
2168
|
+
* @param {CombinedScrollRequest} payload
|
|
2169
|
+
* @param {*} [options] Override http request option.
|
|
2170
|
+
* @throws {RequiredError}
|
|
2171
|
+
*/
|
|
2172
|
+
scroll(browserId: string, payload: CombinedScrollRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2173
|
+
/**
|
|
2174
|
+
*
|
|
2175
|
+
* @summary Select dropdown: select option or get options
|
|
2176
|
+
* @param {string} browserId Unique browser identifier
|
|
2177
|
+
* @param {SelectRequest} payload
|
|
2178
|
+
* @param {*} [options] Override http request option.
|
|
2179
|
+
* @throws {RequiredError}
|
|
2180
|
+
*/
|
|
2181
|
+
select(browserId: string, payload: SelectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2182
|
+
/**
|
|
2183
|
+
*
|
|
2184
|
+
* @summary Manage browser tabs: list, new, switch, close, or current
|
|
2185
|
+
* @param {string} browserId Unique browser identifier
|
|
2186
|
+
* @param {TabsRequest} payload
|
|
2187
|
+
* @param {*} [options] Override http request option.
|
|
2188
|
+
* @throws {RequiredError}
|
|
2189
|
+
*/
|
|
2190
|
+
tabs(browserId: string, payload: TabsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2191
|
+
/**
|
|
2192
|
+
*
|
|
2193
|
+
* @summary Take a screenshot
|
|
2194
|
+
* @param {string} browserId Unique browser identifier
|
|
2195
|
+
* @param {*} [options] Override http request option.
|
|
2196
|
+
* @throws {RequiredError}
|
|
2197
|
+
*/
|
|
2198
|
+
takeScreenshot(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ScreenshotResponse, any, {}>>;
|
|
2199
|
+
/**
|
|
2200
|
+
*
|
|
2201
|
+
* @summary Take DOM/accessibility snapshot
|
|
2202
|
+
* @param {string} browserId Unique browser identifier
|
|
2203
|
+
* @param {SnapshotRequest} payload
|
|
2204
|
+
* @param {*} [options] Override http request option.
|
|
2205
|
+
* @throws {RequiredError}
|
|
2206
|
+
*/
|
|
2207
|
+
takeSnapshot(browserId: string, payload: SnapshotRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2208
|
+
/**
|
|
2209
|
+
*
|
|
2210
|
+
* @summary Type text into an element
|
|
2211
|
+
* @param {string} browserId Unique browser identifier
|
|
2212
|
+
* @param {TypeRequest} payload
|
|
2213
|
+
* @param {*} [options] Override http request option.
|
|
2214
|
+
* @throws {RequiredError}
|
|
2215
|
+
*/
|
|
2216
|
+
typeText(browserId: string, payload: TypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionResult, any, {}>>;
|
|
2217
|
+
/**
|
|
2218
|
+
*
|
|
2219
|
+
* @summary Upload a file
|
|
2220
|
+
* @param {string} browserId Unique browser identifier
|
|
2221
|
+
* @param {UploadFileRequest} payload
|
|
2222
|
+
* @param {*} [options] Override http request option.
|
|
2223
|
+
* @throws {RequiredError}
|
|
2224
|
+
*/
|
|
2225
|
+
uploadFile(browserId: string, payload: UploadFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any, {}>>;
|
|
2226
|
+
/**
|
|
2227
|
+
*
|
|
2228
|
+
* @summary Wait for element to become visible or hidden
|
|
2229
|
+
* @param {string} browserId Unique browser identifier
|
|
2230
|
+
* @param {WaitElementRequest} payload
|
|
2231
|
+
* @param {*} [options] Override http request option.
|
|
2232
|
+
* @throws {RequiredError}
|
|
2233
|
+
*/
|
|
2234
|
+
waitElement(browserId: string, payload: WaitElementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionResult, any, {}>>;
|
|
2235
|
+
/**
|
|
2236
|
+
*
|
|
2237
|
+
* @summary Analyze visible page content using AI
|
|
2238
|
+
* @param {string} browserId Unique browser identifier
|
|
2239
|
+
* @param {*} [options] Override http request option.
|
|
2240
|
+
* @throws {RequiredError}
|
|
2241
|
+
*/
|
|
2242
|
+
whatIsVisible(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WhatIsVisibleResult, any, {}>>;
|
|
2243
|
+
}
|
|
2244
|
+
/**
|
|
2245
|
+
* HealthApi - axios parameter creator
|
|
2246
|
+
*/
|
|
2247
|
+
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2248
|
+
/**
|
|
2249
|
+
*
|
|
2250
|
+
* @summary Check the health status of the browser pool
|
|
2251
|
+
* @param {*} [options] Override http request option.
|
|
2252
|
+
* @throws {RequiredError}
|
|
2253
|
+
*/
|
|
2254
|
+
healthCheck: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2255
|
+
/**
|
|
2256
|
+
*
|
|
2257
|
+
* @summary Get Prometheus-style metrics for monitoring
|
|
2258
|
+
* @param {*} [options] Override http request option.
|
|
2259
|
+
* @throws {RequiredError}
|
|
2260
|
+
*/
|
|
2261
|
+
prometheusMetrics: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2262
|
+
};
|
|
2263
|
+
/**
|
|
2264
|
+
* HealthApi - functional programming interface
|
|
2265
|
+
*/
|
|
2266
|
+
export declare const HealthApiFp: (configuration?: Configuration) => {
|
|
2267
|
+
/**
|
|
2268
|
+
*
|
|
2269
|
+
* @summary Check the health status of the browser pool
|
|
2270
|
+
* @param {*} [options] Override http request option.
|
|
2271
|
+
* @throws {RequiredError}
|
|
2272
|
+
*/
|
|
2273
|
+
healthCheck(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthStatus>>;
|
|
2274
|
+
/**
|
|
2275
|
+
*
|
|
2276
|
+
* @summary Get Prometheus-style metrics for monitoring
|
|
2277
|
+
* @param {*} [options] Override http request option.
|
|
2278
|
+
* @throws {RequiredError}
|
|
2279
|
+
*/
|
|
2280
|
+
prometheusMetrics(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2281
|
+
};
|
|
2282
|
+
/**
|
|
2283
|
+
* HealthApi - factory interface
|
|
2284
|
+
*/
|
|
2285
|
+
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2286
|
+
/**
|
|
2287
|
+
*
|
|
2288
|
+
* @summary Check the health status of the browser pool
|
|
2289
|
+
* @param {*} [options] Override http request option.
|
|
2290
|
+
* @throws {RequiredError}
|
|
2291
|
+
*/
|
|
2292
|
+
healthCheck(options?: RawAxiosRequestConfig): AxiosPromise<HealthStatus>;
|
|
2293
|
+
/**
|
|
2294
|
+
*
|
|
2295
|
+
* @summary Get Prometheus-style metrics for monitoring
|
|
2296
|
+
* @param {*} [options] Override http request option.
|
|
2297
|
+
* @throws {RequiredError}
|
|
2298
|
+
*/
|
|
2299
|
+
prometheusMetrics(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2300
|
+
};
|
|
2301
|
+
/**
|
|
2302
|
+
* HealthApi - object-oriented interface
|
|
2303
|
+
*/
|
|
2304
|
+
export declare class HealthApi extends BaseAPI {
|
|
2305
|
+
/**
|
|
2306
|
+
*
|
|
2307
|
+
* @summary Check the health status of the browser pool
|
|
2308
|
+
* @param {*} [options] Override http request option.
|
|
2309
|
+
* @throws {RequiredError}
|
|
2310
|
+
*/
|
|
2311
|
+
healthCheck(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthStatus, any, {}>>;
|
|
2312
|
+
/**
|
|
2313
|
+
*
|
|
2314
|
+
* @summary Get Prometheus-style metrics for monitoring
|
|
2315
|
+
* @param {*} [options] Override http request option.
|
|
2316
|
+
* @throws {RequiredError}
|
|
2317
|
+
*/
|
|
2318
|
+
prometheusMetrics(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2319
|
+
}
|
|
2320
|
+
/**
|
|
2321
|
+
* PoolApi - axios parameter creator
|
|
2322
|
+
*/
|
|
2323
|
+
export declare const PoolApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2324
|
+
/**
|
|
2325
|
+
*
|
|
2326
|
+
* @summary Scale the browser pool to a new maximum size
|
|
2327
|
+
* @param {ScalePool} payload
|
|
2328
|
+
* @param {*} [options] Override http request option.
|
|
2329
|
+
* @throws {RequiredError}
|
|
2330
|
+
*/
|
|
2331
|
+
scalePool: (payload: ScalePool, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2332
|
+
/**
|
|
2333
|
+
*
|
|
2334
|
+
* @summary Gracefully shutdown the browser pool server
|
|
2335
|
+
* @param {*} [options] Override http request option.
|
|
2336
|
+
* @throws {RequiredError}
|
|
2337
|
+
*/
|
|
2338
|
+
shutdownServer: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2339
|
+
};
|
|
2340
|
+
/**
|
|
2341
|
+
* PoolApi - functional programming interface
|
|
2342
|
+
*/
|
|
2343
|
+
export declare const PoolApiFp: (configuration?: Configuration) => {
|
|
2344
|
+
/**
|
|
2345
|
+
*
|
|
2346
|
+
* @summary Scale the browser pool to a new maximum size
|
|
2347
|
+
* @param {ScalePool} payload
|
|
2348
|
+
* @param {*} [options] Override http request option.
|
|
2349
|
+
* @throws {RequiredError}
|
|
2350
|
+
*/
|
|
2351
|
+
scalePool(payload: ScalePool, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolScaled>>;
|
|
2352
|
+
/**
|
|
2353
|
+
*
|
|
2354
|
+
* @summary Gracefully shutdown the browser pool server
|
|
2355
|
+
* @param {*} [options] Override http request option.
|
|
2356
|
+
* @throws {RequiredError}
|
|
2357
|
+
*/
|
|
2358
|
+
shutdownServer(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseResponse>>;
|
|
2359
|
+
};
|
|
2360
|
+
/**
|
|
2361
|
+
* PoolApi - factory interface
|
|
2362
|
+
*/
|
|
2363
|
+
export declare const PoolApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2364
|
+
/**
|
|
2365
|
+
*
|
|
2366
|
+
* @summary Scale the browser pool to a new maximum size
|
|
2367
|
+
* @param {ScalePool} payload
|
|
2368
|
+
* @param {*} [options] Override http request option.
|
|
2369
|
+
* @throws {RequiredError}
|
|
2370
|
+
*/
|
|
2371
|
+
scalePool(payload: ScalePool, options?: RawAxiosRequestConfig): AxiosPromise<PoolScaled>;
|
|
2372
|
+
/**
|
|
2373
|
+
*
|
|
2374
|
+
* @summary Gracefully shutdown the browser pool server
|
|
2375
|
+
* @param {*} [options] Override http request option.
|
|
2376
|
+
* @throws {RequiredError}
|
|
2377
|
+
*/
|
|
2378
|
+
shutdownServer(options?: RawAxiosRequestConfig): AxiosPromise<BaseResponse>;
|
|
2379
|
+
};
|
|
2380
|
+
/**
|
|
2381
|
+
* PoolApi - object-oriented interface
|
|
2382
|
+
*/
|
|
2383
|
+
export declare class PoolApi extends BaseAPI {
|
|
2384
|
+
/**
|
|
2385
|
+
*
|
|
2386
|
+
* @summary Scale the browser pool to a new maximum size
|
|
2387
|
+
* @param {ScalePool} payload
|
|
2388
|
+
* @param {*} [options] Override http request option.
|
|
2389
|
+
* @throws {RequiredError}
|
|
2390
|
+
*/
|
|
2391
|
+
scalePool(payload: ScalePool, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PoolScaled, any, {}>>;
|
|
2392
|
+
/**
|
|
2393
|
+
*
|
|
2394
|
+
* @summary Gracefully shutdown the browser pool server
|
|
2395
|
+
* @param {*} [options] Override http request option.
|
|
2396
|
+
* @throws {RequiredError}
|
|
2397
|
+
*/
|
|
2398
|
+
shutdownServer(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseResponse, any, {}>>;
|
|
2399
|
+
}
|
|
2400
|
+
/**
|
|
2401
|
+
* ProfilesApi - axios parameter creator
|
|
2402
|
+
*/
|
|
2403
|
+
export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2404
|
+
/**
|
|
2405
|
+
*
|
|
2406
|
+
* @summary Create a new browser profile
|
|
2407
|
+
* @param {CreateProfileRequest} payload
|
|
2408
|
+
* @param {*} [options] Override http request option.
|
|
2409
|
+
* @throws {RequiredError}
|
|
2410
|
+
*/
|
|
2411
|
+
createProfile: (payload: CreateProfileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2412
|
+
/**
|
|
2413
|
+
*
|
|
2414
|
+
* @summary Delete a browser profile
|
|
2415
|
+
* @param {string} profileName Profile name
|
|
2416
|
+
* @param {*} [options] Override http request option.
|
|
2417
|
+
* @throws {RequiredError}
|
|
2418
|
+
*/
|
|
2419
|
+
deleteProfile: (profileName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2420
|
+
/**
|
|
2421
|
+
*
|
|
2422
|
+
* @summary Get profile information
|
|
2423
|
+
* @param {string} profileName Profile name
|
|
2424
|
+
* @param {*} [options] Override http request option.
|
|
2425
|
+
* @throws {RequiredError}
|
|
2426
|
+
*/
|
|
2427
|
+
getProfile: (profileName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2428
|
+
/**
|
|
2429
|
+
*
|
|
2430
|
+
* @summary List all browser profiles
|
|
2431
|
+
* @param {*} [options] Override http request option.
|
|
2432
|
+
* @throws {RequiredError}
|
|
2433
|
+
*/
|
|
2434
|
+
listProfiles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2435
|
+
};
|
|
2436
|
+
/**
|
|
2437
|
+
* ProfilesApi - functional programming interface
|
|
2438
|
+
*/
|
|
2439
|
+
export declare const ProfilesApiFp: (configuration?: Configuration) => {
|
|
2440
|
+
/**
|
|
2441
|
+
*
|
|
2442
|
+
* @summary Create a new browser profile
|
|
2443
|
+
* @param {CreateProfileRequest} payload
|
|
2444
|
+
* @param {*} [options] Override http request option.
|
|
2445
|
+
* @throws {RequiredError}
|
|
2446
|
+
*/
|
|
2447
|
+
createProfile(payload: CreateProfileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileResponse>>;
|
|
2448
|
+
/**
|
|
2449
|
+
*
|
|
2450
|
+
* @summary Delete a browser profile
|
|
2451
|
+
* @param {string} profileName Profile name
|
|
2452
|
+
* @param {*} [options] Override http request option.
|
|
2453
|
+
* @throws {RequiredError}
|
|
2454
|
+
*/
|
|
2455
|
+
deleteProfile(profileName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2456
|
+
/**
|
|
2457
|
+
*
|
|
2458
|
+
* @summary Get profile information
|
|
2459
|
+
* @param {string} profileName Profile name
|
|
2460
|
+
* @param {*} [options] Override http request option.
|
|
2461
|
+
* @throws {RequiredError}
|
|
2462
|
+
*/
|
|
2463
|
+
getProfile(profileName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileResponse>>;
|
|
2464
|
+
/**
|
|
2465
|
+
*
|
|
2466
|
+
* @summary List all browser profiles
|
|
2467
|
+
* @param {*} [options] Override http request option.
|
|
2468
|
+
* @throws {RequiredError}
|
|
2469
|
+
*/
|
|
2470
|
+
listProfiles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileListResponse>>;
|
|
2471
|
+
};
|
|
2472
|
+
/**
|
|
2473
|
+
* ProfilesApi - factory interface
|
|
2474
|
+
*/
|
|
2475
|
+
export declare const ProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2476
|
+
/**
|
|
2477
|
+
*
|
|
2478
|
+
* @summary Create a new browser profile
|
|
2479
|
+
* @param {CreateProfileRequest} payload
|
|
2480
|
+
* @param {*} [options] Override http request option.
|
|
2481
|
+
* @throws {RequiredError}
|
|
2482
|
+
*/
|
|
2483
|
+
createProfile(payload: CreateProfileRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProfileResponse>;
|
|
2484
|
+
/**
|
|
2485
|
+
*
|
|
2486
|
+
* @summary Delete a browser profile
|
|
2487
|
+
* @param {string} profileName Profile name
|
|
2488
|
+
* @param {*} [options] Override http request option.
|
|
2489
|
+
* @throws {RequiredError}
|
|
2490
|
+
*/
|
|
2491
|
+
deleteProfile(profileName: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2492
|
+
/**
|
|
2493
|
+
*
|
|
2494
|
+
* @summary Get profile information
|
|
2495
|
+
* @param {string} profileName Profile name
|
|
2496
|
+
* @param {*} [options] Override http request option.
|
|
2497
|
+
* @throws {RequiredError}
|
|
2498
|
+
*/
|
|
2499
|
+
getProfile(profileName: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileResponse>;
|
|
2500
|
+
/**
|
|
2501
|
+
*
|
|
2502
|
+
* @summary List all browser profiles
|
|
2503
|
+
* @param {*} [options] Override http request option.
|
|
2504
|
+
* @throws {RequiredError}
|
|
2505
|
+
*/
|
|
2506
|
+
listProfiles(options?: RawAxiosRequestConfig): AxiosPromise<ProfileListResponse>;
|
|
2507
|
+
};
|
|
2508
|
+
/**
|
|
2509
|
+
* ProfilesApi - object-oriented interface
|
|
2510
|
+
*/
|
|
2511
|
+
export declare class ProfilesApi extends BaseAPI {
|
|
2512
|
+
/**
|
|
2513
|
+
*
|
|
2514
|
+
* @summary Create a new browser profile
|
|
2515
|
+
* @param {CreateProfileRequest} payload
|
|
2516
|
+
* @param {*} [options] Override http request option.
|
|
2517
|
+
* @throws {RequiredError}
|
|
2518
|
+
*/
|
|
2519
|
+
createProfile(payload: CreateProfileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileResponse, any, {}>>;
|
|
2520
|
+
/**
|
|
2521
|
+
*
|
|
2522
|
+
* @summary Delete a browser profile
|
|
2523
|
+
* @param {string} profileName Profile name
|
|
2524
|
+
* @param {*} [options] Override http request option.
|
|
2525
|
+
* @throws {RequiredError}
|
|
2526
|
+
*/
|
|
2527
|
+
deleteProfile(profileName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2528
|
+
/**
|
|
2529
|
+
*
|
|
2530
|
+
* @summary Get profile information
|
|
2531
|
+
* @param {string} profileName Profile name
|
|
2532
|
+
* @param {*} [options] Override http request option.
|
|
2533
|
+
* @throws {RequiredError}
|
|
2534
|
+
*/
|
|
2535
|
+
getProfile(profileName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileResponse, any, {}>>;
|
|
2536
|
+
/**
|
|
2537
|
+
*
|
|
2538
|
+
* @summary List all browser profiles
|
|
2539
|
+
* @param {*} [options] Override http request option.
|
|
2540
|
+
* @throws {RequiredError}
|
|
2541
|
+
*/
|
|
2542
|
+
listProfiles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileListResponse, any, {}>>;
|
|
2543
|
+
}
|