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,36 @@
|
|
|
1
|
+
# BrowserConfig
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**profile_name** | **string** | Profile name for persistent data. Omit for fresh session. | [optional] [default to undefined]
|
|
9
|
+
**proxy** | **string** | Proxy server URL | [optional] [default to undefined]
|
|
10
|
+
**user_agent** | **string** | Custom user agent string | [optional] [default to undefined]
|
|
11
|
+
**window_size** | **Array<number>** | Browser window size [width, height] | [optional] [default to undefined]
|
|
12
|
+
**disable_gpu** | **boolean** | Disable GPU acceleration | [optional] [default to false]
|
|
13
|
+
**disable_images** | **boolean** | Disable image loading | [optional] [default to false]
|
|
14
|
+
**disable_javascript** | **boolean** | Disable JavaScript | [optional] [default to false]
|
|
15
|
+
**extensions** | **Array<string>** | Chrome extension paths | [optional] [default to undefined]
|
|
16
|
+
**custom_args** | **Array<string>** | Custom Chrome arguments | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { BrowserConfig } from 'airbrowser-client';
|
|
22
|
+
|
|
23
|
+
const instance: BrowserConfig = {
|
|
24
|
+
profile_name,
|
|
25
|
+
proxy,
|
|
26
|
+
user_agent,
|
|
27
|
+
window_size,
|
|
28
|
+
disable_gpu,
|
|
29
|
+
disable_images,
|
|
30
|
+
disable_javascript,
|
|
31
|
+
extensions,
|
|
32
|
+
custom_args,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BrowserCreated
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**success** | **boolean** | Operation success | [default to undefined]
|
|
9
|
+
**message** | **string** | Status message | [default to undefined]
|
|
10
|
+
**timestamp** | **number** | Unix timestamp | [default to undefined]
|
|
11
|
+
**data** | [**BrowserCreationData**](BrowserCreationData.md) | Browser creation data | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { BrowserCreated } from 'airbrowser-client';
|
|
17
|
+
|
|
18
|
+
const instance: BrowserCreated = {
|
|
19
|
+
success,
|
|
20
|
+
message,
|
|
21
|
+
timestamp,
|
|
22
|
+
data,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BrowserCreationData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**browser_id** | **string** | Unique browser identifier | [default to undefined]
|
|
9
|
+
**config** | **object** | Browser configuration used | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BrowserCreationData } from 'airbrowser-client';
|
|
15
|
+
|
|
16
|
+
const instance: BrowserCreationData = {
|
|
17
|
+
browser_id,
|
|
18
|
+
config,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BrowserInfoResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**success** | **boolean** | Operation success | [default to undefined]
|
|
9
|
+
**message** | **string** | Status message | [default to undefined]
|
|
10
|
+
**timestamp** | **number** | Unix timestamp | [default to undefined]
|
|
11
|
+
**data** | **object** | Browser information | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { BrowserInfoResponse } from 'airbrowser-client';
|
|
17
|
+
|
|
18
|
+
const instance: BrowserInfoResponse = {
|
|
19
|
+
success,
|
|
20
|
+
message,
|
|
21
|
+
timestamp,
|
|
22
|
+
data,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BrowserList
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**success** | **boolean** | Operation success | [default to undefined]
|
|
9
|
+
**message** | **string** | Status message | [default to undefined]
|
|
10
|
+
**timestamp** | **number** | Unix timestamp | [default to undefined]
|
|
11
|
+
**data** | [**BrowserListData**](BrowserListData.md) | Browser list data | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { BrowserList } from 'airbrowser-client';
|
|
17
|
+
|
|
18
|
+
const instance: BrowserList = {
|
|
19
|
+
success,
|
|
20
|
+
message,
|
|
21
|
+
timestamp,
|
|
22
|
+
data,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BrowserListData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**browsers** | **Array<object>** | List of active browsers | [optional] [default to undefined]
|
|
9
|
+
**count** | **number** | Total browser count | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BrowserListData } from 'airbrowser-client';
|
|
15
|
+
|
|
16
|
+
const instance: BrowserListData = {
|
|
17
|
+
browsers,
|
|
18
|
+
count,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CheckElementRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**selector** | **string** | Element selector | [default to undefined]
|
|
9
|
+
**by** | **string** | Selector type (css, id, name, xpath) | [optional] [default to 'css']
|
|
10
|
+
**check** | **string** | Check type: exists or visible | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CheckElementRequest } from 'airbrowser-client';
|
|
16
|
+
|
|
17
|
+
const instance: CheckElementRequest = {
|
|
18
|
+
selector,
|
|
19
|
+
by,
|
|
20
|
+
check,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ClickRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**selector** | **string** | Element selector | [default to undefined]
|
|
9
|
+
**by** | **string** | Selector type: css, id, name, xpath | [optional] [default to 'css']
|
|
10
|
+
**timeout** | **number** | Timeout in seconds | [optional] [default to undefined]
|
|
11
|
+
**if_visible** | **boolean** | Only click if element is visible | [optional] [default to false]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ClickRequest } from 'airbrowser-client';
|
|
17
|
+
|
|
18
|
+
const instance: ClickRequest = {
|
|
19
|
+
selector,
|
|
20
|
+
by,
|
|
21
|
+
timeout,
|
|
22
|
+
if_visible,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CombinedDialogRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**action** | **string** | Dialog action: get, accept, or dismiss | [default to undefined]
|
|
9
|
+
**text** | **string** | Text to enter for prompt dialogs (for \'accept\' action) | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CombinedDialogRequest } from 'airbrowser-client';
|
|
15
|
+
|
|
16
|
+
const instance: CombinedDialogRequest = {
|
|
17
|
+
action,
|
|
18
|
+
text,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# CombinedEmulateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**action** | **string** | Emulation action: set, clear, or list_devices | [optional] [default to ActionEnum_Set]
|
|
9
|
+
**device** | **string** | Device preset name (e.g., iPhone 14, iPad) | [optional] [default to undefined]
|
|
10
|
+
**width** | **number** | Custom viewport width | [optional] [default to undefined]
|
|
11
|
+
**height** | **number** | Custom viewport height | [optional] [default to undefined]
|
|
12
|
+
**device_scale_factor** | **number** | Device pixel ratio | [optional] [default to undefined]
|
|
13
|
+
**mobile** | **boolean** | Enable touch events | [optional] [default to undefined]
|
|
14
|
+
**user_agent** | **string** | Custom user agent | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { CombinedEmulateRequest } from 'airbrowser-client';
|
|
20
|
+
|
|
21
|
+
const instance: CombinedEmulateRequest = {
|
|
22
|
+
action,
|
|
23
|
+
device,
|
|
24
|
+
width,
|
|
25
|
+
height,
|
|
26
|
+
device_scale_factor,
|
|
27
|
+
mobile,
|
|
28
|
+
user_agent,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# CombinedGuiClickRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**selector** | **string** | Element selector (for selector mode) | [optional] [default to undefined]
|
|
9
|
+
**x** | **number** | Screen X coordinate (for coordinate mode) | [optional] [default to undefined]
|
|
10
|
+
**y** | **number** | Screen Y coordinate (for coordinate mode) | [optional] [default to undefined]
|
|
11
|
+
**timeframe** | **number** | Mouse move duration (seconds) | [optional] [default to undefined]
|
|
12
|
+
**fx** | **number** | Relative X (0..1) within element to click | [optional] [default to undefined]
|
|
13
|
+
**fy** | **number** | Relative Y (0..1) within element to click | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { CombinedGuiClickRequest } from 'airbrowser-client';
|
|
19
|
+
|
|
20
|
+
const instance: CombinedGuiClickRequest = {
|
|
21
|
+
selector,
|
|
22
|
+
x,
|
|
23
|
+
y,
|
|
24
|
+
timeframe,
|
|
25
|
+
fx,
|
|
26
|
+
fy,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# CombinedScrollRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**selector** | **string** | Element selector to scroll to | [optional] [default to undefined]
|
|
9
|
+
**by** | **string** | Selector type (css, id, name, xpath) | [optional] [default to 'css']
|
|
10
|
+
**x** | **number** | X coordinate to scroll to (absolute) | [optional] [default to undefined]
|
|
11
|
+
**y** | **number** | Y coordinate to scroll to (absolute) | [optional] [default to undefined]
|
|
12
|
+
**delta_x** | **number** | Horizontal scroll amount (relative) | [optional] [default to undefined]
|
|
13
|
+
**delta_y** | **number** | Vertical scroll amount (relative) | [optional] [default to undefined]
|
|
14
|
+
**behavior** | **string** | Scroll behavior: smooth or instant | [optional] [default to 'smooth']
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { CombinedScrollRequest } from 'airbrowser-client';
|
|
20
|
+
|
|
21
|
+
const instance: CombinedScrollRequest = {
|
|
22
|
+
selector,
|
|
23
|
+
by,
|
|
24
|
+
x,
|
|
25
|
+
y,
|
|
26
|
+
delta_x,
|
|
27
|
+
delta_y,
|
|
28
|
+
behavior,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ConsoleLogsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**action** | **string** | Action: get or clear | [default to undefined]
|
|
9
|
+
**limit** | **number** | Max number of logs to return (for get) | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ConsoleLogsRequest } from 'airbrowser-client';
|
|
15
|
+
|
|
16
|
+
const instance: ConsoleLogsRequest = {
|
|
17
|
+
action,
|
|
18
|
+
limit,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ContentData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**html** | **string** | Page HTML content | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | Page title | [optional] [default to undefined]
|
|
10
|
+
**url** | **string** | Current URL | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ContentData } from 'airbrowser-client';
|
|
16
|
+
|
|
17
|
+
const instance: ContentData = {
|
|
18
|
+
html,
|
|
19
|
+
title,
|
|
20
|
+
url,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ContentResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**success** | **boolean** | Operation success | [default to undefined]
|
|
9
|
+
**message** | **string** | Status message | [default to undefined]
|
|
10
|
+
**timestamp** | **number** | Unix timestamp | [default to undefined]
|
|
11
|
+
**data** | [**ContentData**](ContentData.md) | Page content data | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ContentResponse } from 'airbrowser-client';
|
|
17
|
+
|
|
18
|
+
const instance: ContentResponse = {
|
|
19
|
+
success,
|
|
20
|
+
message,
|
|
21
|
+
timestamp,
|
|
22
|
+
data,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CreateProfileRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Profile name | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { CreateProfileRequest } from 'airbrowser-client';
|
|
14
|
+
|
|
15
|
+
const instance: CreateProfileRequest = {
|
|
16
|
+
name,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DetectCoordinatesRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**prompt** | **string** | Natural language description of element to find | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { DetectCoordinatesRequest } from 'airbrowser-client';
|
|
14
|
+
|
|
15
|
+
const instance: DetectCoordinatesRequest = {
|
|
16
|
+
prompt,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# DetectCoordinatesResult
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**success** | **boolean** | Operation success | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | Success message | [optional] [default to undefined]
|
|
10
|
+
**timestamp** | **number** | Unix timestamp | [optional] [default to undefined]
|
|
11
|
+
**prompt** | **string** | Element description used | [optional] [default to undefined]
|
|
12
|
+
**coordinates** | **object** | Full coordinate information | [optional] [default to undefined]
|
|
13
|
+
**bounding_box** | **object** | Element bounding box {x, y, width, height} | [optional] [default to undefined]
|
|
14
|
+
**click_point** | **object** | Recommended click point {x, y} | [optional] [default to undefined]
|
|
15
|
+
**screenshot_path** | **string** | Path to screenshot analyzed | [optional] [default to undefined]
|
|
16
|
+
**model_used** | **string** | Vision model used for detection | [optional] [default to undefined]
|
|
17
|
+
**confidence** | **number** | Detection confidence (0.0-1.0) | [optional] [default to undefined]
|
|
18
|
+
**models_tried** | **Array<string>** | Models attempted if detection failed | [optional] [default to undefined]
|
|
19
|
+
**data** | **object** | Additional result data | [optional] [default to undefined]
|
|
20
|
+
**error** | **string** | Error message if failed | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { DetectCoordinatesResult } from 'airbrowser-client';
|
|
26
|
+
|
|
27
|
+
const instance: DetectCoordinatesResult = {
|
|
28
|
+
success,
|
|
29
|
+
message,
|
|
30
|
+
timestamp,
|
|
31
|
+
prompt,
|
|
32
|
+
coordinates,
|
|
33
|
+
bounding_box,
|
|
34
|
+
click_point,
|
|
35
|
+
screenshot_path,
|
|
36
|
+
model_used,
|
|
37
|
+
confidence,
|
|
38
|
+
models_tried,
|
|
39
|
+
data,
|
|
40
|
+
error,
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ElementDataRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**selector** | **string** | Element selector | [default to undefined]
|
|
9
|
+
**by** | **string** | Selector type (css, id, name, xpath) | [optional] [default to 'css']
|
|
10
|
+
**type** | **string** | Data type: text, attribute, or property | [default to undefined]
|
|
11
|
+
**name** | **string** | Attribute/property name (required for attribute/property) | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ElementDataRequest } from 'airbrowser-client';
|
|
17
|
+
|
|
18
|
+
const instance: ElementDataRequest = {
|
|
19
|
+
selector,
|
|
20
|
+
by,
|
|
21
|
+
type,
|
|
22
|
+
name,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ErrorResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**success** | **boolean** | Operation success (false) | [optional] [default to false]
|
|
9
|
+
**message** | **string** | Error message | [optional] [default to undefined]
|
|
10
|
+
**timestamp** | **number** | Unix timestamp | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ErrorResponse } from 'airbrowser-client';
|
|
16
|
+
|
|
17
|
+
const instance: ErrorResponse = {
|
|
18
|
+
success,
|
|
19
|
+
message,
|
|
20
|
+
timestamp,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ExecuteData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**result** | **object** | Script execution result | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ExecuteData } from 'airbrowser-client';
|
|
14
|
+
|
|
15
|
+
const instance: ExecuteData = {
|
|
16
|
+
result,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ExecuteRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**script** | **string** | JavaScript code to execute | [default to undefined]
|
|
9
|
+
**timeout** | **number** | Timeout in seconds | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ExecuteRequest } from 'airbrowser-client';
|
|
15
|
+
|
|
16
|
+
const instance: ExecuteRequest = {
|
|
17
|
+
script,
|
|
18
|
+
timeout,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ExecuteResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**success** | **boolean** | Operation success | [default to undefined]
|
|
9
|
+
**message** | **string** | Status message | [default to undefined]
|
|
10
|
+
**timestamp** | **number** | Unix timestamp | [default to undefined]
|
|
11
|
+
**data** | [**ExecuteData**](ExecuteData.md) | Execution result | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ExecuteResponse } from 'airbrowser-client';
|
|
17
|
+
|
|
18
|
+
const instance: ExecuteResponse = {
|
|
19
|
+
success,
|
|
20
|
+
message,
|
|
21
|
+
timestamp,
|
|
22
|
+
data,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FillFormRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fields** | [**Array<FormField>**](FormField.md) | Fields to fill | [default to undefined]
|
|
9
|
+
**by** | **string** | Selector type (css, id, name, xpath) | [optional] [default to 'css']
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { FillFormRequest } from 'airbrowser-client';
|
|
15
|
+
|
|
16
|
+
const instance: FillFormRequest = {
|
|
17
|
+
fields,
|
|
18
|
+
by,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FormField
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**selector** | **string** | Field selector | [default to undefined]
|
|
9
|
+
**value** | **string** | Value to fill | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { FormField } from 'airbrowser-client';
|
|
15
|
+
|
|
16
|
+
const instance: FormField = {
|
|
17
|
+
selector,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|