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,1922 @@
|
|
|
1
|
+
# BrowserApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to */api/v1*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**checkElement**](#checkelement) | **POST** /browser/{browser_id}/check_element | Check if element exists or is visible|
|
|
8
|
+
|[**click**](#click) | **POST** /browser/{browser_id}/click | Click element|
|
|
9
|
+
|[**closeAllBrowsers**](#closeallbrowsers) | **POST** /browser/close_all | Close all active browser instances|
|
|
10
|
+
|[**closeBrowser**](#closebrowser) | **POST** /browser/{browser_id}/close | Close a browser instance|
|
|
11
|
+
|[**consoleLogs**](#consolelogs) | **POST** /browser/{browser_id}/console | Get or clear console logs|
|
|
12
|
+
|[**createBrowser**](#createbrowser) | **POST** /browser/create | Create a new browser instance|
|
|
13
|
+
|[**deleteBrowser**](#deletebrowser) | **DELETE** /browser/{browser_id} | Close and remove a browser instance|
|
|
14
|
+
|[**detectCoordinates**](#detectcoordinates) | **POST** /browser/{browser_id}/detect_coordinates | Detect element coordinates using AI vision|
|
|
15
|
+
|[**dialog**](#dialog) | **POST** /browser/{browser_id}/dialog | Manage browser dialogs: get, accept, or dismiss|
|
|
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|
|
|
18
|
+
|[**fillForm**](#fillform) | **POST** /browser/{browser_id}/fill_form | Fill multiple form fields|
|
|
19
|
+
|[**getBrowser**](#getbrowser) | **GET** /browser/{browser_id} | Get browser instance details|
|
|
20
|
+
|[**getBrowserStatus**](#getbrowserstatus) | **GET** /browser/{browser_id}/status | Get browser status|
|
|
21
|
+
|[**getContent**](#getcontent) | **GET** /browser/{browser_id}/content | Get page HTML content|
|
|
22
|
+
|[**getElementData**](#getelementdata) | **POST** /browser/{browser_id}/element_data | Get element text, attribute, or property|
|
|
23
|
+
|[**getPoolStatus**](#getpoolstatus) | **GET** /browser/pool/status | Get browser pool status|
|
|
24
|
+
|[**getUrl**](#geturl) | **GET** /browser/{browser_id}/url | Get current page URL|
|
|
25
|
+
|[**guiClick**](#guiclick) | **POST** /browser/{browser_id}/gui_click | Click using selector or screen coordinates|
|
|
26
|
+
|[**history**](#history) | **POST** /browser/{browser_id}/history | Execute history action: back, forward, or refresh|
|
|
27
|
+
|[**listBrowsers**](#listbrowsers) | **GET** /browser/list | List all active browser instances|
|
|
28
|
+
|[**mouse**](#mouse) | **POST** /browser/{browser_id}/mouse | Mouse action: hover or drag|
|
|
29
|
+
|[**navigateBrowser**](#navigatebrowser) | **POST** /browser/{browser_id}/navigate | Navigate to a URL|
|
|
30
|
+
|[**networkLogs**](#networklogs) | **POST** /browser/{browser_id}/network | Get or clear network logs|
|
|
31
|
+
|[**performance**](#performance) | **POST** /browser/{browser_id}/performance | Manage performance: start_trace, stop_trace, metrics, or analyze|
|
|
32
|
+
|[**pressKeys**](#presskeys) | **POST** /browser/{browser_id}/press_keys | Press keys on an element|
|
|
33
|
+
|[**resize**](#resize) | **POST** /browser/{browser_id}/resize | Resize viewport|
|
|
34
|
+
|[**scroll**](#scroll) | **POST** /browser/{browser_id}/scroll | Scroll to element/coordinates (absolute) or by delta (relative)|
|
|
35
|
+
|[**select**](#select) | **POST** /browser/{browser_id}/select | Select dropdown: select option or get options|
|
|
36
|
+
|[**tabs**](#tabs) | **POST** /browser/{browser_id}/tabs | Manage browser tabs: list, new, switch, close, or current|
|
|
37
|
+
|[**takeScreenshot**](#takescreenshot) | **POST** /browser/{browser_id}/screenshot | Take a screenshot|
|
|
38
|
+
|[**takeSnapshot**](#takesnapshot) | **POST** /browser/{browser_id}/snapshot | Take DOM/accessibility snapshot|
|
|
39
|
+
|[**typeText**](#typetext) | **POST** /browser/{browser_id}/type | Type text into an element|
|
|
40
|
+
|[**uploadFile**](#uploadfile) | **POST** /browser/{browser_id}/upload_file | Upload a file|
|
|
41
|
+
|[**waitElement**](#waitelement) | **POST** /browser/{browser_id}/wait_element | Wait for element to become visible or hidden|
|
|
42
|
+
|[**whatIsVisible**](#whatisvisible) | **GET** /browser/{browser_id}/what_is_visible | Analyze visible page content using AI|
|
|
43
|
+
|
|
44
|
+
# **checkElement**
|
|
45
|
+
> SuccessResponse checkElement(payload)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Example
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
import {
|
|
52
|
+
BrowserApi,
|
|
53
|
+
Configuration,
|
|
54
|
+
CheckElementRequest
|
|
55
|
+
} from 'airbrowser-client';
|
|
56
|
+
|
|
57
|
+
const configuration = new Configuration();
|
|
58
|
+
const apiInstance = new BrowserApi(configuration);
|
|
59
|
+
|
|
60
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
61
|
+
let payload: CheckElementRequest; //
|
|
62
|
+
|
|
63
|
+
const { status, data } = await apiInstance.checkElement(
|
|
64
|
+
browserId,
|
|
65
|
+
payload
|
|
66
|
+
);
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
|Name | Type | Description | Notes|
|
|
72
|
+
|------------- | ------------- | ------------- | -------------|
|
|
73
|
+
| **payload** | **CheckElementRequest**| | |
|
|
74
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### Return type
|
|
78
|
+
|
|
79
|
+
**SuccessResponse**
|
|
80
|
+
|
|
81
|
+
### Authorization
|
|
82
|
+
|
|
83
|
+
No authorization required
|
|
84
|
+
|
|
85
|
+
### HTTP request headers
|
|
86
|
+
|
|
87
|
+
- **Content-Type**: application/json
|
|
88
|
+
- **Accept**: application/json
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### HTTP response details
|
|
92
|
+
| Status code | Description | Response headers |
|
|
93
|
+
|-------------|-------------|------------------|
|
|
94
|
+
|**200** | Success | - |
|
|
95
|
+
|
|
96
|
+
[[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
|
+
|
|
98
|
+
# **click**
|
|
99
|
+
> ActionResult click(payload)
|
|
100
|
+
|
|
101
|
+
Use if_visible=true to only click if visible.
|
|
102
|
+
|
|
103
|
+
### Example
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
import {
|
|
107
|
+
BrowserApi,
|
|
108
|
+
Configuration,
|
|
109
|
+
ClickRequest
|
|
110
|
+
} from 'airbrowser-client';
|
|
111
|
+
|
|
112
|
+
const configuration = new Configuration();
|
|
113
|
+
const apiInstance = new BrowserApi(configuration);
|
|
114
|
+
|
|
115
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
116
|
+
let payload: ClickRequest; //
|
|
117
|
+
|
|
118
|
+
const { status, data } = await apiInstance.click(
|
|
119
|
+
browserId,
|
|
120
|
+
payload
|
|
121
|
+
);
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Parameters
|
|
125
|
+
|
|
126
|
+
|Name | Type | Description | Notes|
|
|
127
|
+
|------------- | ------------- | ------------- | -------------|
|
|
128
|
+
| **payload** | **ClickRequest**| | |
|
|
129
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
**ActionResult**
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
No authorization required
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: application/json
|
|
143
|
+
- **Accept**: application/json
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
### HTTP response details
|
|
147
|
+
| Status code | Description | Response headers |
|
|
148
|
+
|-------------|-------------|------------------|
|
|
149
|
+
|**200** | Success | - |
|
|
150
|
+
|
|
151
|
+
[[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
|
+
|
|
153
|
+
# **closeAllBrowsers**
|
|
154
|
+
> BaseResponse closeAllBrowsers()
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
### Example
|
|
158
|
+
|
|
159
|
+
```typescript
|
|
160
|
+
import {
|
|
161
|
+
BrowserApi,
|
|
162
|
+
Configuration
|
|
163
|
+
} from 'airbrowser-client';
|
|
164
|
+
|
|
165
|
+
const configuration = new Configuration();
|
|
166
|
+
const apiInstance = new BrowserApi(configuration);
|
|
167
|
+
|
|
168
|
+
const { status, data } = await apiInstance.closeAllBrowsers();
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Parameters
|
|
172
|
+
This endpoint does not have any parameters.
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
### Return type
|
|
176
|
+
|
|
177
|
+
**BaseResponse**
|
|
178
|
+
|
|
179
|
+
### Authorization
|
|
180
|
+
|
|
181
|
+
No authorization required
|
|
182
|
+
|
|
183
|
+
### HTTP request headers
|
|
184
|
+
|
|
185
|
+
- **Content-Type**: Not defined
|
|
186
|
+
- **Accept**: application/json
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
### HTTP response details
|
|
190
|
+
| Status code | Description | Response headers |
|
|
191
|
+
|-------------|-------------|------------------|
|
|
192
|
+
|**200** | Success | - |
|
|
193
|
+
|
|
194
|
+
[[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
|
+
|
|
196
|
+
# **closeBrowser**
|
|
197
|
+
> BaseResponse closeBrowser()
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
### Example
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
import {
|
|
204
|
+
BrowserApi,
|
|
205
|
+
Configuration
|
|
206
|
+
} from 'airbrowser-client';
|
|
207
|
+
|
|
208
|
+
const configuration = new Configuration();
|
|
209
|
+
const apiInstance = new BrowserApi(configuration);
|
|
210
|
+
|
|
211
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
212
|
+
|
|
213
|
+
const { status, data } = await apiInstance.closeBrowser(
|
|
214
|
+
browserId
|
|
215
|
+
);
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
### Parameters
|
|
219
|
+
|
|
220
|
+
|Name | Type | Description | Notes|
|
|
221
|
+
|------------- | ------------- | ------------- | -------------|
|
|
222
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
### Return type
|
|
226
|
+
|
|
227
|
+
**BaseResponse**
|
|
228
|
+
|
|
229
|
+
### Authorization
|
|
230
|
+
|
|
231
|
+
No authorization required
|
|
232
|
+
|
|
233
|
+
### HTTP request headers
|
|
234
|
+
|
|
235
|
+
- **Content-Type**: Not defined
|
|
236
|
+
- **Accept**: application/json
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
### HTTP response details
|
|
240
|
+
| Status code | Description | Response headers |
|
|
241
|
+
|-------------|-------------|------------------|
|
|
242
|
+
|**200** | Success | - |
|
|
243
|
+
|
|
244
|
+
[[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
|
+
|
|
246
|
+
# **consoleLogs**
|
|
247
|
+
> LogsResponse consoleLogs(payload)
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
### Example
|
|
251
|
+
|
|
252
|
+
```typescript
|
|
253
|
+
import {
|
|
254
|
+
BrowserApi,
|
|
255
|
+
Configuration,
|
|
256
|
+
ConsoleLogsRequest
|
|
257
|
+
} from 'airbrowser-client';
|
|
258
|
+
|
|
259
|
+
const configuration = new Configuration();
|
|
260
|
+
const apiInstance = new BrowserApi(configuration);
|
|
261
|
+
|
|
262
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
263
|
+
let payload: ConsoleLogsRequest; //
|
|
264
|
+
|
|
265
|
+
const { status, data } = await apiInstance.consoleLogs(
|
|
266
|
+
browserId,
|
|
267
|
+
payload
|
|
268
|
+
);
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Parameters
|
|
272
|
+
|
|
273
|
+
|Name | Type | Description | Notes|
|
|
274
|
+
|------------- | ------------- | ------------- | -------------|
|
|
275
|
+
| **payload** | **ConsoleLogsRequest**| | |
|
|
276
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
### Return type
|
|
280
|
+
|
|
281
|
+
**LogsResponse**
|
|
282
|
+
|
|
283
|
+
### Authorization
|
|
284
|
+
|
|
285
|
+
No authorization required
|
|
286
|
+
|
|
287
|
+
### HTTP request headers
|
|
288
|
+
|
|
289
|
+
- **Content-Type**: application/json
|
|
290
|
+
- **Accept**: application/json
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
### HTTP response details
|
|
294
|
+
| Status code | Description | Response headers |
|
|
295
|
+
|-------------|-------------|------------------|
|
|
296
|
+
|**200** | Success | - |
|
|
297
|
+
|
|
298
|
+
[[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
|
+
|
|
300
|
+
# **createBrowser**
|
|
301
|
+
> BrowserCreated createBrowser(payload)
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
### Example
|
|
305
|
+
|
|
306
|
+
```typescript
|
|
307
|
+
import {
|
|
308
|
+
BrowserApi,
|
|
309
|
+
Configuration,
|
|
310
|
+
BrowserConfig
|
|
311
|
+
} from 'airbrowser-client';
|
|
312
|
+
|
|
313
|
+
const configuration = new Configuration();
|
|
314
|
+
const apiInstance = new BrowserApi(configuration);
|
|
315
|
+
|
|
316
|
+
let payload: BrowserConfig; //
|
|
317
|
+
|
|
318
|
+
const { status, data } = await apiInstance.createBrowser(
|
|
319
|
+
payload
|
|
320
|
+
);
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### Parameters
|
|
324
|
+
|
|
325
|
+
|Name | Type | Description | Notes|
|
|
326
|
+
|------------- | ------------- | ------------- | -------------|
|
|
327
|
+
| **payload** | **BrowserConfig**| | |
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Return type
|
|
331
|
+
|
|
332
|
+
**BrowserCreated**
|
|
333
|
+
|
|
334
|
+
### Authorization
|
|
335
|
+
|
|
336
|
+
No authorization required
|
|
337
|
+
|
|
338
|
+
### HTTP request headers
|
|
339
|
+
|
|
340
|
+
- **Content-Type**: application/json
|
|
341
|
+
- **Accept**: application/json
|
|
342
|
+
|
|
343
|
+
|
|
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
|
+
### HTTP response details
|
|
396
|
+
| Status code | Description | Response headers |
|
|
397
|
+
|-------------|-------------|------------------|
|
|
398
|
+
|**200** | Success | - |
|
|
399
|
+
|
|
400
|
+
[[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
|
+
|
|
402
|
+
# **detectCoordinates**
|
|
403
|
+
> DetectCoordinatesResult detectCoordinates(payload)
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
### Example
|
|
407
|
+
|
|
408
|
+
```typescript
|
|
409
|
+
import {
|
|
410
|
+
BrowserApi,
|
|
411
|
+
Configuration,
|
|
412
|
+
DetectCoordinatesRequest
|
|
413
|
+
} from 'airbrowser-client';
|
|
414
|
+
|
|
415
|
+
const configuration = new Configuration();
|
|
416
|
+
const apiInstance = new BrowserApi(configuration);
|
|
417
|
+
|
|
418
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
419
|
+
let payload: DetectCoordinatesRequest; //
|
|
420
|
+
|
|
421
|
+
const { status, data } = await apiInstance.detectCoordinates(
|
|
422
|
+
browserId,
|
|
423
|
+
payload
|
|
424
|
+
);
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### Parameters
|
|
428
|
+
|
|
429
|
+
|Name | Type | Description | Notes|
|
|
430
|
+
|------------- | ------------- | ------------- | -------------|
|
|
431
|
+
| **payload** | **DetectCoordinatesRequest**| | |
|
|
432
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
### Return type
|
|
436
|
+
|
|
437
|
+
**DetectCoordinatesResult**
|
|
438
|
+
|
|
439
|
+
### Authorization
|
|
440
|
+
|
|
441
|
+
No authorization required
|
|
442
|
+
|
|
443
|
+
### HTTP request headers
|
|
444
|
+
|
|
445
|
+
- **Content-Type**: application/json
|
|
446
|
+
- **Accept**: application/json
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
### HTTP response details
|
|
450
|
+
| Status code | Description | Response headers |
|
|
451
|
+
|-------------|-------------|------------------|
|
|
452
|
+
|**200** | Success | - |
|
|
453
|
+
|
|
454
|
+
[[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
|
+
|
|
456
|
+
# **dialog**
|
|
457
|
+
> SuccessResponse dialog(payload)
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
### Example
|
|
461
|
+
|
|
462
|
+
```typescript
|
|
463
|
+
import {
|
|
464
|
+
BrowserApi,
|
|
465
|
+
Configuration,
|
|
466
|
+
CombinedDialogRequest
|
|
467
|
+
} from 'airbrowser-client';
|
|
468
|
+
|
|
469
|
+
const configuration = new Configuration();
|
|
470
|
+
const apiInstance = new BrowserApi(configuration);
|
|
471
|
+
|
|
472
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
473
|
+
let payload: CombinedDialogRequest; //
|
|
474
|
+
|
|
475
|
+
const { status, data } = await apiInstance.dialog(
|
|
476
|
+
browserId,
|
|
477
|
+
payload
|
|
478
|
+
);
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Parameters
|
|
482
|
+
|
|
483
|
+
|Name | Type | Description | Notes|
|
|
484
|
+
|------------- | ------------- | ------------- | -------------|
|
|
485
|
+
| **payload** | **CombinedDialogRequest**| | |
|
|
486
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
### Return type
|
|
490
|
+
|
|
491
|
+
**SuccessResponse**
|
|
492
|
+
|
|
493
|
+
### Authorization
|
|
494
|
+
|
|
495
|
+
No authorization required
|
|
496
|
+
|
|
497
|
+
### HTTP request headers
|
|
498
|
+
|
|
499
|
+
- **Content-Type**: application/json
|
|
500
|
+
- **Accept**: application/json
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
### HTTP response details
|
|
504
|
+
| Status code | Description | Response headers |
|
|
505
|
+
|-------------|-------------|------------------|
|
|
506
|
+
|**200** | Success | - |
|
|
507
|
+
|
|
508
|
+
[[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
|
+
|
|
510
|
+
# **emulate**
|
|
511
|
+
> SuccessResponse emulate(payload)
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
### Example
|
|
515
|
+
|
|
516
|
+
```typescript
|
|
517
|
+
import {
|
|
518
|
+
BrowserApi,
|
|
519
|
+
Configuration,
|
|
520
|
+
CombinedEmulateRequest
|
|
521
|
+
} from 'airbrowser-client';
|
|
522
|
+
|
|
523
|
+
const configuration = new Configuration();
|
|
524
|
+
const apiInstance = new BrowserApi(configuration);
|
|
525
|
+
|
|
526
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
527
|
+
let payload: CombinedEmulateRequest; //
|
|
528
|
+
|
|
529
|
+
const { status, data } = await apiInstance.emulate(
|
|
530
|
+
browserId,
|
|
531
|
+
payload
|
|
532
|
+
);
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
### Parameters
|
|
536
|
+
|
|
537
|
+
|Name | Type | Description | Notes|
|
|
538
|
+
|------------- | ------------- | ------------- | -------------|
|
|
539
|
+
| **payload** | **CombinedEmulateRequest**| | |
|
|
540
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
### Return type
|
|
544
|
+
|
|
545
|
+
**SuccessResponse**
|
|
546
|
+
|
|
547
|
+
### Authorization
|
|
548
|
+
|
|
549
|
+
No authorization required
|
|
550
|
+
|
|
551
|
+
### HTTP request headers
|
|
552
|
+
|
|
553
|
+
- **Content-Type**: application/json
|
|
554
|
+
- **Accept**: application/json
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
### HTTP response details
|
|
558
|
+
| Status code | Description | Response headers |
|
|
559
|
+
|-------------|-------------|------------------|
|
|
560
|
+
|**200** | Success | - |
|
|
561
|
+
|
|
562
|
+
[[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
|
+
|
|
564
|
+
# **executeScript**
|
|
565
|
+
> ExecuteResponse executeScript(payload)
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
### Example
|
|
569
|
+
|
|
570
|
+
```typescript
|
|
571
|
+
import {
|
|
572
|
+
BrowserApi,
|
|
573
|
+
Configuration,
|
|
574
|
+
ExecuteRequest
|
|
575
|
+
} from 'airbrowser-client';
|
|
576
|
+
|
|
577
|
+
const configuration = new Configuration();
|
|
578
|
+
const apiInstance = new BrowserApi(configuration);
|
|
579
|
+
|
|
580
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
581
|
+
let payload: ExecuteRequest; //
|
|
582
|
+
|
|
583
|
+
const { status, data } = await apiInstance.executeScript(
|
|
584
|
+
browserId,
|
|
585
|
+
payload
|
|
586
|
+
);
|
|
587
|
+
```
|
|
588
|
+
|
|
589
|
+
### Parameters
|
|
590
|
+
|
|
591
|
+
|Name | Type | Description | Notes|
|
|
592
|
+
|------------- | ------------- | ------------- | -------------|
|
|
593
|
+
| **payload** | **ExecuteRequest**| | |
|
|
594
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
### Return type
|
|
598
|
+
|
|
599
|
+
**ExecuteResponse**
|
|
600
|
+
|
|
601
|
+
### Authorization
|
|
602
|
+
|
|
603
|
+
No authorization required
|
|
604
|
+
|
|
605
|
+
### HTTP request headers
|
|
606
|
+
|
|
607
|
+
- **Content-Type**: application/json
|
|
608
|
+
- **Accept**: application/json
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
### HTTP response details
|
|
612
|
+
| Status code | Description | Response headers |
|
|
613
|
+
|-------------|-------------|------------------|
|
|
614
|
+
|**200** | Success | - |
|
|
615
|
+
|
|
616
|
+
[[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
|
+
|
|
618
|
+
# **fillForm**
|
|
619
|
+
> SuccessResponse fillForm(payload)
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
### Example
|
|
623
|
+
|
|
624
|
+
```typescript
|
|
625
|
+
import {
|
|
626
|
+
BrowserApi,
|
|
627
|
+
Configuration,
|
|
628
|
+
FillFormRequest
|
|
629
|
+
} from 'airbrowser-client';
|
|
630
|
+
|
|
631
|
+
const configuration = new Configuration();
|
|
632
|
+
const apiInstance = new BrowserApi(configuration);
|
|
633
|
+
|
|
634
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
635
|
+
let payload: FillFormRequest; //
|
|
636
|
+
|
|
637
|
+
const { status, data } = await apiInstance.fillForm(
|
|
638
|
+
browserId,
|
|
639
|
+
payload
|
|
640
|
+
);
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
### Parameters
|
|
644
|
+
|
|
645
|
+
|Name | Type | Description | Notes|
|
|
646
|
+
|------------- | ------------- | ------------- | -------------|
|
|
647
|
+
| **payload** | **FillFormRequest**| | |
|
|
648
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
### Return type
|
|
652
|
+
|
|
653
|
+
**SuccessResponse**
|
|
654
|
+
|
|
655
|
+
### Authorization
|
|
656
|
+
|
|
657
|
+
No authorization required
|
|
658
|
+
|
|
659
|
+
### HTTP request headers
|
|
660
|
+
|
|
661
|
+
- **Content-Type**: application/json
|
|
662
|
+
- **Accept**: application/json
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
### HTTP response details
|
|
666
|
+
| Status code | Description | Response headers |
|
|
667
|
+
|-------------|-------------|------------------|
|
|
668
|
+
|**200** | Success | - |
|
|
669
|
+
|
|
670
|
+
[[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
|
+
|
|
672
|
+
# **getBrowser**
|
|
673
|
+
> BrowserInfoResponse getBrowser()
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
### Example
|
|
677
|
+
|
|
678
|
+
```typescript
|
|
679
|
+
import {
|
|
680
|
+
BrowserApi,
|
|
681
|
+
Configuration
|
|
682
|
+
} from 'airbrowser-client';
|
|
683
|
+
|
|
684
|
+
const configuration = new Configuration();
|
|
685
|
+
const apiInstance = new BrowserApi(configuration);
|
|
686
|
+
|
|
687
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
688
|
+
|
|
689
|
+
const { status, data } = await apiInstance.getBrowser(
|
|
690
|
+
browserId
|
|
691
|
+
);
|
|
692
|
+
```
|
|
693
|
+
|
|
694
|
+
### Parameters
|
|
695
|
+
|
|
696
|
+
|Name | Type | Description | Notes|
|
|
697
|
+
|------------- | ------------- | ------------- | -------------|
|
|
698
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
### Return type
|
|
702
|
+
|
|
703
|
+
**BrowserInfoResponse**
|
|
704
|
+
|
|
705
|
+
### Authorization
|
|
706
|
+
|
|
707
|
+
No authorization required
|
|
708
|
+
|
|
709
|
+
### HTTP request headers
|
|
710
|
+
|
|
711
|
+
- **Content-Type**: Not defined
|
|
712
|
+
- **Accept**: application/json
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
### HTTP response details
|
|
716
|
+
| Status code | Description | Response headers |
|
|
717
|
+
|-------------|-------------|------------------|
|
|
718
|
+
|**404** | Browser not found | - |
|
|
719
|
+
|**200** | Success | - |
|
|
720
|
+
|
|
721
|
+
[[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
|
+
|
|
723
|
+
# **getBrowserStatus**
|
|
724
|
+
> BrowserInfoResponse getBrowserStatus()
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
### Example
|
|
728
|
+
|
|
729
|
+
```typescript
|
|
730
|
+
import {
|
|
731
|
+
BrowserApi,
|
|
732
|
+
Configuration
|
|
733
|
+
} from 'airbrowser-client';
|
|
734
|
+
|
|
735
|
+
const configuration = new Configuration();
|
|
736
|
+
const apiInstance = new BrowserApi(configuration);
|
|
737
|
+
|
|
738
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
739
|
+
|
|
740
|
+
const { status, data } = await apiInstance.getBrowserStatus(
|
|
741
|
+
browserId
|
|
742
|
+
);
|
|
743
|
+
```
|
|
744
|
+
|
|
745
|
+
### Parameters
|
|
746
|
+
|
|
747
|
+
|Name | Type | Description | Notes|
|
|
748
|
+
|------------- | ------------- | ------------- | -------------|
|
|
749
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
### Return type
|
|
753
|
+
|
|
754
|
+
**BrowserInfoResponse**
|
|
755
|
+
|
|
756
|
+
### Authorization
|
|
757
|
+
|
|
758
|
+
No authorization required
|
|
759
|
+
|
|
760
|
+
### HTTP request headers
|
|
761
|
+
|
|
762
|
+
- **Content-Type**: Not defined
|
|
763
|
+
- **Accept**: application/json
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
### HTTP response details
|
|
767
|
+
| Status code | Description | Response headers |
|
|
768
|
+
|-------------|-------------|------------------|
|
|
769
|
+
|**200** | Success | - |
|
|
770
|
+
|
|
771
|
+
[[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
|
+
|
|
773
|
+
# **getContent**
|
|
774
|
+
> ContentResponse getContent()
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
### Example
|
|
778
|
+
|
|
779
|
+
```typescript
|
|
780
|
+
import {
|
|
781
|
+
BrowserApi,
|
|
782
|
+
Configuration
|
|
783
|
+
} from 'airbrowser-client';
|
|
784
|
+
|
|
785
|
+
const configuration = new Configuration();
|
|
786
|
+
const apiInstance = new BrowserApi(configuration);
|
|
787
|
+
|
|
788
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
789
|
+
|
|
790
|
+
const { status, data } = await apiInstance.getContent(
|
|
791
|
+
browserId
|
|
792
|
+
);
|
|
793
|
+
```
|
|
794
|
+
|
|
795
|
+
### Parameters
|
|
796
|
+
|
|
797
|
+
|Name | Type | Description | Notes|
|
|
798
|
+
|------------- | ------------- | ------------- | -------------|
|
|
799
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
### Return type
|
|
803
|
+
|
|
804
|
+
**ContentResponse**
|
|
805
|
+
|
|
806
|
+
### Authorization
|
|
807
|
+
|
|
808
|
+
No authorization required
|
|
809
|
+
|
|
810
|
+
### HTTP request headers
|
|
811
|
+
|
|
812
|
+
- **Content-Type**: Not defined
|
|
813
|
+
- **Accept**: application/json
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
### HTTP response details
|
|
817
|
+
| Status code | Description | Response headers |
|
|
818
|
+
|-------------|-------------|------------------|
|
|
819
|
+
|**200** | Success | - |
|
|
820
|
+
|
|
821
|
+
[[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
|
+
|
|
823
|
+
# **getElementData**
|
|
824
|
+
> AttributeResponse getElementData(payload)
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
### Example
|
|
828
|
+
|
|
829
|
+
```typescript
|
|
830
|
+
import {
|
|
831
|
+
BrowserApi,
|
|
832
|
+
Configuration,
|
|
833
|
+
ElementDataRequest
|
|
834
|
+
} from 'airbrowser-client';
|
|
835
|
+
|
|
836
|
+
const configuration = new Configuration();
|
|
837
|
+
const apiInstance = new BrowserApi(configuration);
|
|
838
|
+
|
|
839
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
840
|
+
let payload: ElementDataRequest; //
|
|
841
|
+
|
|
842
|
+
const { status, data } = await apiInstance.getElementData(
|
|
843
|
+
browserId,
|
|
844
|
+
payload
|
|
845
|
+
);
|
|
846
|
+
```
|
|
847
|
+
|
|
848
|
+
### Parameters
|
|
849
|
+
|
|
850
|
+
|Name | Type | Description | Notes|
|
|
851
|
+
|------------- | ------------- | ------------- | -------------|
|
|
852
|
+
| **payload** | **ElementDataRequest**| | |
|
|
853
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
### Return type
|
|
857
|
+
|
|
858
|
+
**AttributeResponse**
|
|
859
|
+
|
|
860
|
+
### Authorization
|
|
861
|
+
|
|
862
|
+
No authorization required
|
|
863
|
+
|
|
864
|
+
### HTTP request headers
|
|
865
|
+
|
|
866
|
+
- **Content-Type**: application/json
|
|
867
|
+
- **Accept**: application/json
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
### HTTP response details
|
|
871
|
+
| Status code | Description | Response headers |
|
|
872
|
+
|-------------|-------------|------------------|
|
|
873
|
+
|**200** | Success | - |
|
|
874
|
+
|
|
875
|
+
[[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
|
+
|
|
877
|
+
# **getPoolStatus**
|
|
878
|
+
> PoolStatusResponse getPoolStatus()
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
### Example
|
|
882
|
+
|
|
883
|
+
```typescript
|
|
884
|
+
import {
|
|
885
|
+
BrowserApi,
|
|
886
|
+
Configuration
|
|
887
|
+
} from 'airbrowser-client';
|
|
888
|
+
|
|
889
|
+
const configuration = new Configuration();
|
|
890
|
+
const apiInstance = new BrowserApi(configuration);
|
|
891
|
+
|
|
892
|
+
const { status, data } = await apiInstance.getPoolStatus();
|
|
893
|
+
```
|
|
894
|
+
|
|
895
|
+
### Parameters
|
|
896
|
+
This endpoint does not have any parameters.
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
### Return type
|
|
900
|
+
|
|
901
|
+
**PoolStatusResponse**
|
|
902
|
+
|
|
903
|
+
### Authorization
|
|
904
|
+
|
|
905
|
+
No authorization required
|
|
906
|
+
|
|
907
|
+
### HTTP request headers
|
|
908
|
+
|
|
909
|
+
- **Content-Type**: Not defined
|
|
910
|
+
- **Accept**: application/json
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
### HTTP response details
|
|
914
|
+
| Status code | Description | Response headers |
|
|
915
|
+
|-------------|-------------|------------------|
|
|
916
|
+
|**200** | Success | - |
|
|
917
|
+
|
|
918
|
+
[[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
|
+
|
|
920
|
+
# **getUrl**
|
|
921
|
+
> UrlResponse getUrl()
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
### Example
|
|
925
|
+
|
|
926
|
+
```typescript
|
|
927
|
+
import {
|
|
928
|
+
BrowserApi,
|
|
929
|
+
Configuration
|
|
930
|
+
} from 'airbrowser-client';
|
|
931
|
+
|
|
932
|
+
const configuration = new Configuration();
|
|
933
|
+
const apiInstance = new BrowserApi(configuration);
|
|
934
|
+
|
|
935
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
936
|
+
|
|
937
|
+
const { status, data } = await apiInstance.getUrl(
|
|
938
|
+
browserId
|
|
939
|
+
);
|
|
940
|
+
```
|
|
941
|
+
|
|
942
|
+
### Parameters
|
|
943
|
+
|
|
944
|
+
|Name | Type | Description | Notes|
|
|
945
|
+
|------------- | ------------- | ------------- | -------------|
|
|
946
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
### Return type
|
|
950
|
+
|
|
951
|
+
**UrlResponse**
|
|
952
|
+
|
|
953
|
+
### Authorization
|
|
954
|
+
|
|
955
|
+
No authorization required
|
|
956
|
+
|
|
957
|
+
### HTTP request headers
|
|
958
|
+
|
|
959
|
+
- **Content-Type**: Not defined
|
|
960
|
+
- **Accept**: application/json
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
### HTTP response details
|
|
964
|
+
| Status code | Description | Response headers |
|
|
965
|
+
|-------------|-------------|------------------|
|
|
966
|
+
|**200** | Success | - |
|
|
967
|
+
|
|
968
|
+
[[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
|
+
|
|
970
|
+
# **guiClick**
|
|
971
|
+
> ActionResult guiClick(payload)
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
### Example
|
|
975
|
+
|
|
976
|
+
```typescript
|
|
977
|
+
import {
|
|
978
|
+
BrowserApi,
|
|
979
|
+
Configuration,
|
|
980
|
+
CombinedGuiClickRequest
|
|
981
|
+
} from 'airbrowser-client';
|
|
982
|
+
|
|
983
|
+
const configuration = new Configuration();
|
|
984
|
+
const apiInstance = new BrowserApi(configuration);
|
|
985
|
+
|
|
986
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
987
|
+
let payload: CombinedGuiClickRequest; //
|
|
988
|
+
|
|
989
|
+
const { status, data } = await apiInstance.guiClick(
|
|
990
|
+
browserId,
|
|
991
|
+
payload
|
|
992
|
+
);
|
|
993
|
+
```
|
|
994
|
+
|
|
995
|
+
### Parameters
|
|
996
|
+
|
|
997
|
+
|Name | Type | Description | Notes|
|
|
998
|
+
|------------- | ------------- | ------------- | -------------|
|
|
999
|
+
| **payload** | **CombinedGuiClickRequest**| | |
|
|
1000
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
### Return type
|
|
1004
|
+
|
|
1005
|
+
**ActionResult**
|
|
1006
|
+
|
|
1007
|
+
### Authorization
|
|
1008
|
+
|
|
1009
|
+
No authorization required
|
|
1010
|
+
|
|
1011
|
+
### HTTP request headers
|
|
1012
|
+
|
|
1013
|
+
- **Content-Type**: application/json
|
|
1014
|
+
- **Accept**: application/json
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
### HTTP response details
|
|
1018
|
+
| Status code | Description | Response headers |
|
|
1019
|
+
|-------------|-------------|------------------|
|
|
1020
|
+
|**200** | Success | - |
|
|
1021
|
+
|
|
1022
|
+
[[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
|
+
|
|
1024
|
+
# **history**
|
|
1025
|
+
> ActionResult history(payload)
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
### Example
|
|
1029
|
+
|
|
1030
|
+
```typescript
|
|
1031
|
+
import {
|
|
1032
|
+
BrowserApi,
|
|
1033
|
+
Configuration,
|
|
1034
|
+
HistoryRequest
|
|
1035
|
+
} from 'airbrowser-client';
|
|
1036
|
+
|
|
1037
|
+
const configuration = new Configuration();
|
|
1038
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1039
|
+
|
|
1040
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1041
|
+
let payload: HistoryRequest; //
|
|
1042
|
+
|
|
1043
|
+
const { status, data } = await apiInstance.history(
|
|
1044
|
+
browserId,
|
|
1045
|
+
payload
|
|
1046
|
+
);
|
|
1047
|
+
```
|
|
1048
|
+
|
|
1049
|
+
### Parameters
|
|
1050
|
+
|
|
1051
|
+
|Name | Type | Description | Notes|
|
|
1052
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1053
|
+
| **payload** | **HistoryRequest**| | |
|
|
1054
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
### Return type
|
|
1058
|
+
|
|
1059
|
+
**ActionResult**
|
|
1060
|
+
|
|
1061
|
+
### Authorization
|
|
1062
|
+
|
|
1063
|
+
No authorization required
|
|
1064
|
+
|
|
1065
|
+
### HTTP request headers
|
|
1066
|
+
|
|
1067
|
+
- **Content-Type**: application/json
|
|
1068
|
+
- **Accept**: application/json
|
|
1069
|
+
|
|
1070
|
+
|
|
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
|
+
### HTTP response details
|
|
1115
|
+
| Status code | Description | Response headers |
|
|
1116
|
+
|-------------|-------------|------------------|
|
|
1117
|
+
|**200** | Success | - |
|
|
1118
|
+
|
|
1119
|
+
[[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
|
+
|
|
1121
|
+
# **mouse**
|
|
1122
|
+
> SuccessResponse mouse(payload)
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
### Example
|
|
1126
|
+
|
|
1127
|
+
```typescript
|
|
1128
|
+
import {
|
|
1129
|
+
BrowserApi,
|
|
1130
|
+
Configuration,
|
|
1131
|
+
MouseRequest
|
|
1132
|
+
} from 'airbrowser-client';
|
|
1133
|
+
|
|
1134
|
+
const configuration = new Configuration();
|
|
1135
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1136
|
+
|
|
1137
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1138
|
+
let payload: MouseRequest; //
|
|
1139
|
+
|
|
1140
|
+
const { status, data } = await apiInstance.mouse(
|
|
1141
|
+
browserId,
|
|
1142
|
+
payload
|
|
1143
|
+
);
|
|
1144
|
+
```
|
|
1145
|
+
|
|
1146
|
+
### Parameters
|
|
1147
|
+
|
|
1148
|
+
|Name | Type | Description | Notes|
|
|
1149
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1150
|
+
| **payload** | **MouseRequest**| | |
|
|
1151
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
### Return type
|
|
1155
|
+
|
|
1156
|
+
**SuccessResponse**
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
No authorization required
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: application/json
|
|
1165
|
+
- **Accept**: application/json
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
### HTTP response details
|
|
1169
|
+
| Status code | Description | Response headers |
|
|
1170
|
+
|-------------|-------------|------------------|
|
|
1171
|
+
|**200** | Success | - |
|
|
1172
|
+
|
|
1173
|
+
[[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
|
+
|
|
1175
|
+
# **navigateBrowser**
|
|
1176
|
+
> ActionResult navigateBrowser(payload)
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
### Example
|
|
1180
|
+
|
|
1181
|
+
```typescript
|
|
1182
|
+
import {
|
|
1183
|
+
BrowserApi,
|
|
1184
|
+
Configuration,
|
|
1185
|
+
NavigateRequest
|
|
1186
|
+
} from 'airbrowser-client';
|
|
1187
|
+
|
|
1188
|
+
const configuration = new Configuration();
|
|
1189
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1190
|
+
|
|
1191
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1192
|
+
let payload: NavigateRequest; //
|
|
1193
|
+
|
|
1194
|
+
const { status, data } = await apiInstance.navigateBrowser(
|
|
1195
|
+
browserId,
|
|
1196
|
+
payload
|
|
1197
|
+
);
|
|
1198
|
+
```
|
|
1199
|
+
|
|
1200
|
+
### Parameters
|
|
1201
|
+
|
|
1202
|
+
|Name | Type | Description | Notes|
|
|
1203
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1204
|
+
| **payload** | **NavigateRequest**| | |
|
|
1205
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
### Return type
|
|
1209
|
+
|
|
1210
|
+
**ActionResult**
|
|
1211
|
+
|
|
1212
|
+
### Authorization
|
|
1213
|
+
|
|
1214
|
+
No authorization required
|
|
1215
|
+
|
|
1216
|
+
### HTTP request headers
|
|
1217
|
+
|
|
1218
|
+
- **Content-Type**: application/json
|
|
1219
|
+
- **Accept**: application/json
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
### HTTP response details
|
|
1223
|
+
| Status code | Description | Response headers |
|
|
1224
|
+
|-------------|-------------|------------------|
|
|
1225
|
+
|**200** | Success | - |
|
|
1226
|
+
|
|
1227
|
+
[[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
|
+
|
|
1229
|
+
# **networkLogs**
|
|
1230
|
+
> LogsResponse networkLogs(payload)
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
### Example
|
|
1234
|
+
|
|
1235
|
+
```typescript
|
|
1236
|
+
import {
|
|
1237
|
+
BrowserApi,
|
|
1238
|
+
Configuration,
|
|
1239
|
+
NetworkLogsRequest
|
|
1240
|
+
} from 'airbrowser-client';
|
|
1241
|
+
|
|
1242
|
+
const configuration = new Configuration();
|
|
1243
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1244
|
+
|
|
1245
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1246
|
+
let payload: NetworkLogsRequest; //
|
|
1247
|
+
|
|
1248
|
+
const { status, data } = await apiInstance.networkLogs(
|
|
1249
|
+
browserId,
|
|
1250
|
+
payload
|
|
1251
|
+
);
|
|
1252
|
+
```
|
|
1253
|
+
|
|
1254
|
+
### Parameters
|
|
1255
|
+
|
|
1256
|
+
|Name | Type | Description | Notes|
|
|
1257
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1258
|
+
| **payload** | **NetworkLogsRequest**| | |
|
|
1259
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
### Return type
|
|
1263
|
+
|
|
1264
|
+
**LogsResponse**
|
|
1265
|
+
|
|
1266
|
+
### Authorization
|
|
1267
|
+
|
|
1268
|
+
No authorization required
|
|
1269
|
+
|
|
1270
|
+
### HTTP request headers
|
|
1271
|
+
|
|
1272
|
+
- **Content-Type**: application/json
|
|
1273
|
+
- **Accept**: application/json
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
### HTTP response details
|
|
1277
|
+
| Status code | Description | Response headers |
|
|
1278
|
+
|-------------|-------------|------------------|
|
|
1279
|
+
|**200** | Success | - |
|
|
1280
|
+
|
|
1281
|
+
[[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
|
+
|
|
1283
|
+
# **performance**
|
|
1284
|
+
> SuccessResponse performance(payload)
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
### Example
|
|
1288
|
+
|
|
1289
|
+
```typescript
|
|
1290
|
+
import {
|
|
1291
|
+
BrowserApi,
|
|
1292
|
+
Configuration,
|
|
1293
|
+
PerformanceRequest
|
|
1294
|
+
} from 'airbrowser-client';
|
|
1295
|
+
|
|
1296
|
+
const configuration = new Configuration();
|
|
1297
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1298
|
+
|
|
1299
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1300
|
+
let payload: PerformanceRequest; //
|
|
1301
|
+
|
|
1302
|
+
const { status, data } = await apiInstance.performance(
|
|
1303
|
+
browserId,
|
|
1304
|
+
payload
|
|
1305
|
+
);
|
|
1306
|
+
```
|
|
1307
|
+
|
|
1308
|
+
### Parameters
|
|
1309
|
+
|
|
1310
|
+
|Name | Type | Description | Notes|
|
|
1311
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1312
|
+
| **payload** | **PerformanceRequest**| | |
|
|
1313
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
### Return type
|
|
1317
|
+
|
|
1318
|
+
**SuccessResponse**
|
|
1319
|
+
|
|
1320
|
+
### Authorization
|
|
1321
|
+
|
|
1322
|
+
No authorization required
|
|
1323
|
+
|
|
1324
|
+
### HTTP request headers
|
|
1325
|
+
|
|
1326
|
+
- **Content-Type**: application/json
|
|
1327
|
+
- **Accept**: application/json
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
### HTTP response details
|
|
1331
|
+
| Status code | Description | Response headers |
|
|
1332
|
+
|-------------|-------------|------------------|
|
|
1333
|
+
|**200** | Success | - |
|
|
1334
|
+
|
|
1335
|
+
[[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
|
+
|
|
1337
|
+
# **pressKeys**
|
|
1338
|
+
> ActionResult pressKeys(payload)
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
### Example
|
|
1342
|
+
|
|
1343
|
+
```typescript
|
|
1344
|
+
import {
|
|
1345
|
+
BrowserApi,
|
|
1346
|
+
Configuration,
|
|
1347
|
+
PressKeysRequest
|
|
1348
|
+
} from 'airbrowser-client';
|
|
1349
|
+
|
|
1350
|
+
const configuration = new Configuration();
|
|
1351
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1352
|
+
|
|
1353
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1354
|
+
let payload: PressKeysRequest; //
|
|
1355
|
+
|
|
1356
|
+
const { status, data } = await apiInstance.pressKeys(
|
|
1357
|
+
browserId,
|
|
1358
|
+
payload
|
|
1359
|
+
);
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
### Parameters
|
|
1363
|
+
|
|
1364
|
+
|Name | Type | Description | Notes|
|
|
1365
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1366
|
+
| **payload** | **PressKeysRequest**| | |
|
|
1367
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
### Return type
|
|
1371
|
+
|
|
1372
|
+
**ActionResult**
|
|
1373
|
+
|
|
1374
|
+
### Authorization
|
|
1375
|
+
|
|
1376
|
+
No authorization required
|
|
1377
|
+
|
|
1378
|
+
### HTTP request headers
|
|
1379
|
+
|
|
1380
|
+
- **Content-Type**: application/json
|
|
1381
|
+
- **Accept**: application/json
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
### HTTP response details
|
|
1385
|
+
| Status code | Description | Response headers |
|
|
1386
|
+
|-------------|-------------|------------------|
|
|
1387
|
+
|**200** | Success | - |
|
|
1388
|
+
|
|
1389
|
+
[[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
|
+
|
|
1391
|
+
# **resize**
|
|
1392
|
+
> SuccessResponse resize(payload)
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
### Example
|
|
1396
|
+
|
|
1397
|
+
```typescript
|
|
1398
|
+
import {
|
|
1399
|
+
BrowserApi,
|
|
1400
|
+
Configuration,
|
|
1401
|
+
ResizeRequest
|
|
1402
|
+
} from 'airbrowser-client';
|
|
1403
|
+
|
|
1404
|
+
const configuration = new Configuration();
|
|
1405
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1406
|
+
|
|
1407
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1408
|
+
let payload: ResizeRequest; //
|
|
1409
|
+
|
|
1410
|
+
const { status, data } = await apiInstance.resize(
|
|
1411
|
+
browserId,
|
|
1412
|
+
payload
|
|
1413
|
+
);
|
|
1414
|
+
```
|
|
1415
|
+
|
|
1416
|
+
### Parameters
|
|
1417
|
+
|
|
1418
|
+
|Name | Type | Description | Notes|
|
|
1419
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1420
|
+
| **payload** | **ResizeRequest**| | |
|
|
1421
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
### Return type
|
|
1425
|
+
|
|
1426
|
+
**SuccessResponse**
|
|
1427
|
+
|
|
1428
|
+
### Authorization
|
|
1429
|
+
|
|
1430
|
+
No authorization required
|
|
1431
|
+
|
|
1432
|
+
### HTTP request headers
|
|
1433
|
+
|
|
1434
|
+
- **Content-Type**: application/json
|
|
1435
|
+
- **Accept**: application/json
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
### HTTP response details
|
|
1439
|
+
| Status code | Description | Response headers |
|
|
1440
|
+
|-------------|-------------|------------------|
|
|
1441
|
+
|**200** | Success | - |
|
|
1442
|
+
|
|
1443
|
+
[[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
|
+
|
|
1445
|
+
# **scroll**
|
|
1446
|
+
> SuccessResponse scroll(payload)
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
### Example
|
|
1450
|
+
|
|
1451
|
+
```typescript
|
|
1452
|
+
import {
|
|
1453
|
+
BrowserApi,
|
|
1454
|
+
Configuration,
|
|
1455
|
+
CombinedScrollRequest
|
|
1456
|
+
} from 'airbrowser-client';
|
|
1457
|
+
|
|
1458
|
+
const configuration = new Configuration();
|
|
1459
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1460
|
+
|
|
1461
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1462
|
+
let payload: CombinedScrollRequest; //
|
|
1463
|
+
|
|
1464
|
+
const { status, data } = await apiInstance.scroll(
|
|
1465
|
+
browserId,
|
|
1466
|
+
payload
|
|
1467
|
+
);
|
|
1468
|
+
```
|
|
1469
|
+
|
|
1470
|
+
### Parameters
|
|
1471
|
+
|
|
1472
|
+
|Name | Type | Description | Notes|
|
|
1473
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1474
|
+
| **payload** | **CombinedScrollRequest**| | |
|
|
1475
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
### Return type
|
|
1479
|
+
|
|
1480
|
+
**SuccessResponse**
|
|
1481
|
+
|
|
1482
|
+
### Authorization
|
|
1483
|
+
|
|
1484
|
+
No authorization required
|
|
1485
|
+
|
|
1486
|
+
### HTTP request headers
|
|
1487
|
+
|
|
1488
|
+
- **Content-Type**: application/json
|
|
1489
|
+
- **Accept**: application/json
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
### HTTP response details
|
|
1493
|
+
| Status code | Description | Response headers |
|
|
1494
|
+
|-------------|-------------|------------------|
|
|
1495
|
+
|**200** | Success | - |
|
|
1496
|
+
|
|
1497
|
+
[[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
|
+
|
|
1499
|
+
# **select**
|
|
1500
|
+
> SuccessResponse select(payload)
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
### Example
|
|
1504
|
+
|
|
1505
|
+
```typescript
|
|
1506
|
+
import {
|
|
1507
|
+
BrowserApi,
|
|
1508
|
+
Configuration,
|
|
1509
|
+
SelectRequest
|
|
1510
|
+
} from 'airbrowser-client';
|
|
1511
|
+
|
|
1512
|
+
const configuration = new Configuration();
|
|
1513
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1514
|
+
|
|
1515
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1516
|
+
let payload: SelectRequest; //
|
|
1517
|
+
|
|
1518
|
+
const { status, data } = await apiInstance.select(
|
|
1519
|
+
browserId,
|
|
1520
|
+
payload
|
|
1521
|
+
);
|
|
1522
|
+
```
|
|
1523
|
+
|
|
1524
|
+
### Parameters
|
|
1525
|
+
|
|
1526
|
+
|Name | Type | Description | Notes|
|
|
1527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1528
|
+
| **payload** | **SelectRequest**| | |
|
|
1529
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
### Return type
|
|
1533
|
+
|
|
1534
|
+
**SuccessResponse**
|
|
1535
|
+
|
|
1536
|
+
### Authorization
|
|
1537
|
+
|
|
1538
|
+
No authorization required
|
|
1539
|
+
|
|
1540
|
+
### HTTP request headers
|
|
1541
|
+
|
|
1542
|
+
- **Content-Type**: application/json
|
|
1543
|
+
- **Accept**: application/json
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
### HTTP response details
|
|
1547
|
+
| Status code | Description | Response headers |
|
|
1548
|
+
|-------------|-------------|------------------|
|
|
1549
|
+
|**200** | Success | - |
|
|
1550
|
+
|
|
1551
|
+
[[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
|
+
|
|
1553
|
+
# **tabs**
|
|
1554
|
+
> SuccessResponse tabs(payload)
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
### Example
|
|
1558
|
+
|
|
1559
|
+
```typescript
|
|
1560
|
+
import {
|
|
1561
|
+
BrowserApi,
|
|
1562
|
+
Configuration,
|
|
1563
|
+
TabsRequest
|
|
1564
|
+
} from 'airbrowser-client';
|
|
1565
|
+
|
|
1566
|
+
const configuration = new Configuration();
|
|
1567
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1568
|
+
|
|
1569
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1570
|
+
let payload: TabsRequest; //
|
|
1571
|
+
|
|
1572
|
+
const { status, data } = await apiInstance.tabs(
|
|
1573
|
+
browserId,
|
|
1574
|
+
payload
|
|
1575
|
+
);
|
|
1576
|
+
```
|
|
1577
|
+
|
|
1578
|
+
### Parameters
|
|
1579
|
+
|
|
1580
|
+
|Name | Type | Description | Notes|
|
|
1581
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1582
|
+
| **payload** | **TabsRequest**| | |
|
|
1583
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
### Return type
|
|
1587
|
+
|
|
1588
|
+
**SuccessResponse**
|
|
1589
|
+
|
|
1590
|
+
### Authorization
|
|
1591
|
+
|
|
1592
|
+
No authorization required
|
|
1593
|
+
|
|
1594
|
+
### HTTP request headers
|
|
1595
|
+
|
|
1596
|
+
- **Content-Type**: application/json
|
|
1597
|
+
- **Accept**: application/json
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
### HTTP response details
|
|
1601
|
+
| Status code | Description | Response headers |
|
|
1602
|
+
|-------------|-------------|------------------|
|
|
1603
|
+
|**200** | Success | - |
|
|
1604
|
+
|
|
1605
|
+
[[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
|
+
|
|
1607
|
+
# **takeScreenshot**
|
|
1608
|
+
> ScreenshotResponse takeScreenshot()
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
### Example
|
|
1612
|
+
|
|
1613
|
+
```typescript
|
|
1614
|
+
import {
|
|
1615
|
+
BrowserApi,
|
|
1616
|
+
Configuration
|
|
1617
|
+
} from 'airbrowser-client';
|
|
1618
|
+
|
|
1619
|
+
const configuration = new Configuration();
|
|
1620
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1621
|
+
|
|
1622
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1623
|
+
|
|
1624
|
+
const { status, data } = await apiInstance.takeScreenshot(
|
|
1625
|
+
browserId
|
|
1626
|
+
);
|
|
1627
|
+
```
|
|
1628
|
+
|
|
1629
|
+
### Parameters
|
|
1630
|
+
|
|
1631
|
+
|Name | Type | Description | Notes|
|
|
1632
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1633
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
### Return type
|
|
1637
|
+
|
|
1638
|
+
**ScreenshotResponse**
|
|
1639
|
+
|
|
1640
|
+
### Authorization
|
|
1641
|
+
|
|
1642
|
+
No authorization required
|
|
1643
|
+
|
|
1644
|
+
### HTTP request headers
|
|
1645
|
+
|
|
1646
|
+
- **Content-Type**: Not defined
|
|
1647
|
+
- **Accept**: application/json
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
### HTTP response details
|
|
1651
|
+
| Status code | Description | Response headers |
|
|
1652
|
+
|-------------|-------------|------------------|
|
|
1653
|
+
|**200** | Success | - |
|
|
1654
|
+
|
|
1655
|
+
[[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
|
+
|
|
1657
|
+
# **takeSnapshot**
|
|
1658
|
+
> SuccessResponse takeSnapshot(payload)
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
### Example
|
|
1662
|
+
|
|
1663
|
+
```typescript
|
|
1664
|
+
import {
|
|
1665
|
+
BrowserApi,
|
|
1666
|
+
Configuration,
|
|
1667
|
+
SnapshotRequest
|
|
1668
|
+
} from 'airbrowser-client';
|
|
1669
|
+
|
|
1670
|
+
const configuration = new Configuration();
|
|
1671
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1672
|
+
|
|
1673
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1674
|
+
let payload: SnapshotRequest; //
|
|
1675
|
+
|
|
1676
|
+
const { status, data } = await apiInstance.takeSnapshot(
|
|
1677
|
+
browserId,
|
|
1678
|
+
payload
|
|
1679
|
+
);
|
|
1680
|
+
```
|
|
1681
|
+
|
|
1682
|
+
### Parameters
|
|
1683
|
+
|
|
1684
|
+
|Name | Type | Description | Notes|
|
|
1685
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1686
|
+
| **payload** | **SnapshotRequest**| | |
|
|
1687
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
### Return type
|
|
1691
|
+
|
|
1692
|
+
**SuccessResponse**
|
|
1693
|
+
|
|
1694
|
+
### Authorization
|
|
1695
|
+
|
|
1696
|
+
No authorization required
|
|
1697
|
+
|
|
1698
|
+
### HTTP request headers
|
|
1699
|
+
|
|
1700
|
+
- **Content-Type**: application/json
|
|
1701
|
+
- **Accept**: application/json
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
### HTTP response details
|
|
1705
|
+
| Status code | Description | Response headers |
|
|
1706
|
+
|-------------|-------------|------------------|
|
|
1707
|
+
|**200** | Success | - |
|
|
1708
|
+
|
|
1709
|
+
[[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
|
+
|
|
1711
|
+
# **typeText**
|
|
1712
|
+
> ActionResult typeText(payload)
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
### Example
|
|
1716
|
+
|
|
1717
|
+
```typescript
|
|
1718
|
+
import {
|
|
1719
|
+
BrowserApi,
|
|
1720
|
+
Configuration,
|
|
1721
|
+
TypeRequest
|
|
1722
|
+
} from 'airbrowser-client';
|
|
1723
|
+
|
|
1724
|
+
const configuration = new Configuration();
|
|
1725
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1726
|
+
|
|
1727
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1728
|
+
let payload: TypeRequest; //
|
|
1729
|
+
|
|
1730
|
+
const { status, data } = await apiInstance.typeText(
|
|
1731
|
+
browserId,
|
|
1732
|
+
payload
|
|
1733
|
+
);
|
|
1734
|
+
```
|
|
1735
|
+
|
|
1736
|
+
### Parameters
|
|
1737
|
+
|
|
1738
|
+
|Name | Type | Description | Notes|
|
|
1739
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1740
|
+
| **payload** | **TypeRequest**| | |
|
|
1741
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
### Return type
|
|
1745
|
+
|
|
1746
|
+
**ActionResult**
|
|
1747
|
+
|
|
1748
|
+
### Authorization
|
|
1749
|
+
|
|
1750
|
+
No authorization required
|
|
1751
|
+
|
|
1752
|
+
### HTTP request headers
|
|
1753
|
+
|
|
1754
|
+
- **Content-Type**: application/json
|
|
1755
|
+
- **Accept**: application/json
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
### HTTP response details
|
|
1759
|
+
| Status code | Description | Response headers |
|
|
1760
|
+
|-------------|-------------|------------------|
|
|
1761
|
+
|**200** | Success | - |
|
|
1762
|
+
|
|
1763
|
+
[[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
|
+
|
|
1765
|
+
# **uploadFile**
|
|
1766
|
+
> SuccessResponse uploadFile(payload)
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
### Example
|
|
1770
|
+
|
|
1771
|
+
```typescript
|
|
1772
|
+
import {
|
|
1773
|
+
BrowserApi,
|
|
1774
|
+
Configuration,
|
|
1775
|
+
UploadFileRequest
|
|
1776
|
+
} from 'airbrowser-client';
|
|
1777
|
+
|
|
1778
|
+
const configuration = new Configuration();
|
|
1779
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1780
|
+
|
|
1781
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1782
|
+
let payload: UploadFileRequest; //
|
|
1783
|
+
|
|
1784
|
+
const { status, data } = await apiInstance.uploadFile(
|
|
1785
|
+
browserId,
|
|
1786
|
+
payload
|
|
1787
|
+
);
|
|
1788
|
+
```
|
|
1789
|
+
|
|
1790
|
+
### Parameters
|
|
1791
|
+
|
|
1792
|
+
|Name | Type | Description | Notes|
|
|
1793
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1794
|
+
| **payload** | **UploadFileRequest**| | |
|
|
1795
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
### Return type
|
|
1799
|
+
|
|
1800
|
+
**SuccessResponse**
|
|
1801
|
+
|
|
1802
|
+
### Authorization
|
|
1803
|
+
|
|
1804
|
+
No authorization required
|
|
1805
|
+
|
|
1806
|
+
### HTTP request headers
|
|
1807
|
+
|
|
1808
|
+
- **Content-Type**: application/json
|
|
1809
|
+
- **Accept**: application/json
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
### HTTP response details
|
|
1813
|
+
| Status code | Description | Response headers |
|
|
1814
|
+
|-------------|-------------|------------------|
|
|
1815
|
+
|**200** | Success | - |
|
|
1816
|
+
|
|
1817
|
+
[[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
|
+
|
|
1819
|
+
# **waitElement**
|
|
1820
|
+
> ActionResult waitElement(payload)
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
### Example
|
|
1824
|
+
|
|
1825
|
+
```typescript
|
|
1826
|
+
import {
|
|
1827
|
+
BrowserApi,
|
|
1828
|
+
Configuration,
|
|
1829
|
+
WaitElementRequest
|
|
1830
|
+
} from 'airbrowser-client';
|
|
1831
|
+
|
|
1832
|
+
const configuration = new Configuration();
|
|
1833
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1834
|
+
|
|
1835
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1836
|
+
let payload: WaitElementRequest; //
|
|
1837
|
+
|
|
1838
|
+
const { status, data } = await apiInstance.waitElement(
|
|
1839
|
+
browserId,
|
|
1840
|
+
payload
|
|
1841
|
+
);
|
|
1842
|
+
```
|
|
1843
|
+
|
|
1844
|
+
### Parameters
|
|
1845
|
+
|
|
1846
|
+
|Name | Type | Description | Notes|
|
|
1847
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1848
|
+
| **payload** | **WaitElementRequest**| | |
|
|
1849
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
### Return type
|
|
1853
|
+
|
|
1854
|
+
**ActionResult**
|
|
1855
|
+
|
|
1856
|
+
### Authorization
|
|
1857
|
+
|
|
1858
|
+
No authorization required
|
|
1859
|
+
|
|
1860
|
+
### HTTP request headers
|
|
1861
|
+
|
|
1862
|
+
- **Content-Type**: application/json
|
|
1863
|
+
- **Accept**: application/json
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
### HTTP response details
|
|
1867
|
+
| Status code | Description | Response headers |
|
|
1868
|
+
|-------------|-------------|------------------|
|
|
1869
|
+
|**200** | Success | - |
|
|
1870
|
+
|
|
1871
|
+
[[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
|
+
|
|
1873
|
+
# **whatIsVisible**
|
|
1874
|
+
> WhatIsVisibleResult whatIsVisible()
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
### Example
|
|
1878
|
+
|
|
1879
|
+
```typescript
|
|
1880
|
+
import {
|
|
1881
|
+
BrowserApi,
|
|
1882
|
+
Configuration
|
|
1883
|
+
} from 'airbrowser-client';
|
|
1884
|
+
|
|
1885
|
+
const configuration = new Configuration();
|
|
1886
|
+
const apiInstance = new BrowserApi(configuration);
|
|
1887
|
+
|
|
1888
|
+
let browserId: string; //Unique browser identifier (default to undefined)
|
|
1889
|
+
|
|
1890
|
+
const { status, data } = await apiInstance.whatIsVisible(
|
|
1891
|
+
browserId
|
|
1892
|
+
);
|
|
1893
|
+
```
|
|
1894
|
+
|
|
1895
|
+
### Parameters
|
|
1896
|
+
|
|
1897
|
+
|Name | Type | Description | Notes|
|
|
1898
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1899
|
+
| **browserId** | [**string**] | Unique browser identifier | defaults to undefined|
|
|
1900
|
+
|
|
1901
|
+
|
|
1902
|
+
### Return type
|
|
1903
|
+
|
|
1904
|
+
**WhatIsVisibleResult**
|
|
1905
|
+
|
|
1906
|
+
### Authorization
|
|
1907
|
+
|
|
1908
|
+
No authorization required
|
|
1909
|
+
|
|
1910
|
+
### HTTP request headers
|
|
1911
|
+
|
|
1912
|
+
- **Content-Type**: Not defined
|
|
1913
|
+
- **Accept**: application/json
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
### HTTP response details
|
|
1917
|
+
| Status code | Description | Response headers |
|
|
1918
|
+
|-------------|-------------|------------------|
|
|
1919
|
+
|**200** | Success | - |
|
|
1920
|
+
|
|
1921
|
+
[[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)
|
|
1922
|
+
|