airbrowser-client 1.2.4 → 1.3.0
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 +14 -31
- package/README.md +46 -65
- package/api.ts +807 -1256
- package/dist/api.d.ts +666 -1064
- package/dist/api.js +546 -636
- package/dist/esm/api.d.ts +666 -1064
- package/dist/esm/api.js +545 -635
- package/docs/BrowserApi.md +288 -340
- package/docs/{UrlData.md → BrowsersRequest.md} +5 -5
- package/docs/ClickRequest.md +5 -5
- package/docs/ConsoleLogsRequest.md +2 -2
- package/docs/CreateBrowserRequest.md +38 -0
- package/docs/DetectCoordinatesRequest.md +5 -1
- package/docs/{FormField.md → DialogRequest.md} +7 -7
- package/docs/EmulateRequest.md +32 -0
- package/docs/{ExecuteData.md → ExecuteScriptRequest.md} +5 -5
- package/docs/FillFormRequest.md +2 -2
- package/docs/GenericResponse.md +24 -0
- package/docs/GuiClickRequest.md +30 -0
- package/docs/GuiHoverXyRequest.md +24 -0
- package/docs/GuiPressKeysXyRequest.md +26 -0
- package/docs/GuiTypeXyRequest.md +26 -0
- package/docs/HistoryRequest.md +1 -1
- package/docs/MouseRequest.md +5 -5
- package/docs/{NavigateRequest.md → NavigateBrowserRequest.md} +5 -5
- package/docs/NetworkLogsRequest.md +2 -2
- package/docs/PerformanceRequest.md +2 -2
- package/docs/PressKeysRequest.md +4 -4
- package/docs/ResizeRequest.md +2 -2
- package/docs/ScrollRequest.md +32 -0
- package/docs/SelectRequest.md +7 -7
- package/docs/SnapshotRequest.md +2 -2
- package/docs/TabsRequest.md +4 -4
- package/docs/TakeScreenshotRequest.md +20 -0
- package/docs/TypeTextRequest.md +26 -0
- package/docs/UploadFileRequest.md +3 -3
- package/docs/WaitElementRequest.md +5 -5
- package/package.json +1 -1
- package/docs/ActionResult.md +0 -26
- package/docs/AttributeResponse.md +0 -26
- package/docs/BrowserConfig.md +0 -36
- package/docs/BrowserCreated.md +0 -26
- package/docs/BrowserCreationData.md +0 -22
- package/docs/BrowserInfoResponse.md +0 -26
- package/docs/BrowserList.md +0 -26
- package/docs/BrowserListData.md +0 -22
- package/docs/CheckElementRequest.md +0 -24
- package/docs/CombinedDialogRequest.md +0 -22
- package/docs/CombinedEmulateRequest.md +0 -32
- package/docs/CombinedGuiClickRequest.md +0 -30
- package/docs/CombinedScrollRequest.md +0 -32
- package/docs/ContentData.md +0 -24
- package/docs/ContentResponse.md +0 -26
- package/docs/DetectCoordinatesResult.md +0 -44
- package/docs/ElementDataRequest.md +0 -26
- package/docs/ExecuteRequest.md +0 -22
- package/docs/ExecuteResponse.md +0 -26
- package/docs/LogsResponse.md +0 -26
- package/docs/PoolStatusResponse.md +0 -26
- package/docs/ScreenshotData.md +0 -22
- package/docs/ScreenshotResponse.md +0 -26
- package/docs/SuccessResponse.md +0 -26
- package/docs/TypeRequest.md +0 -26
- package/docs/UrlResponse.md +0 -26
- package/docs/WhatIsVisibleResult.md +0 -34
package/docs/BrowserApi.md
CHANGED
|
@@ -4,45 +4,43 @@ All URIs are relative to */api/v1*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**browsers**](#browsers) | **POST** /browser/browsers | Admin: list all, get info, or close all browsers|
|
|
8
|
+
|[**checkElement**](#checkelement) | **GET** /browser/{browser_id}/check_element | Check if element exists or is visible|
|
|
8
9
|
|[**click**](#click) | **POST** /browser/{browser_id}/click | Click element|
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
11
|
-
|[**
|
|
12
|
-
|[**
|
|
13
|
-
|[**
|
|
14
|
-
|[**
|
|
15
|
-
|[**
|
|
16
|
-
|[**emulate**](#emulate) | **POST** /browser/{browser_id}/emulate | Manage device emulation: set, clear, or list_devices|
|
|
17
|
-
|[**executeScript**](#executescript) | **POST** /browser/{browser_id}/execute | Execute JavaScript|
|
|
10
|
+
|[**closeBrowser**](#closebrowser) | **DELETE** /browser/{browser_id}/close_browser | Close browser instance|
|
|
11
|
+
|[**consoleLogs**](#consolelogs) | **POST** /browser/{browser_id}/console_logs | Console logs: get or clear|
|
|
12
|
+
|[**createBrowser**](#createbrowser) | **POST** /browser/create_browser | Create browser instance with optional persistent profile|
|
|
13
|
+
|[**detectCoordinates**](#detectcoordinates) | **POST** /browser/{browser_id}/detect_coordinates | Detect element coordinates using vision|
|
|
14
|
+
|[**dialog**](#dialog) | **POST** /browser/{browser_id}/dialog | Dialogs: get, accept, dismiss|
|
|
15
|
+
|[**emulate**](#emulate) | **POST** /browser/{browser_id}/emulate | Emulation: set, clear, list_devices|
|
|
16
|
+
|[**executeScript**](#executescript) | **POST** /browser/{browser_id}/execute_script | Execute JavaScript|
|
|
18
17
|
|[**fillForm**](#fillform) | **POST** /browser/{browser_id}/fill_form | Fill multiple form fields|
|
|
19
|
-
|[**
|
|
20
|
-
|[**
|
|
21
|
-
|[**
|
|
22
|
-
|[**
|
|
23
|
-
|[**
|
|
24
|
-
|[**
|
|
25
|
-
|[**
|
|
26
|
-
|[**history**](#history) | **POST** /browser/{browser_id}/history |
|
|
27
|
-
|[**
|
|
28
|
-
|[**
|
|
29
|
-
|[**
|
|
30
|
-
|[**
|
|
31
|
-
|[**
|
|
32
|
-
|[**pressKeys**](#presskeys) | **POST** /browser/{browser_id}/press_keys | Press keys on an element|
|
|
18
|
+
|[**getContent**](#getcontent) | **GET** /browser/{browser_id}/get_content | Get page HTML|
|
|
19
|
+
|[**getElementData**](#getelementdata) | **GET** /browser/{browser_id}/get_element_data | Get element text, attribute, or property|
|
|
20
|
+
|[**getUrl**](#geturl) | **GET** /browser/{browser_id}/get_url | Get current URL|
|
|
21
|
+
|[**guiClick**](#guiclick) | **POST** /browser/{browser_id}/gui_click | GUI click by selector or coordinates|
|
|
22
|
+
|[**guiHoverXy**](#guihoverxy) | **POST** /browser/{browser_id}/gui_hover_xy | GUI hover at coordinates|
|
|
23
|
+
|[**guiPressKeysXy**](#guipresskeysxy) | **POST** /browser/{browser_id}/gui_press_keys_xy | Press keys at coordinates (click to focus, then send keys)|
|
|
24
|
+
|[**guiTypeXy**](#guitypexy) | **POST** /browser/{browser_id}/gui_type_xy | GUI type at coordinates - clicks then types text|
|
|
25
|
+
|[**history**](#history) | **POST** /browser/{browser_id}/history | History: back, forward, or refresh|
|
|
26
|
+
|[**mouse**](#mouse) | **POST** /browser/{browser_id}/mouse | Mouse: hover or drag|
|
|
27
|
+
|[**navigateBrowser**](#navigatebrowser) | **POST** /browser/{browser_id}/navigate | Navigate to URL|
|
|
28
|
+
|[**networkLogs**](#networklogs) | **POST** /browser/{browser_id}/network_logs | Network logs: get or clear|
|
|
29
|
+
|[**performance**](#performance) | **POST** /browser/{browser_id}/performance | Performance: start_trace, stop_trace, metrics, analyze|
|
|
30
|
+
|[**pressKeys**](#presskeys) | **POST** /browser/{browser_id}/press_keys | Press keyboard keys|
|
|
33
31
|
|[**resize**](#resize) | **POST** /browser/{browser_id}/resize | Resize viewport|
|
|
34
|
-
|[**scroll**](#scroll) | **POST** /browser/{browser_id}/scroll | Scroll to element/
|
|
32
|
+
|[**scroll**](#scroll) | **POST** /browser/{browser_id}/scroll | Scroll to element/coords or by delta|
|
|
35
33
|
|[**select**](#select) | **POST** /browser/{browser_id}/select | Select dropdown: select option or get options|
|
|
36
|
-
|[**
|
|
37
|
-
|[**
|
|
38
|
-
|[**
|
|
39
|
-
|[**typeText**](#typetext) | **POST** /browser/{browser_id}/type | Type text into
|
|
40
|
-
|[**uploadFile**](#uploadfile) | **POST** /browser/{browser_id}/upload_file | Upload
|
|
41
|
-
|[**waitElement**](#waitelement) | **POST** /browser/{browser_id}/wait_element | Wait for element to
|
|
42
|
-
|[**whatIsVisible**](#whatisvisible) | **
|
|
34
|
+
|[**snapshot**](#snapshot) | **POST** /browser/{browser_id}/snapshot | DOM or accessibility snapshot|
|
|
35
|
+
|[**tabs**](#tabs) | **POST** /browser/{browser_id}/tabs | Tabs: list, new, switch, close, current|
|
|
36
|
+
|[**takeScreenshot**](#takescreenshot) | **POST** /browser/{browser_id}/screenshot | Take screenshot|
|
|
37
|
+
|[**typeText**](#typetext) | **POST** /browser/{browser_id}/type | Type text into element|
|
|
38
|
+
|[**uploadFile**](#uploadfile) | **POST** /browser/{browser_id}/upload_file | Upload file to input|
|
|
39
|
+
|[**waitElement**](#waitelement) | **POST** /browser/{browser_id}/wait_element | Wait for element to be visible or hidden|
|
|
40
|
+
|[**whatIsVisible**](#whatisvisible) | **POST** /browser/{browser_id}/what_is_visible | AI page analysis - what\'s visible|
|
|
43
41
|
|
|
44
|
-
# **
|
|
45
|
-
>
|
|
42
|
+
# **browsers**
|
|
43
|
+
> GenericResponse browsers(payload)
|
|
46
44
|
|
|
47
45
|
|
|
48
46
|
### Example
|
|
@@ -51,17 +49,15 @@ All URIs are relative to */api/v1*
|
|
|
51
49
|
import {
|
|
52
50
|
BrowserApi,
|
|
53
51
|
Configuration,
|
|
54
|
-
|
|
52
|
+
BrowsersRequest
|
|
55
53
|
} from 'airbrowser-client';
|
|
56
54
|
|
|
57
55
|
const configuration = new Configuration();
|
|
58
56
|
const apiInstance = new BrowserApi(configuration);
|
|
59
57
|
|
|
60
|
-
let
|
|
61
|
-
let payload: CheckElementRequest; //
|
|
58
|
+
let payload: BrowsersRequest; //
|
|
62
59
|
|
|
63
|
-
const { status, data } = await apiInstance.
|
|
64
|
-
browserId,
|
|
60
|
+
const { status, data } = await apiInstance.browsers(
|
|
65
61
|
payload
|
|
66
62
|
);
|
|
67
63
|
```
|
|
@@ -70,13 +66,12 @@ const { status, data } = await apiInstance.checkElement(
|
|
|
70
66
|
|
|
71
67
|
|Name | Type | Description | Notes|
|
|
72
68
|
|------------- | ------------- | ------------- | -------------|
|
|
73
|
-
| **payload** | **
|
|
74
|
-
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
69
|
+
| **payload** | **BrowsersRequest**| | |
|
|
75
70
|
|
|
76
71
|
|
|
77
72
|
### Return type
|
|
78
73
|
|
|
79
|
-
**
|
|
74
|
+
**GenericResponse**
|
|
80
75
|
|
|
81
76
|
### Authorization
|
|
82
77
|
|
|
@@ -95,29 +90,31 @@ No authorization required
|
|
|
95
90
|
|
|
96
91
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
97
92
|
|
|
98
|
-
# **
|
|
99
|
-
>
|
|
93
|
+
# **checkElement**
|
|
94
|
+
> GenericResponse checkElement()
|
|
100
95
|
|
|
101
|
-
Use if_visible=true to only click if visible.
|
|
102
96
|
|
|
103
97
|
### Example
|
|
104
98
|
|
|
105
99
|
```typescript
|
|
106
100
|
import {
|
|
107
101
|
BrowserApi,
|
|
108
|
-
Configuration
|
|
109
|
-
ClickRequest
|
|
102
|
+
Configuration
|
|
110
103
|
} from 'airbrowser-client';
|
|
111
104
|
|
|
112
105
|
const configuration = new Configuration();
|
|
113
106
|
const apiInstance = new BrowserApi(configuration);
|
|
114
107
|
|
|
115
|
-
let browserId: string; //
|
|
116
|
-
let
|
|
108
|
+
let browserId: string; // (default to undefined)
|
|
109
|
+
let selector: string; //selector (default to undefined)
|
|
110
|
+
let check: string; //check (default to undefined)
|
|
111
|
+
let by: string; //by (optional) (default to undefined)
|
|
117
112
|
|
|
118
|
-
const { status, data } = await apiInstance.
|
|
113
|
+
const { status, data } = await apiInstance.checkElement(
|
|
119
114
|
browserId,
|
|
120
|
-
|
|
115
|
+
selector,
|
|
116
|
+
check,
|
|
117
|
+
by
|
|
121
118
|
);
|
|
122
119
|
```
|
|
123
120
|
|
|
@@ -125,13 +122,15 @@ const { status, data } = await apiInstance.click(
|
|
|
125
122
|
|
|
126
123
|
|Name | Type | Description | Notes|
|
|
127
124
|
|------------- | ------------- | ------------- | -------------|
|
|
128
|
-
| **
|
|
129
|
-
| **
|
|
125
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
126
|
+
| **selector** | [**string**] | selector | defaults to undefined|
|
|
127
|
+
| **check** | [**string**] | check | defaults to undefined|
|
|
128
|
+
| **by** | [**string**] | by | (optional) defaults to undefined|
|
|
130
129
|
|
|
131
130
|
|
|
132
131
|
### Return type
|
|
133
132
|
|
|
134
|
-
**
|
|
133
|
+
**GenericResponse**
|
|
135
134
|
|
|
136
135
|
### Authorization
|
|
137
136
|
|
|
@@ -139,7 +138,7 @@ No authorization required
|
|
|
139
138
|
|
|
140
139
|
### HTTP request headers
|
|
141
140
|
|
|
142
|
-
- **Content-Type**:
|
|
141
|
+
- **Content-Type**: Not defined
|
|
143
142
|
- **Accept**: application/json
|
|
144
143
|
|
|
145
144
|
|
|
@@ -150,31 +149,43 @@ No authorization required
|
|
|
150
149
|
|
|
151
150
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
152
151
|
|
|
153
|
-
# **
|
|
154
|
-
>
|
|
152
|
+
# **click**
|
|
153
|
+
> GenericResponse click(payload)
|
|
155
154
|
|
|
155
|
+
Use if_visible=True to only click if visible.
|
|
156
156
|
|
|
157
157
|
### Example
|
|
158
158
|
|
|
159
159
|
```typescript
|
|
160
160
|
import {
|
|
161
161
|
BrowserApi,
|
|
162
|
-
Configuration
|
|
162
|
+
Configuration,
|
|
163
|
+
ClickRequest
|
|
163
164
|
} from 'airbrowser-client';
|
|
164
165
|
|
|
165
166
|
const configuration = new Configuration();
|
|
166
167
|
const apiInstance = new BrowserApi(configuration);
|
|
167
168
|
|
|
168
|
-
|
|
169
|
+
let browserId: string; // (default to undefined)
|
|
170
|
+
let payload: ClickRequest; //
|
|
171
|
+
|
|
172
|
+
const { status, data } = await apiInstance.click(
|
|
173
|
+
browserId,
|
|
174
|
+
payload
|
|
175
|
+
);
|
|
169
176
|
```
|
|
170
177
|
|
|
171
178
|
### Parameters
|
|
172
|
-
|
|
179
|
+
|
|
180
|
+
|Name | Type | Description | Notes|
|
|
181
|
+
|------------- | ------------- | ------------- | -------------|
|
|
182
|
+
| **payload** | **ClickRequest**| | |
|
|
183
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
173
184
|
|
|
174
185
|
|
|
175
186
|
### Return type
|
|
176
187
|
|
|
177
|
-
**
|
|
188
|
+
**GenericResponse**
|
|
178
189
|
|
|
179
190
|
### Authorization
|
|
180
191
|
|
|
@@ -182,7 +193,7 @@ No authorization required
|
|
|
182
193
|
|
|
183
194
|
### HTTP request headers
|
|
184
195
|
|
|
185
|
-
- **Content-Type**:
|
|
196
|
+
- **Content-Type**: application/json
|
|
186
197
|
- **Accept**: application/json
|
|
187
198
|
|
|
188
199
|
|
|
@@ -194,7 +205,7 @@ No authorization required
|
|
|
194
205
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
195
206
|
|
|
196
207
|
# **closeBrowser**
|
|
197
|
-
>
|
|
208
|
+
> GenericResponse closeBrowser()
|
|
198
209
|
|
|
199
210
|
|
|
200
211
|
### Example
|
|
@@ -208,7 +219,7 @@ import {
|
|
|
208
219
|
const configuration = new Configuration();
|
|
209
220
|
const apiInstance = new BrowserApi(configuration);
|
|
210
221
|
|
|
211
|
-
let browserId: string; //
|
|
222
|
+
let browserId: string; // (default to undefined)
|
|
212
223
|
|
|
213
224
|
const { status, data } = await apiInstance.closeBrowser(
|
|
214
225
|
browserId
|
|
@@ -219,12 +230,12 @@ const { status, data } = await apiInstance.closeBrowser(
|
|
|
219
230
|
|
|
220
231
|
|Name | Type | Description | Notes|
|
|
221
232
|
|------------- | ------------- | ------------- | -------------|
|
|
222
|
-
| **browserId** | [**string**] |
|
|
233
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
223
234
|
|
|
224
235
|
|
|
225
236
|
### Return type
|
|
226
237
|
|
|
227
|
-
**
|
|
238
|
+
**GenericResponse**
|
|
228
239
|
|
|
229
240
|
### Authorization
|
|
230
241
|
|
|
@@ -244,7 +255,7 @@ No authorization required
|
|
|
244
255
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
245
256
|
|
|
246
257
|
# **consoleLogs**
|
|
247
|
-
>
|
|
258
|
+
> GenericResponse consoleLogs(payload)
|
|
248
259
|
|
|
249
260
|
|
|
250
261
|
### Example
|
|
@@ -259,7 +270,7 @@ import {
|
|
|
259
270
|
const configuration = new Configuration();
|
|
260
271
|
const apiInstance = new BrowserApi(configuration);
|
|
261
272
|
|
|
262
|
-
let browserId: string; //
|
|
273
|
+
let browserId: string; // (default to undefined)
|
|
263
274
|
let payload: ConsoleLogsRequest; //
|
|
264
275
|
|
|
265
276
|
const { status, data } = await apiInstance.consoleLogs(
|
|
@@ -273,12 +284,12 @@ const { status, data } = await apiInstance.consoleLogs(
|
|
|
273
284
|
|Name | Type | Description | Notes|
|
|
274
285
|
|------------- | ------------- | ------------- | -------------|
|
|
275
286
|
| **payload** | **ConsoleLogsRequest**| | |
|
|
276
|
-
| **browserId** | [**string**] |
|
|
287
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
277
288
|
|
|
278
289
|
|
|
279
290
|
### Return type
|
|
280
291
|
|
|
281
|
-
**
|
|
292
|
+
**GenericResponse**
|
|
282
293
|
|
|
283
294
|
### Authorization
|
|
284
295
|
|
|
@@ -298,7 +309,7 @@ No authorization required
|
|
|
298
309
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
299
310
|
|
|
300
311
|
# **createBrowser**
|
|
301
|
-
>
|
|
312
|
+
> GenericResponse createBrowser(payload)
|
|
302
313
|
|
|
303
314
|
|
|
304
315
|
### Example
|
|
@@ -307,13 +318,13 @@ No authorization required
|
|
|
307
318
|
import {
|
|
308
319
|
BrowserApi,
|
|
309
320
|
Configuration,
|
|
310
|
-
|
|
321
|
+
CreateBrowserRequest
|
|
311
322
|
} from 'airbrowser-client';
|
|
312
323
|
|
|
313
324
|
const configuration = new Configuration();
|
|
314
325
|
const apiInstance = new BrowserApi(configuration);
|
|
315
326
|
|
|
316
|
-
let payload:
|
|
327
|
+
let payload: CreateBrowserRequest; //
|
|
317
328
|
|
|
318
329
|
const { status, data } = await apiInstance.createBrowser(
|
|
319
330
|
payload
|
|
@@ -324,12 +335,12 @@ const { status, data } = await apiInstance.createBrowser(
|
|
|
324
335
|
|
|
325
336
|
|Name | Type | Description | Notes|
|
|
326
337
|
|------------- | ------------- | ------------- | -------------|
|
|
327
|
-
| **payload** | **
|
|
338
|
+
| **payload** | **CreateBrowserRequest**| | |
|
|
328
339
|
|
|
329
340
|
|
|
330
341
|
### Return type
|
|
331
342
|
|
|
332
|
-
**
|
|
343
|
+
**GenericResponse**
|
|
333
344
|
|
|
334
345
|
### Authorization
|
|
335
346
|
|
|
@@ -341,57 +352,6 @@ No authorization required
|
|
|
341
352
|
- **Accept**: application/json
|
|
342
353
|
|
|
343
354
|
|
|
344
|
-
### HTTP response details
|
|
345
|
-
| Status code | Description | Response headers |
|
|
346
|
-
|-------------|-------------|------------------|
|
|
347
|
-
|**400** | Bad request | - |
|
|
348
|
-
|**200** | Browser created | - |
|
|
349
|
-
|
|
350
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
351
|
-
|
|
352
|
-
# **deleteBrowser**
|
|
353
|
-
> BaseResponse deleteBrowser()
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
### Example
|
|
357
|
-
|
|
358
|
-
```typescript
|
|
359
|
-
import {
|
|
360
|
-
BrowserApi,
|
|
361
|
-
Configuration
|
|
362
|
-
} from 'airbrowser-client';
|
|
363
|
-
|
|
364
|
-
const configuration = new Configuration();
|
|
365
|
-
const apiInstance = new BrowserApi(configuration);
|
|
366
|
-
|
|
367
|
-
let browserId: string; //Unique browser identifier (default to undefined)
|
|
368
|
-
|
|
369
|
-
const { status, data } = await apiInstance.deleteBrowser(
|
|
370
|
-
browserId
|
|
371
|
-
);
|
|
372
|
-
```
|
|
373
|
-
|
|
374
|
-
### Parameters
|
|
375
|
-
|
|
376
|
-
|Name | Type | Description | Notes|
|
|
377
|
-
|------------- | ------------- | ------------- | -------------|
|
|
378
|
-
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
### Return type
|
|
382
|
-
|
|
383
|
-
**BaseResponse**
|
|
384
|
-
|
|
385
|
-
### Authorization
|
|
386
|
-
|
|
387
|
-
No authorization required
|
|
388
|
-
|
|
389
|
-
### HTTP request headers
|
|
390
|
-
|
|
391
|
-
- **Content-Type**: Not defined
|
|
392
|
-
- **Accept**: application/json
|
|
393
|
-
|
|
394
|
-
|
|
395
355
|
### HTTP response details
|
|
396
356
|
| Status code | Description | Response headers |
|
|
397
357
|
|-------------|-------------|------------------|
|
|
@@ -400,8 +360,9 @@ No authorization required
|
|
|
400
360
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
401
361
|
|
|
402
362
|
# **detectCoordinates**
|
|
403
|
-
>
|
|
363
|
+
> GenericResponse detectCoordinates(payload)
|
|
404
364
|
|
|
365
|
+
Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
|
|
405
366
|
|
|
406
367
|
### Example
|
|
407
368
|
|
|
@@ -415,7 +376,7 @@ import {
|
|
|
415
376
|
const configuration = new Configuration();
|
|
416
377
|
const apiInstance = new BrowserApi(configuration);
|
|
417
378
|
|
|
418
|
-
let browserId: string; //
|
|
379
|
+
let browserId: string; // (default to undefined)
|
|
419
380
|
let payload: DetectCoordinatesRequest; //
|
|
420
381
|
|
|
421
382
|
const { status, data } = await apiInstance.detectCoordinates(
|
|
@@ -429,12 +390,12 @@ const { status, data } = await apiInstance.detectCoordinates(
|
|
|
429
390
|
|Name | Type | Description | Notes|
|
|
430
391
|
|------------- | ------------- | ------------- | -------------|
|
|
431
392
|
| **payload** | **DetectCoordinatesRequest**| | |
|
|
432
|
-
| **browserId** | [**string**] |
|
|
393
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
433
394
|
|
|
434
395
|
|
|
435
396
|
### Return type
|
|
436
397
|
|
|
437
|
-
**
|
|
398
|
+
**GenericResponse**
|
|
438
399
|
|
|
439
400
|
### Authorization
|
|
440
401
|
|
|
@@ -454,7 +415,7 @@ No authorization required
|
|
|
454
415
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
455
416
|
|
|
456
417
|
# **dialog**
|
|
457
|
-
>
|
|
418
|
+
> GenericResponse dialog(payload)
|
|
458
419
|
|
|
459
420
|
|
|
460
421
|
### Example
|
|
@@ -463,14 +424,14 @@ No authorization required
|
|
|
463
424
|
import {
|
|
464
425
|
BrowserApi,
|
|
465
426
|
Configuration,
|
|
466
|
-
|
|
427
|
+
DialogRequest
|
|
467
428
|
} from 'airbrowser-client';
|
|
468
429
|
|
|
469
430
|
const configuration = new Configuration();
|
|
470
431
|
const apiInstance = new BrowserApi(configuration);
|
|
471
432
|
|
|
472
|
-
let browserId: string; //
|
|
473
|
-
let payload:
|
|
433
|
+
let browserId: string; // (default to undefined)
|
|
434
|
+
let payload: DialogRequest; //
|
|
474
435
|
|
|
475
436
|
const { status, data } = await apiInstance.dialog(
|
|
476
437
|
browserId,
|
|
@@ -482,13 +443,13 @@ const { status, data } = await apiInstance.dialog(
|
|
|
482
443
|
|
|
483
444
|
|Name | Type | Description | Notes|
|
|
484
445
|
|------------- | ------------- | ------------- | -------------|
|
|
485
|
-
| **payload** | **
|
|
486
|
-
| **browserId** | [**string**] |
|
|
446
|
+
| **payload** | **DialogRequest**| | |
|
|
447
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
487
448
|
|
|
488
449
|
|
|
489
450
|
### Return type
|
|
490
451
|
|
|
491
|
-
**
|
|
452
|
+
**GenericResponse**
|
|
492
453
|
|
|
493
454
|
### Authorization
|
|
494
455
|
|
|
@@ -508,7 +469,7 @@ No authorization required
|
|
|
508
469
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
509
470
|
|
|
510
471
|
# **emulate**
|
|
511
|
-
>
|
|
472
|
+
> GenericResponse emulate(payload)
|
|
512
473
|
|
|
513
474
|
|
|
514
475
|
### Example
|
|
@@ -517,14 +478,14 @@ No authorization required
|
|
|
517
478
|
import {
|
|
518
479
|
BrowserApi,
|
|
519
480
|
Configuration,
|
|
520
|
-
|
|
481
|
+
EmulateRequest
|
|
521
482
|
} from 'airbrowser-client';
|
|
522
483
|
|
|
523
484
|
const configuration = new Configuration();
|
|
524
485
|
const apiInstance = new BrowserApi(configuration);
|
|
525
486
|
|
|
526
|
-
let browserId: string; //
|
|
527
|
-
let payload:
|
|
487
|
+
let browserId: string; // (default to undefined)
|
|
488
|
+
let payload: EmulateRequest; //
|
|
528
489
|
|
|
529
490
|
const { status, data } = await apiInstance.emulate(
|
|
530
491
|
browserId,
|
|
@@ -536,13 +497,13 @@ const { status, data } = await apiInstance.emulate(
|
|
|
536
497
|
|
|
537
498
|
|Name | Type | Description | Notes|
|
|
538
499
|
|------------- | ------------- | ------------- | -------------|
|
|
539
|
-
| **payload** | **
|
|
540
|
-
| **browserId** | [**string**] |
|
|
500
|
+
| **payload** | **EmulateRequest**| | |
|
|
501
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
541
502
|
|
|
542
503
|
|
|
543
504
|
### Return type
|
|
544
505
|
|
|
545
|
-
**
|
|
506
|
+
**GenericResponse**
|
|
546
507
|
|
|
547
508
|
### Authorization
|
|
548
509
|
|
|
@@ -562,7 +523,7 @@ No authorization required
|
|
|
562
523
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
563
524
|
|
|
564
525
|
# **executeScript**
|
|
565
|
-
>
|
|
526
|
+
> GenericResponse executeScript(payload)
|
|
566
527
|
|
|
567
528
|
|
|
568
529
|
### Example
|
|
@@ -571,14 +532,14 @@ No authorization required
|
|
|
571
532
|
import {
|
|
572
533
|
BrowserApi,
|
|
573
534
|
Configuration,
|
|
574
|
-
|
|
535
|
+
ExecuteScriptRequest
|
|
575
536
|
} from 'airbrowser-client';
|
|
576
537
|
|
|
577
538
|
const configuration = new Configuration();
|
|
578
539
|
const apiInstance = new BrowserApi(configuration);
|
|
579
540
|
|
|
580
|
-
let browserId: string; //
|
|
581
|
-
let payload:
|
|
541
|
+
let browserId: string; // (default to undefined)
|
|
542
|
+
let payload: ExecuteScriptRequest; //
|
|
582
543
|
|
|
583
544
|
const { status, data } = await apiInstance.executeScript(
|
|
584
545
|
browserId,
|
|
@@ -590,13 +551,13 @@ const { status, data } = await apiInstance.executeScript(
|
|
|
590
551
|
|
|
591
552
|
|Name | Type | Description | Notes|
|
|
592
553
|
|------------- | ------------- | ------------- | -------------|
|
|
593
|
-
| **payload** | **
|
|
594
|
-
| **browserId** | [**string**] |
|
|
554
|
+
| **payload** | **ExecuteScriptRequest**| | |
|
|
555
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
595
556
|
|
|
596
557
|
|
|
597
558
|
### Return type
|
|
598
559
|
|
|
599
|
-
**
|
|
560
|
+
**GenericResponse**
|
|
600
561
|
|
|
601
562
|
### Authorization
|
|
602
563
|
|
|
@@ -616,7 +577,7 @@ No authorization required
|
|
|
616
577
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
617
578
|
|
|
618
579
|
# **fillForm**
|
|
619
|
-
>
|
|
580
|
+
> GenericResponse fillForm(payload)
|
|
620
581
|
|
|
621
582
|
|
|
622
583
|
### Example
|
|
@@ -631,7 +592,7 @@ import {
|
|
|
631
592
|
const configuration = new Configuration();
|
|
632
593
|
const apiInstance = new BrowserApi(configuration);
|
|
633
594
|
|
|
634
|
-
let browserId: string; //
|
|
595
|
+
let browserId: string; // (default to undefined)
|
|
635
596
|
let payload: FillFormRequest; //
|
|
636
597
|
|
|
637
598
|
const { status, data } = await apiInstance.fillForm(
|
|
@@ -645,12 +606,12 @@ const { status, data } = await apiInstance.fillForm(
|
|
|
645
606
|
|Name | Type | Description | Notes|
|
|
646
607
|
|------------- | ------------- | ------------- | -------------|
|
|
647
608
|
| **payload** | **FillFormRequest**| | |
|
|
648
|
-
| **browserId** | [**string**] |
|
|
609
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
649
610
|
|
|
650
611
|
|
|
651
612
|
### Return type
|
|
652
613
|
|
|
653
|
-
**
|
|
614
|
+
**GenericResponse**
|
|
654
615
|
|
|
655
616
|
### Authorization
|
|
656
617
|
|
|
@@ -669,8 +630,8 @@ No authorization required
|
|
|
669
630
|
|
|
670
631
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
671
632
|
|
|
672
|
-
# **
|
|
673
|
-
>
|
|
633
|
+
# **getContent**
|
|
634
|
+
> GenericResponse getContent()
|
|
674
635
|
|
|
675
636
|
|
|
676
637
|
### Example
|
|
@@ -684,9 +645,9 @@ import {
|
|
|
684
645
|
const configuration = new Configuration();
|
|
685
646
|
const apiInstance = new BrowserApi(configuration);
|
|
686
647
|
|
|
687
|
-
let browserId: string; //
|
|
648
|
+
let browserId: string; // (default to undefined)
|
|
688
649
|
|
|
689
|
-
const { status, data } = await apiInstance.
|
|
650
|
+
const { status, data } = await apiInstance.getContent(
|
|
690
651
|
browserId
|
|
691
652
|
);
|
|
692
653
|
```
|
|
@@ -695,12 +656,12 @@ const { status, data } = await apiInstance.getBrowser(
|
|
|
695
656
|
|
|
696
657
|
|Name | Type | Description | Notes|
|
|
697
658
|
|------------- | ------------- | ------------- | -------------|
|
|
698
|
-
| **browserId** | [**string**] |
|
|
659
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
699
660
|
|
|
700
661
|
|
|
701
662
|
### Return type
|
|
702
663
|
|
|
703
|
-
**
|
|
664
|
+
**GenericResponse**
|
|
704
665
|
|
|
705
666
|
### Authorization
|
|
706
667
|
|
|
@@ -715,13 +676,12 @@ No authorization required
|
|
|
715
676
|
### HTTP response details
|
|
716
677
|
| Status code | Description | Response headers |
|
|
717
678
|
|-------------|-------------|------------------|
|
|
718
|
-
|**404** | Browser not found | - |
|
|
719
679
|
|**200** | Success | - |
|
|
720
680
|
|
|
721
681
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
722
682
|
|
|
723
|
-
# **
|
|
724
|
-
>
|
|
683
|
+
# **getElementData**
|
|
684
|
+
> GenericResponse getElementData()
|
|
725
685
|
|
|
726
686
|
|
|
727
687
|
### Example
|
|
@@ -735,10 +695,18 @@ import {
|
|
|
735
695
|
const configuration = new Configuration();
|
|
736
696
|
const apiInstance = new BrowserApi(configuration);
|
|
737
697
|
|
|
738
|
-
let browserId: string; //
|
|
698
|
+
let browserId: string; // (default to undefined)
|
|
699
|
+
let selector: string; //selector (default to undefined)
|
|
700
|
+
let dataType: string; //data_type (default to undefined)
|
|
701
|
+
let name: string; //name (optional) (default to undefined)
|
|
702
|
+
let by: string; //by (optional) (default to undefined)
|
|
739
703
|
|
|
740
|
-
const { status, data } = await apiInstance.
|
|
741
|
-
browserId
|
|
704
|
+
const { status, data } = await apiInstance.getElementData(
|
|
705
|
+
browserId,
|
|
706
|
+
selector,
|
|
707
|
+
dataType,
|
|
708
|
+
name,
|
|
709
|
+
by
|
|
742
710
|
);
|
|
743
711
|
```
|
|
744
712
|
|
|
@@ -746,12 +714,16 @@ const { status, data } = await apiInstance.getBrowserStatus(
|
|
|
746
714
|
|
|
747
715
|
|Name | Type | Description | Notes|
|
|
748
716
|
|------------- | ------------- | ------------- | -------------|
|
|
749
|
-
| **browserId** | [**string**] |
|
|
717
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
718
|
+
| **selector** | [**string**] | selector | defaults to undefined|
|
|
719
|
+
| **dataType** | [**string**] | data_type | defaults to undefined|
|
|
720
|
+
| **name** | [**string**] | name | (optional) defaults to undefined|
|
|
721
|
+
| **by** | [**string**] | by | (optional) defaults to undefined|
|
|
750
722
|
|
|
751
723
|
|
|
752
724
|
### Return type
|
|
753
725
|
|
|
754
|
-
**
|
|
726
|
+
**GenericResponse**
|
|
755
727
|
|
|
756
728
|
### Authorization
|
|
757
729
|
|
|
@@ -770,8 +742,8 @@ No authorization required
|
|
|
770
742
|
|
|
771
743
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
772
744
|
|
|
773
|
-
# **
|
|
774
|
-
>
|
|
745
|
+
# **getUrl**
|
|
746
|
+
> GenericResponse getUrl()
|
|
775
747
|
|
|
776
748
|
|
|
777
749
|
### Example
|
|
@@ -785,9 +757,9 @@ import {
|
|
|
785
757
|
const configuration = new Configuration();
|
|
786
758
|
const apiInstance = new BrowserApi(configuration);
|
|
787
759
|
|
|
788
|
-
let browserId: string; //
|
|
760
|
+
let browserId: string; // (default to undefined)
|
|
789
761
|
|
|
790
|
-
const { status, data } = await apiInstance.
|
|
762
|
+
const { status, data } = await apiInstance.getUrl(
|
|
791
763
|
browserId
|
|
792
764
|
);
|
|
793
765
|
```
|
|
@@ -796,12 +768,12 @@ const { status, data } = await apiInstance.getContent(
|
|
|
796
768
|
|
|
797
769
|
|Name | Type | Description | Notes|
|
|
798
770
|
|------------- | ------------- | ------------- | -------------|
|
|
799
|
-
| **browserId** | [**string**] |
|
|
771
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
800
772
|
|
|
801
773
|
|
|
802
774
|
### Return type
|
|
803
775
|
|
|
804
|
-
**
|
|
776
|
+
**GenericResponse**
|
|
805
777
|
|
|
806
778
|
### Authorization
|
|
807
779
|
|
|
@@ -820,8 +792,8 @@ No authorization required
|
|
|
820
792
|
|
|
821
793
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
822
794
|
|
|
823
|
-
# **
|
|
824
|
-
>
|
|
795
|
+
# **guiClick**
|
|
796
|
+
> GenericResponse guiClick(payload)
|
|
825
797
|
|
|
826
798
|
|
|
827
799
|
### Example
|
|
@@ -830,16 +802,16 @@ No authorization required
|
|
|
830
802
|
import {
|
|
831
803
|
BrowserApi,
|
|
832
804
|
Configuration,
|
|
833
|
-
|
|
805
|
+
GuiClickRequest
|
|
834
806
|
} from 'airbrowser-client';
|
|
835
807
|
|
|
836
808
|
const configuration = new Configuration();
|
|
837
809
|
const apiInstance = new BrowserApi(configuration);
|
|
838
810
|
|
|
839
|
-
let browserId: string; //
|
|
840
|
-
let payload:
|
|
811
|
+
let browserId: string; // (default to undefined)
|
|
812
|
+
let payload: GuiClickRequest; //
|
|
841
813
|
|
|
842
|
-
const { status, data } = await apiInstance.
|
|
814
|
+
const { status, data } = await apiInstance.guiClick(
|
|
843
815
|
browserId,
|
|
844
816
|
payload
|
|
845
817
|
);
|
|
@@ -849,13 +821,13 @@ const { status, data } = await apiInstance.getElementData(
|
|
|
849
821
|
|
|
850
822
|
|Name | Type | Description | Notes|
|
|
851
823
|
|------------- | ------------- | ------------- | -------------|
|
|
852
|
-
| **payload** | **
|
|
853
|
-
| **browserId** | [**string**] |
|
|
824
|
+
| **payload** | **GuiClickRequest**| | |
|
|
825
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
854
826
|
|
|
855
827
|
|
|
856
828
|
### Return type
|
|
857
829
|
|
|
858
|
-
**
|
|
830
|
+
**GenericResponse**
|
|
859
831
|
|
|
860
832
|
### Authorization
|
|
861
833
|
|
|
@@ -874,8 +846,8 @@ No authorization required
|
|
|
874
846
|
|
|
875
847
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
876
848
|
|
|
877
|
-
# **
|
|
878
|
-
>
|
|
849
|
+
# **guiHoverXy**
|
|
850
|
+
> GenericResponse guiHoverXy(payload)
|
|
879
851
|
|
|
880
852
|
|
|
881
853
|
### Example
|
|
@@ -883,22 +855,33 @@ No authorization required
|
|
|
883
855
|
```typescript
|
|
884
856
|
import {
|
|
885
857
|
BrowserApi,
|
|
886
|
-
Configuration
|
|
858
|
+
Configuration,
|
|
859
|
+
GuiHoverXyRequest
|
|
887
860
|
} from 'airbrowser-client';
|
|
888
861
|
|
|
889
862
|
const configuration = new Configuration();
|
|
890
863
|
const apiInstance = new BrowserApi(configuration);
|
|
891
864
|
|
|
892
|
-
|
|
865
|
+
let browserId: string; // (default to undefined)
|
|
866
|
+
let payload: GuiHoverXyRequest; //
|
|
867
|
+
|
|
868
|
+
const { status, data } = await apiInstance.guiHoverXy(
|
|
869
|
+
browserId,
|
|
870
|
+
payload
|
|
871
|
+
);
|
|
893
872
|
```
|
|
894
873
|
|
|
895
874
|
### Parameters
|
|
896
|
-
|
|
875
|
+
|
|
876
|
+
|Name | Type | Description | Notes|
|
|
877
|
+
|------------- | ------------- | ------------- | -------------|
|
|
878
|
+
| **payload** | **GuiHoverXyRequest**| | |
|
|
879
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
897
880
|
|
|
898
881
|
|
|
899
882
|
### Return type
|
|
900
883
|
|
|
901
|
-
**
|
|
884
|
+
**GenericResponse**
|
|
902
885
|
|
|
903
886
|
### Authorization
|
|
904
887
|
|
|
@@ -906,7 +889,7 @@ No authorization required
|
|
|
906
889
|
|
|
907
890
|
### HTTP request headers
|
|
908
891
|
|
|
909
|
-
- **Content-Type**:
|
|
892
|
+
- **Content-Type**: application/json
|
|
910
893
|
- **Accept**: application/json
|
|
911
894
|
|
|
912
895
|
|
|
@@ -917,8 +900,8 @@ No authorization required
|
|
|
917
900
|
|
|
918
901
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
919
902
|
|
|
920
|
-
# **
|
|
921
|
-
>
|
|
903
|
+
# **guiPressKeysXy**
|
|
904
|
+
> GenericResponse guiPressKeysXy(payload)
|
|
922
905
|
|
|
923
906
|
|
|
924
907
|
### Example
|
|
@@ -926,16 +909,19 @@ No authorization required
|
|
|
926
909
|
```typescript
|
|
927
910
|
import {
|
|
928
911
|
BrowserApi,
|
|
929
|
-
Configuration
|
|
912
|
+
Configuration,
|
|
913
|
+
GuiPressKeysXyRequest
|
|
930
914
|
} from 'airbrowser-client';
|
|
931
915
|
|
|
932
916
|
const configuration = new Configuration();
|
|
933
917
|
const apiInstance = new BrowserApi(configuration);
|
|
934
918
|
|
|
935
|
-
let browserId: string; //
|
|
919
|
+
let browserId: string; // (default to undefined)
|
|
920
|
+
let payload: GuiPressKeysXyRequest; //
|
|
936
921
|
|
|
937
|
-
const { status, data } = await apiInstance.
|
|
938
|
-
browserId
|
|
922
|
+
const { status, data } = await apiInstance.guiPressKeysXy(
|
|
923
|
+
browserId,
|
|
924
|
+
payload
|
|
939
925
|
);
|
|
940
926
|
```
|
|
941
927
|
|
|
@@ -943,12 +929,13 @@ const { status, data } = await apiInstance.getUrl(
|
|
|
943
929
|
|
|
944
930
|
|Name | Type | Description | Notes|
|
|
945
931
|
|------------- | ------------- | ------------- | -------------|
|
|
946
|
-
| **
|
|
932
|
+
| **payload** | **GuiPressKeysXyRequest**| | |
|
|
933
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
947
934
|
|
|
948
935
|
|
|
949
936
|
### Return type
|
|
950
937
|
|
|
951
|
-
**
|
|
938
|
+
**GenericResponse**
|
|
952
939
|
|
|
953
940
|
### Authorization
|
|
954
941
|
|
|
@@ -956,7 +943,7 @@ No authorization required
|
|
|
956
943
|
|
|
957
944
|
### HTTP request headers
|
|
958
945
|
|
|
959
|
-
- **Content-Type**:
|
|
946
|
+
- **Content-Type**: application/json
|
|
960
947
|
- **Accept**: application/json
|
|
961
948
|
|
|
962
949
|
|
|
@@ -967,8 +954,8 @@ No authorization required
|
|
|
967
954
|
|
|
968
955
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
969
956
|
|
|
970
|
-
# **
|
|
971
|
-
>
|
|
957
|
+
# **guiTypeXy**
|
|
958
|
+
> GenericResponse guiTypeXy(payload)
|
|
972
959
|
|
|
973
960
|
|
|
974
961
|
### Example
|
|
@@ -977,16 +964,16 @@ No authorization required
|
|
|
977
964
|
import {
|
|
978
965
|
BrowserApi,
|
|
979
966
|
Configuration,
|
|
980
|
-
|
|
967
|
+
GuiTypeXyRequest
|
|
981
968
|
} from 'airbrowser-client';
|
|
982
969
|
|
|
983
970
|
const configuration = new Configuration();
|
|
984
971
|
const apiInstance = new BrowserApi(configuration);
|
|
985
972
|
|
|
986
|
-
let browserId: string; //
|
|
987
|
-
let payload:
|
|
973
|
+
let browserId: string; // (default to undefined)
|
|
974
|
+
let payload: GuiTypeXyRequest; //
|
|
988
975
|
|
|
989
|
-
const { status, data } = await apiInstance.
|
|
976
|
+
const { status, data } = await apiInstance.guiTypeXy(
|
|
990
977
|
browserId,
|
|
991
978
|
payload
|
|
992
979
|
);
|
|
@@ -996,13 +983,13 @@ const { status, data } = await apiInstance.guiClick(
|
|
|
996
983
|
|
|
997
984
|
|Name | Type | Description | Notes|
|
|
998
985
|
|------------- | ------------- | ------------- | -------------|
|
|
999
|
-
| **payload** | **
|
|
1000
|
-
| **browserId** | [**string**] |
|
|
986
|
+
| **payload** | **GuiTypeXyRequest**| | |
|
|
987
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1001
988
|
|
|
1002
989
|
|
|
1003
990
|
### Return type
|
|
1004
991
|
|
|
1005
|
-
**
|
|
992
|
+
**GenericResponse**
|
|
1006
993
|
|
|
1007
994
|
### Authorization
|
|
1008
995
|
|
|
@@ -1022,7 +1009,7 @@ No authorization required
|
|
|
1022
1009
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1023
1010
|
|
|
1024
1011
|
# **history**
|
|
1025
|
-
>
|
|
1012
|
+
> GenericResponse history(payload)
|
|
1026
1013
|
|
|
1027
1014
|
|
|
1028
1015
|
### Example
|
|
@@ -1037,7 +1024,7 @@ import {
|
|
|
1037
1024
|
const configuration = new Configuration();
|
|
1038
1025
|
const apiInstance = new BrowserApi(configuration);
|
|
1039
1026
|
|
|
1040
|
-
let browserId: string; //
|
|
1027
|
+
let browserId: string; // (default to undefined)
|
|
1041
1028
|
let payload: HistoryRequest; //
|
|
1042
1029
|
|
|
1043
1030
|
const { status, data } = await apiInstance.history(
|
|
@@ -1051,12 +1038,12 @@ const { status, data } = await apiInstance.history(
|
|
|
1051
1038
|
|Name | Type | Description | Notes|
|
|
1052
1039
|
|------------- | ------------- | ------------- | -------------|
|
|
1053
1040
|
| **payload** | **HistoryRequest**| | |
|
|
1054
|
-
| **browserId** | [**string**] |
|
|
1041
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1055
1042
|
|
|
1056
1043
|
|
|
1057
1044
|
### Return type
|
|
1058
1045
|
|
|
1059
|
-
**
|
|
1046
|
+
**GenericResponse**
|
|
1060
1047
|
|
|
1061
1048
|
### Authorization
|
|
1062
1049
|
|
|
@@ -1068,49 +1055,6 @@ No authorization required
|
|
|
1068
1055
|
- **Accept**: application/json
|
|
1069
1056
|
|
|
1070
1057
|
|
|
1071
|
-
### HTTP response details
|
|
1072
|
-
| Status code | Description | Response headers |
|
|
1073
|
-
|-------------|-------------|------------------|
|
|
1074
|
-
|**200** | Success | - |
|
|
1075
|
-
|
|
1076
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1077
|
-
|
|
1078
|
-
# **listBrowsers**
|
|
1079
|
-
> BrowserList listBrowsers()
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
### Example
|
|
1083
|
-
|
|
1084
|
-
```typescript
|
|
1085
|
-
import {
|
|
1086
|
-
BrowserApi,
|
|
1087
|
-
Configuration
|
|
1088
|
-
} from 'airbrowser-client';
|
|
1089
|
-
|
|
1090
|
-
const configuration = new Configuration();
|
|
1091
|
-
const apiInstance = new BrowserApi(configuration);
|
|
1092
|
-
|
|
1093
|
-
const { status, data } = await apiInstance.listBrowsers();
|
|
1094
|
-
```
|
|
1095
|
-
|
|
1096
|
-
### Parameters
|
|
1097
|
-
This endpoint does not have any parameters.
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
### Return type
|
|
1101
|
-
|
|
1102
|
-
**BrowserList**
|
|
1103
|
-
|
|
1104
|
-
### Authorization
|
|
1105
|
-
|
|
1106
|
-
No authorization required
|
|
1107
|
-
|
|
1108
|
-
### HTTP request headers
|
|
1109
|
-
|
|
1110
|
-
- **Content-Type**: Not defined
|
|
1111
|
-
- **Accept**: application/json
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
1058
|
### HTTP response details
|
|
1115
1059
|
| Status code | Description | Response headers |
|
|
1116
1060
|
|-------------|-------------|------------------|
|
|
@@ -1119,7 +1063,7 @@ No authorization required
|
|
|
1119
1063
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1120
1064
|
|
|
1121
1065
|
# **mouse**
|
|
1122
|
-
>
|
|
1066
|
+
> GenericResponse mouse(payload)
|
|
1123
1067
|
|
|
1124
1068
|
|
|
1125
1069
|
### Example
|
|
@@ -1134,7 +1078,7 @@ import {
|
|
|
1134
1078
|
const configuration = new Configuration();
|
|
1135
1079
|
const apiInstance = new BrowserApi(configuration);
|
|
1136
1080
|
|
|
1137
|
-
let browserId: string; //
|
|
1081
|
+
let browserId: string; // (default to undefined)
|
|
1138
1082
|
let payload: MouseRequest; //
|
|
1139
1083
|
|
|
1140
1084
|
const { status, data } = await apiInstance.mouse(
|
|
@@ -1148,12 +1092,12 @@ const { status, data } = await apiInstance.mouse(
|
|
|
1148
1092
|
|Name | Type | Description | Notes|
|
|
1149
1093
|
|------------- | ------------- | ------------- | -------------|
|
|
1150
1094
|
| **payload** | **MouseRequest**| | |
|
|
1151
|
-
| **browserId** | [**string**] |
|
|
1095
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1152
1096
|
|
|
1153
1097
|
|
|
1154
1098
|
### Return type
|
|
1155
1099
|
|
|
1156
|
-
**
|
|
1100
|
+
**GenericResponse**
|
|
1157
1101
|
|
|
1158
1102
|
### Authorization
|
|
1159
1103
|
|
|
@@ -1173,7 +1117,7 @@ No authorization required
|
|
|
1173
1117
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1174
1118
|
|
|
1175
1119
|
# **navigateBrowser**
|
|
1176
|
-
>
|
|
1120
|
+
> GenericResponse navigateBrowser(payload)
|
|
1177
1121
|
|
|
1178
1122
|
|
|
1179
1123
|
### Example
|
|
@@ -1182,14 +1126,14 @@ No authorization required
|
|
|
1182
1126
|
import {
|
|
1183
1127
|
BrowserApi,
|
|
1184
1128
|
Configuration,
|
|
1185
|
-
|
|
1129
|
+
NavigateBrowserRequest
|
|
1186
1130
|
} from 'airbrowser-client';
|
|
1187
1131
|
|
|
1188
1132
|
const configuration = new Configuration();
|
|
1189
1133
|
const apiInstance = new BrowserApi(configuration);
|
|
1190
1134
|
|
|
1191
|
-
let browserId: string; //
|
|
1192
|
-
let payload:
|
|
1135
|
+
let browserId: string; // (default to undefined)
|
|
1136
|
+
let payload: NavigateBrowserRequest; //
|
|
1193
1137
|
|
|
1194
1138
|
const { status, data } = await apiInstance.navigateBrowser(
|
|
1195
1139
|
browserId,
|
|
@@ -1201,13 +1145,13 @@ const { status, data } = await apiInstance.navigateBrowser(
|
|
|
1201
1145
|
|
|
1202
1146
|
|Name | Type | Description | Notes|
|
|
1203
1147
|
|------------- | ------------- | ------------- | -------------|
|
|
1204
|
-
| **payload** | **
|
|
1205
|
-
| **browserId** | [**string**] |
|
|
1148
|
+
| **payload** | **NavigateBrowserRequest**| | |
|
|
1149
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1206
1150
|
|
|
1207
1151
|
|
|
1208
1152
|
### Return type
|
|
1209
1153
|
|
|
1210
|
-
**
|
|
1154
|
+
**GenericResponse**
|
|
1211
1155
|
|
|
1212
1156
|
### Authorization
|
|
1213
1157
|
|
|
@@ -1227,7 +1171,7 @@ No authorization required
|
|
|
1227
1171
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1228
1172
|
|
|
1229
1173
|
# **networkLogs**
|
|
1230
|
-
>
|
|
1174
|
+
> GenericResponse networkLogs(payload)
|
|
1231
1175
|
|
|
1232
1176
|
|
|
1233
1177
|
### Example
|
|
@@ -1242,7 +1186,7 @@ import {
|
|
|
1242
1186
|
const configuration = new Configuration();
|
|
1243
1187
|
const apiInstance = new BrowserApi(configuration);
|
|
1244
1188
|
|
|
1245
|
-
let browserId: string; //
|
|
1189
|
+
let browserId: string; // (default to undefined)
|
|
1246
1190
|
let payload: NetworkLogsRequest; //
|
|
1247
1191
|
|
|
1248
1192
|
const { status, data } = await apiInstance.networkLogs(
|
|
@@ -1256,12 +1200,12 @@ const { status, data } = await apiInstance.networkLogs(
|
|
|
1256
1200
|
|Name | Type | Description | Notes|
|
|
1257
1201
|
|------------- | ------------- | ------------- | -------------|
|
|
1258
1202
|
| **payload** | **NetworkLogsRequest**| | |
|
|
1259
|
-
| **browserId** | [**string**] |
|
|
1203
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1260
1204
|
|
|
1261
1205
|
|
|
1262
1206
|
### Return type
|
|
1263
1207
|
|
|
1264
|
-
**
|
|
1208
|
+
**GenericResponse**
|
|
1265
1209
|
|
|
1266
1210
|
### Authorization
|
|
1267
1211
|
|
|
@@ -1281,7 +1225,7 @@ No authorization required
|
|
|
1281
1225
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1282
1226
|
|
|
1283
1227
|
# **performance**
|
|
1284
|
-
>
|
|
1228
|
+
> GenericResponse performance(payload)
|
|
1285
1229
|
|
|
1286
1230
|
|
|
1287
1231
|
### Example
|
|
@@ -1296,7 +1240,7 @@ import {
|
|
|
1296
1240
|
const configuration = new Configuration();
|
|
1297
1241
|
const apiInstance = new BrowserApi(configuration);
|
|
1298
1242
|
|
|
1299
|
-
let browserId: string; //
|
|
1243
|
+
let browserId: string; // (default to undefined)
|
|
1300
1244
|
let payload: PerformanceRequest; //
|
|
1301
1245
|
|
|
1302
1246
|
const { status, data } = await apiInstance.performance(
|
|
@@ -1310,12 +1254,12 @@ const { status, data } = await apiInstance.performance(
|
|
|
1310
1254
|
|Name | Type | Description | Notes|
|
|
1311
1255
|
|------------- | ------------- | ------------- | -------------|
|
|
1312
1256
|
| **payload** | **PerformanceRequest**| | |
|
|
1313
|
-
| **browserId** | [**string**] |
|
|
1257
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1314
1258
|
|
|
1315
1259
|
|
|
1316
1260
|
### Return type
|
|
1317
1261
|
|
|
1318
|
-
**
|
|
1262
|
+
**GenericResponse**
|
|
1319
1263
|
|
|
1320
1264
|
### Authorization
|
|
1321
1265
|
|
|
@@ -1335,7 +1279,7 @@ No authorization required
|
|
|
1335
1279
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1336
1280
|
|
|
1337
1281
|
# **pressKeys**
|
|
1338
|
-
>
|
|
1282
|
+
> GenericResponse pressKeys(payload)
|
|
1339
1283
|
|
|
1340
1284
|
|
|
1341
1285
|
### Example
|
|
@@ -1350,7 +1294,7 @@ import {
|
|
|
1350
1294
|
const configuration = new Configuration();
|
|
1351
1295
|
const apiInstance = new BrowserApi(configuration);
|
|
1352
1296
|
|
|
1353
|
-
let browserId: string; //
|
|
1297
|
+
let browserId: string; // (default to undefined)
|
|
1354
1298
|
let payload: PressKeysRequest; //
|
|
1355
1299
|
|
|
1356
1300
|
const { status, data } = await apiInstance.pressKeys(
|
|
@@ -1364,12 +1308,12 @@ const { status, data } = await apiInstance.pressKeys(
|
|
|
1364
1308
|
|Name | Type | Description | Notes|
|
|
1365
1309
|
|------------- | ------------- | ------------- | -------------|
|
|
1366
1310
|
| **payload** | **PressKeysRequest**| | |
|
|
1367
|
-
| **browserId** | [**string**] |
|
|
1311
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1368
1312
|
|
|
1369
1313
|
|
|
1370
1314
|
### Return type
|
|
1371
1315
|
|
|
1372
|
-
**
|
|
1316
|
+
**GenericResponse**
|
|
1373
1317
|
|
|
1374
1318
|
### Authorization
|
|
1375
1319
|
|
|
@@ -1389,7 +1333,7 @@ No authorization required
|
|
|
1389
1333
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1390
1334
|
|
|
1391
1335
|
# **resize**
|
|
1392
|
-
>
|
|
1336
|
+
> GenericResponse resize(payload)
|
|
1393
1337
|
|
|
1394
1338
|
|
|
1395
1339
|
### Example
|
|
@@ -1404,7 +1348,7 @@ import {
|
|
|
1404
1348
|
const configuration = new Configuration();
|
|
1405
1349
|
const apiInstance = new BrowserApi(configuration);
|
|
1406
1350
|
|
|
1407
|
-
let browserId: string; //
|
|
1351
|
+
let browserId: string; // (default to undefined)
|
|
1408
1352
|
let payload: ResizeRequest; //
|
|
1409
1353
|
|
|
1410
1354
|
const { status, data } = await apiInstance.resize(
|
|
@@ -1418,12 +1362,12 @@ const { status, data } = await apiInstance.resize(
|
|
|
1418
1362
|
|Name | Type | Description | Notes|
|
|
1419
1363
|
|------------- | ------------- | ------------- | -------------|
|
|
1420
1364
|
| **payload** | **ResizeRequest**| | |
|
|
1421
|
-
| **browserId** | [**string**] |
|
|
1365
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1422
1366
|
|
|
1423
1367
|
|
|
1424
1368
|
### Return type
|
|
1425
1369
|
|
|
1426
|
-
**
|
|
1370
|
+
**GenericResponse**
|
|
1427
1371
|
|
|
1428
1372
|
### Authorization
|
|
1429
1373
|
|
|
@@ -1443,7 +1387,7 @@ No authorization required
|
|
|
1443
1387
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1444
1388
|
|
|
1445
1389
|
# **scroll**
|
|
1446
|
-
>
|
|
1390
|
+
> GenericResponse scroll(payload)
|
|
1447
1391
|
|
|
1448
1392
|
|
|
1449
1393
|
### Example
|
|
@@ -1452,14 +1396,14 @@ No authorization required
|
|
|
1452
1396
|
import {
|
|
1453
1397
|
BrowserApi,
|
|
1454
1398
|
Configuration,
|
|
1455
|
-
|
|
1399
|
+
ScrollRequest
|
|
1456
1400
|
} from 'airbrowser-client';
|
|
1457
1401
|
|
|
1458
1402
|
const configuration = new Configuration();
|
|
1459
1403
|
const apiInstance = new BrowserApi(configuration);
|
|
1460
1404
|
|
|
1461
|
-
let browserId: string; //
|
|
1462
|
-
let payload:
|
|
1405
|
+
let browserId: string; // (default to undefined)
|
|
1406
|
+
let payload: ScrollRequest; //
|
|
1463
1407
|
|
|
1464
1408
|
const { status, data } = await apiInstance.scroll(
|
|
1465
1409
|
browserId,
|
|
@@ -1471,13 +1415,13 @@ const { status, data } = await apiInstance.scroll(
|
|
|
1471
1415
|
|
|
1472
1416
|
|Name | Type | Description | Notes|
|
|
1473
1417
|
|------------- | ------------- | ------------- | -------------|
|
|
1474
|
-
| **payload** | **
|
|
1475
|
-
| **browserId** | [**string**] |
|
|
1418
|
+
| **payload** | **ScrollRequest**| | |
|
|
1419
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1476
1420
|
|
|
1477
1421
|
|
|
1478
1422
|
### Return type
|
|
1479
1423
|
|
|
1480
|
-
**
|
|
1424
|
+
**GenericResponse**
|
|
1481
1425
|
|
|
1482
1426
|
### Authorization
|
|
1483
1427
|
|
|
@@ -1497,7 +1441,7 @@ No authorization required
|
|
|
1497
1441
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1498
1442
|
|
|
1499
1443
|
# **select**
|
|
1500
|
-
>
|
|
1444
|
+
> GenericResponse select(payload)
|
|
1501
1445
|
|
|
1502
1446
|
|
|
1503
1447
|
### Example
|
|
@@ -1512,7 +1456,7 @@ import {
|
|
|
1512
1456
|
const configuration = new Configuration();
|
|
1513
1457
|
const apiInstance = new BrowserApi(configuration);
|
|
1514
1458
|
|
|
1515
|
-
let browserId: string; //
|
|
1459
|
+
let browserId: string; // (default to undefined)
|
|
1516
1460
|
let payload: SelectRequest; //
|
|
1517
1461
|
|
|
1518
1462
|
const { status, data } = await apiInstance.select(
|
|
@@ -1526,12 +1470,12 @@ const { status, data } = await apiInstance.select(
|
|
|
1526
1470
|
|Name | Type | Description | Notes|
|
|
1527
1471
|
|------------- | ------------- | ------------- | -------------|
|
|
1528
1472
|
| **payload** | **SelectRequest**| | |
|
|
1529
|
-
| **browserId** | [**string**] |
|
|
1473
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1530
1474
|
|
|
1531
1475
|
|
|
1532
1476
|
### Return type
|
|
1533
1477
|
|
|
1534
|
-
**
|
|
1478
|
+
**GenericResponse**
|
|
1535
1479
|
|
|
1536
1480
|
### Authorization
|
|
1537
1481
|
|
|
@@ -1550,8 +1494,8 @@ No authorization required
|
|
|
1550
1494
|
|
|
1551
1495
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1552
1496
|
|
|
1553
|
-
# **
|
|
1554
|
-
>
|
|
1497
|
+
# **snapshot**
|
|
1498
|
+
> GenericResponse snapshot(payload)
|
|
1555
1499
|
|
|
1556
1500
|
|
|
1557
1501
|
### Example
|
|
@@ -1560,16 +1504,16 @@ No authorization required
|
|
|
1560
1504
|
import {
|
|
1561
1505
|
BrowserApi,
|
|
1562
1506
|
Configuration,
|
|
1563
|
-
|
|
1507
|
+
SnapshotRequest
|
|
1564
1508
|
} from 'airbrowser-client';
|
|
1565
1509
|
|
|
1566
1510
|
const configuration = new Configuration();
|
|
1567
1511
|
const apiInstance = new BrowserApi(configuration);
|
|
1568
1512
|
|
|
1569
|
-
let browserId: string; //
|
|
1570
|
-
let payload:
|
|
1513
|
+
let browserId: string; // (default to undefined)
|
|
1514
|
+
let payload: SnapshotRequest; //
|
|
1571
1515
|
|
|
1572
|
-
const { status, data } = await apiInstance.
|
|
1516
|
+
const { status, data } = await apiInstance.snapshot(
|
|
1573
1517
|
browserId,
|
|
1574
1518
|
payload
|
|
1575
1519
|
);
|
|
@@ -1579,13 +1523,13 @@ const { status, data } = await apiInstance.tabs(
|
|
|
1579
1523
|
|
|
1580
1524
|
|Name | Type | Description | Notes|
|
|
1581
1525
|
|------------- | ------------- | ------------- | -------------|
|
|
1582
|
-
| **payload** | **
|
|
1583
|
-
| **browserId** | [**string**] |
|
|
1526
|
+
| **payload** | **SnapshotRequest**| | |
|
|
1527
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1584
1528
|
|
|
1585
1529
|
|
|
1586
1530
|
### Return type
|
|
1587
1531
|
|
|
1588
|
-
**
|
|
1532
|
+
**GenericResponse**
|
|
1589
1533
|
|
|
1590
1534
|
### Authorization
|
|
1591
1535
|
|
|
@@ -1604,8 +1548,8 @@ No authorization required
|
|
|
1604
1548
|
|
|
1605
1549
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1606
1550
|
|
|
1607
|
-
# **
|
|
1608
|
-
>
|
|
1551
|
+
# **tabs**
|
|
1552
|
+
> GenericResponse tabs(payload)
|
|
1609
1553
|
|
|
1610
1554
|
|
|
1611
1555
|
### Example
|
|
@@ -1613,16 +1557,19 @@ No authorization required
|
|
|
1613
1557
|
```typescript
|
|
1614
1558
|
import {
|
|
1615
1559
|
BrowserApi,
|
|
1616
|
-
Configuration
|
|
1560
|
+
Configuration,
|
|
1561
|
+
TabsRequest
|
|
1617
1562
|
} from 'airbrowser-client';
|
|
1618
1563
|
|
|
1619
1564
|
const configuration = new Configuration();
|
|
1620
1565
|
const apiInstance = new BrowserApi(configuration);
|
|
1621
1566
|
|
|
1622
|
-
let browserId: string; //
|
|
1567
|
+
let browserId: string; // (default to undefined)
|
|
1568
|
+
let payload: TabsRequest; //
|
|
1623
1569
|
|
|
1624
|
-
const { status, data } = await apiInstance.
|
|
1625
|
-
browserId
|
|
1570
|
+
const { status, data } = await apiInstance.tabs(
|
|
1571
|
+
browserId,
|
|
1572
|
+
payload
|
|
1626
1573
|
);
|
|
1627
1574
|
```
|
|
1628
1575
|
|
|
@@ -1630,12 +1577,13 @@ const { status, data } = await apiInstance.takeScreenshot(
|
|
|
1630
1577
|
|
|
1631
1578
|
|Name | Type | Description | Notes|
|
|
1632
1579
|
|------------- | ------------- | ------------- | -------------|
|
|
1633
|
-
| **
|
|
1580
|
+
| **payload** | **TabsRequest**| | |
|
|
1581
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1634
1582
|
|
|
1635
1583
|
|
|
1636
1584
|
### Return type
|
|
1637
1585
|
|
|
1638
|
-
**
|
|
1586
|
+
**GenericResponse**
|
|
1639
1587
|
|
|
1640
1588
|
### Authorization
|
|
1641
1589
|
|
|
@@ -1643,7 +1591,7 @@ No authorization required
|
|
|
1643
1591
|
|
|
1644
1592
|
### HTTP request headers
|
|
1645
1593
|
|
|
1646
|
-
- **Content-Type**:
|
|
1594
|
+
- **Content-Type**: application/json
|
|
1647
1595
|
- **Accept**: application/json
|
|
1648
1596
|
|
|
1649
1597
|
|
|
@@ -1654,8 +1602,8 @@ No authorization required
|
|
|
1654
1602
|
|
|
1655
1603
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1656
1604
|
|
|
1657
|
-
# **
|
|
1658
|
-
>
|
|
1605
|
+
# **takeScreenshot**
|
|
1606
|
+
> GenericResponse takeScreenshot(payload)
|
|
1659
1607
|
|
|
1660
1608
|
|
|
1661
1609
|
### Example
|
|
@@ -1664,16 +1612,16 @@ No authorization required
|
|
|
1664
1612
|
import {
|
|
1665
1613
|
BrowserApi,
|
|
1666
1614
|
Configuration,
|
|
1667
|
-
|
|
1615
|
+
TakeScreenshotRequest
|
|
1668
1616
|
} from 'airbrowser-client';
|
|
1669
1617
|
|
|
1670
1618
|
const configuration = new Configuration();
|
|
1671
1619
|
const apiInstance = new BrowserApi(configuration);
|
|
1672
1620
|
|
|
1673
|
-
let browserId: string; //
|
|
1674
|
-
let payload:
|
|
1621
|
+
let browserId: string; // (default to undefined)
|
|
1622
|
+
let payload: TakeScreenshotRequest; //
|
|
1675
1623
|
|
|
1676
|
-
const { status, data } = await apiInstance.
|
|
1624
|
+
const { status, data } = await apiInstance.takeScreenshot(
|
|
1677
1625
|
browserId,
|
|
1678
1626
|
payload
|
|
1679
1627
|
);
|
|
@@ -1683,13 +1631,13 @@ const { status, data } = await apiInstance.takeSnapshot(
|
|
|
1683
1631
|
|
|
1684
1632
|
|Name | Type | Description | Notes|
|
|
1685
1633
|
|------------- | ------------- | ------------- | -------------|
|
|
1686
|
-
| **payload** | **
|
|
1687
|
-
| **browserId** | [**string**] |
|
|
1634
|
+
| **payload** | **TakeScreenshotRequest**| | |
|
|
1635
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1688
1636
|
|
|
1689
1637
|
|
|
1690
1638
|
### Return type
|
|
1691
1639
|
|
|
1692
|
-
**
|
|
1640
|
+
**GenericResponse**
|
|
1693
1641
|
|
|
1694
1642
|
### Authorization
|
|
1695
1643
|
|
|
@@ -1709,7 +1657,7 @@ No authorization required
|
|
|
1709
1657
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1710
1658
|
|
|
1711
1659
|
# **typeText**
|
|
1712
|
-
>
|
|
1660
|
+
> GenericResponse typeText(payload)
|
|
1713
1661
|
|
|
1714
1662
|
|
|
1715
1663
|
### Example
|
|
@@ -1718,14 +1666,14 @@ No authorization required
|
|
|
1718
1666
|
import {
|
|
1719
1667
|
BrowserApi,
|
|
1720
1668
|
Configuration,
|
|
1721
|
-
|
|
1669
|
+
TypeTextRequest
|
|
1722
1670
|
} from 'airbrowser-client';
|
|
1723
1671
|
|
|
1724
1672
|
const configuration = new Configuration();
|
|
1725
1673
|
const apiInstance = new BrowserApi(configuration);
|
|
1726
1674
|
|
|
1727
|
-
let browserId: string; //
|
|
1728
|
-
let payload:
|
|
1675
|
+
let browserId: string; // (default to undefined)
|
|
1676
|
+
let payload: TypeTextRequest; //
|
|
1729
1677
|
|
|
1730
1678
|
const { status, data } = await apiInstance.typeText(
|
|
1731
1679
|
browserId,
|
|
@@ -1737,13 +1685,13 @@ const { status, data } = await apiInstance.typeText(
|
|
|
1737
1685
|
|
|
1738
1686
|
|Name | Type | Description | Notes|
|
|
1739
1687
|
|------------- | ------------- | ------------- | -------------|
|
|
1740
|
-
| **payload** | **
|
|
1741
|
-
| **browserId** | [**string**] |
|
|
1688
|
+
| **payload** | **TypeTextRequest**| | |
|
|
1689
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1742
1690
|
|
|
1743
1691
|
|
|
1744
1692
|
### Return type
|
|
1745
1693
|
|
|
1746
|
-
**
|
|
1694
|
+
**GenericResponse**
|
|
1747
1695
|
|
|
1748
1696
|
### Authorization
|
|
1749
1697
|
|
|
@@ -1763,7 +1711,7 @@ No authorization required
|
|
|
1763
1711
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1764
1712
|
|
|
1765
1713
|
# **uploadFile**
|
|
1766
|
-
>
|
|
1714
|
+
> GenericResponse uploadFile(payload)
|
|
1767
1715
|
|
|
1768
1716
|
|
|
1769
1717
|
### Example
|
|
@@ -1778,7 +1726,7 @@ import {
|
|
|
1778
1726
|
const configuration = new Configuration();
|
|
1779
1727
|
const apiInstance = new BrowserApi(configuration);
|
|
1780
1728
|
|
|
1781
|
-
let browserId: string; //
|
|
1729
|
+
let browserId: string; // (default to undefined)
|
|
1782
1730
|
let payload: UploadFileRequest; //
|
|
1783
1731
|
|
|
1784
1732
|
const { status, data } = await apiInstance.uploadFile(
|
|
@@ -1792,12 +1740,12 @@ const { status, data } = await apiInstance.uploadFile(
|
|
|
1792
1740
|
|Name | Type | Description | Notes|
|
|
1793
1741
|
|------------- | ------------- | ------------- | -------------|
|
|
1794
1742
|
| **payload** | **UploadFileRequest**| | |
|
|
1795
|
-
| **browserId** | [**string**] |
|
|
1743
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1796
1744
|
|
|
1797
1745
|
|
|
1798
1746
|
### Return type
|
|
1799
1747
|
|
|
1800
|
-
**
|
|
1748
|
+
**GenericResponse**
|
|
1801
1749
|
|
|
1802
1750
|
### Authorization
|
|
1803
1751
|
|
|
@@ -1817,7 +1765,7 @@ No authorization required
|
|
|
1817
1765
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1818
1766
|
|
|
1819
1767
|
# **waitElement**
|
|
1820
|
-
>
|
|
1768
|
+
> GenericResponse waitElement(payload)
|
|
1821
1769
|
|
|
1822
1770
|
|
|
1823
1771
|
### Example
|
|
@@ -1832,7 +1780,7 @@ import {
|
|
|
1832
1780
|
const configuration = new Configuration();
|
|
1833
1781
|
const apiInstance = new BrowserApi(configuration);
|
|
1834
1782
|
|
|
1835
|
-
let browserId: string; //
|
|
1783
|
+
let browserId: string; // (default to undefined)
|
|
1836
1784
|
let payload: WaitElementRequest; //
|
|
1837
1785
|
|
|
1838
1786
|
const { status, data } = await apiInstance.waitElement(
|
|
@@ -1846,12 +1794,12 @@ const { status, data } = await apiInstance.waitElement(
|
|
|
1846
1794
|
|Name | Type | Description | Notes|
|
|
1847
1795
|
|------------- | ------------- | ------------- | -------------|
|
|
1848
1796
|
| **payload** | **WaitElementRequest**| | |
|
|
1849
|
-
| **browserId** | [**string**] |
|
|
1797
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1850
1798
|
|
|
1851
1799
|
|
|
1852
1800
|
### Return type
|
|
1853
1801
|
|
|
1854
|
-
**
|
|
1802
|
+
**GenericResponse**
|
|
1855
1803
|
|
|
1856
1804
|
### Authorization
|
|
1857
1805
|
|
|
@@ -1871,7 +1819,7 @@ No authorization required
|
|
|
1871
1819
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1872
1820
|
|
|
1873
1821
|
# **whatIsVisible**
|
|
1874
|
-
>
|
|
1822
|
+
> GenericResponse whatIsVisible()
|
|
1875
1823
|
|
|
1876
1824
|
|
|
1877
1825
|
### Example
|
|
@@ -1885,7 +1833,7 @@ import {
|
|
|
1885
1833
|
const configuration = new Configuration();
|
|
1886
1834
|
const apiInstance = new BrowserApi(configuration);
|
|
1887
1835
|
|
|
1888
|
-
let browserId: string; //
|
|
1836
|
+
let browserId: string; // (default to undefined)
|
|
1889
1837
|
|
|
1890
1838
|
const { status, data } = await apiInstance.whatIsVisible(
|
|
1891
1839
|
browserId
|
|
@@ -1896,12 +1844,12 @@ const { status, data } = await apiInstance.whatIsVisible(
|
|
|
1896
1844
|
|
|
1897
1845
|
|Name | Type | Description | Notes|
|
|
1898
1846
|
|------------- | ------------- | ------------- | -------------|
|
|
1899
|
-
| **browserId** | [**string**] |
|
|
1847
|
+
| **browserId** | [**string**] | | defaults to undefined|
|
|
1900
1848
|
|
|
1901
1849
|
|
|
1902
1850
|
### Return type
|
|
1903
1851
|
|
|
1904
|
-
**
|
|
1852
|
+
**GenericResponse**
|
|
1905
1853
|
|
|
1906
1854
|
### Authorization
|
|
1907
1855
|
|