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.
Files changed (94) hide show
  1. package/.openapi-generator/FILES +74 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +165 -0
  5. package/api.ts +4299 -0
  6. package/base.ts +62 -0
  7. package/common.ts +113 -0
  8. package/configuration.ts +121 -0
  9. package/dist/api.d.ts +2543 -0
  10. package/dist/api.js +3260 -0
  11. package/dist/base.d.ts +42 -0
  12. package/dist/base.js +46 -0
  13. package/dist/common.d.ts +28 -0
  14. package/dist/common.js +124 -0
  15. package/dist/configuration.d.ts +98 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +2543 -0
  18. package/dist/esm/api.js +3241 -0
  19. package/dist/esm/base.d.ts +42 -0
  20. package/dist/esm/base.js +41 -0
  21. package/dist/esm/common.d.ts +28 -0
  22. package/dist/esm/common.js +112 -0
  23. package/dist/esm/configuration.d.ts +98 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +13 -0
  26. package/dist/esm/index.js +15 -0
  27. package/dist/index.d.ts +13 -0
  28. package/dist/index.js +31 -0
  29. package/docs/ActionResult.md +26 -0
  30. package/docs/AttributeResponse.md +26 -0
  31. package/docs/BaseResponse.md +24 -0
  32. package/docs/BrowserApi.md +1922 -0
  33. package/docs/BrowserConfig.md +36 -0
  34. package/docs/BrowserCreated.md +26 -0
  35. package/docs/BrowserCreationData.md +22 -0
  36. package/docs/BrowserInfoResponse.md +26 -0
  37. package/docs/BrowserList.md +26 -0
  38. package/docs/BrowserListData.md +22 -0
  39. package/docs/CheckElementRequest.md +24 -0
  40. package/docs/ClickRequest.md +26 -0
  41. package/docs/CombinedDialogRequest.md +22 -0
  42. package/docs/CombinedEmulateRequest.md +32 -0
  43. package/docs/CombinedGuiClickRequest.md +30 -0
  44. package/docs/CombinedScrollRequest.md +32 -0
  45. package/docs/ConsoleLogsRequest.md +22 -0
  46. package/docs/ContentData.md +24 -0
  47. package/docs/ContentResponse.md +26 -0
  48. package/docs/CreateProfileRequest.md +20 -0
  49. package/docs/DetectCoordinatesRequest.md +20 -0
  50. package/docs/DetectCoordinatesResult.md +44 -0
  51. package/docs/ElementDataRequest.md +26 -0
  52. package/docs/ErrorResponse.md +24 -0
  53. package/docs/ExecuteData.md +20 -0
  54. package/docs/ExecuteRequest.md +22 -0
  55. package/docs/ExecuteResponse.md +26 -0
  56. package/docs/FillFormRequest.md +22 -0
  57. package/docs/FormField.md +22 -0
  58. package/docs/HealthApi.md +95 -0
  59. package/docs/HealthStatus.md +24 -0
  60. package/docs/HistoryRequest.md +20 -0
  61. package/docs/LogsResponse.md +26 -0
  62. package/docs/MouseRequest.md +28 -0
  63. package/docs/NavigateRequest.md +22 -0
  64. package/docs/NetworkLogsRequest.md +22 -0
  65. package/docs/PerformanceRequest.md +22 -0
  66. package/docs/PoolApi.md +104 -0
  67. package/docs/PoolScaled.md +26 -0
  68. package/docs/PoolStatusResponse.md +26 -0
  69. package/docs/PressKeysRequest.md +24 -0
  70. package/docs/ProfileInfo.md +28 -0
  71. package/docs/ProfileListData.md +20 -0
  72. package/docs/ProfileListResponse.md +26 -0
  73. package/docs/ProfileResponse.md +26 -0
  74. package/docs/ProfilesApi.md +209 -0
  75. package/docs/ResizeRequest.md +22 -0
  76. package/docs/ScaleData.md +20 -0
  77. package/docs/ScalePool.md +20 -0
  78. package/docs/ScreenshotData.md +22 -0
  79. package/docs/ScreenshotResponse.md +26 -0
  80. package/docs/SelectRequest.md +30 -0
  81. package/docs/SnapshotRequest.md +20 -0
  82. package/docs/SuccessResponse.md +26 -0
  83. package/docs/TabsRequest.md +26 -0
  84. package/docs/TypeRequest.md +26 -0
  85. package/docs/UploadFileRequest.md +24 -0
  86. package/docs/UrlData.md +20 -0
  87. package/docs/UrlResponse.md +26 -0
  88. package/docs/WaitElementRequest.md +26 -0
  89. package/docs/WhatIsVisibleResult.md +34 -0
  90. package/git_push.sh +57 -0
  91. package/index.ts +18 -0
  92. package/package.json +33 -0
  93. package/tsconfig.esm.json +7 -0
  94. package/tsconfig.json +18 -0
@@ -0,0 +1,74 @@
1
+ .gitignore
2
+ .npmignore
3
+ .openapi-generator-ignore
4
+ README.md
5
+ api.ts
6
+ base.ts
7
+ common.ts
8
+ configuration.ts
9
+ docs/ActionResult.md
10
+ docs/AttributeResponse.md
11
+ docs/BaseResponse.md
12
+ docs/BrowserApi.md
13
+ docs/BrowserConfig.md
14
+ docs/BrowserCreated.md
15
+ docs/BrowserCreationData.md
16
+ docs/BrowserInfoResponse.md
17
+ docs/BrowserList.md
18
+ docs/BrowserListData.md
19
+ docs/CheckElementRequest.md
20
+ docs/ClickRequest.md
21
+ docs/CombinedDialogRequest.md
22
+ docs/CombinedEmulateRequest.md
23
+ docs/CombinedGuiClickRequest.md
24
+ docs/CombinedScrollRequest.md
25
+ docs/ConsoleLogsRequest.md
26
+ docs/ContentData.md
27
+ docs/ContentResponse.md
28
+ docs/CreateProfileRequest.md
29
+ docs/DetectCoordinatesRequest.md
30
+ docs/DetectCoordinatesResult.md
31
+ docs/ElementDataRequest.md
32
+ docs/ErrorResponse.md
33
+ docs/ExecuteData.md
34
+ docs/ExecuteRequest.md
35
+ docs/ExecuteResponse.md
36
+ docs/FillFormRequest.md
37
+ docs/FormField.md
38
+ docs/HealthApi.md
39
+ docs/HealthStatus.md
40
+ docs/HistoryRequest.md
41
+ docs/LogsResponse.md
42
+ docs/MouseRequest.md
43
+ docs/NavigateRequest.md
44
+ docs/NetworkLogsRequest.md
45
+ docs/PerformanceRequest.md
46
+ docs/PoolApi.md
47
+ docs/PoolScaled.md
48
+ docs/PoolStatusResponse.md
49
+ docs/PressKeysRequest.md
50
+ docs/ProfileInfo.md
51
+ docs/ProfileListData.md
52
+ docs/ProfileListResponse.md
53
+ docs/ProfileResponse.md
54
+ docs/ProfilesApi.md
55
+ docs/ResizeRequest.md
56
+ docs/ScaleData.md
57
+ docs/ScalePool.md
58
+ docs/ScreenshotData.md
59
+ docs/ScreenshotResponse.md
60
+ docs/SelectRequest.md
61
+ docs/SnapshotRequest.md
62
+ docs/SuccessResponse.md
63
+ docs/TabsRequest.md
64
+ docs/TypeRequest.md
65
+ docs/UploadFileRequest.md
66
+ docs/UrlData.md
67
+ docs/UrlResponse.md
68
+ docs/WaitElementRequest.md
69
+ docs/WhatIsVisibleResult.md
70
+ git_push.sh
71
+ index.ts
72
+ package.json
73
+ tsconfig.esm.json
74
+ tsconfig.json
@@ -0,0 +1 @@
1
+ 7.19.0-SNAPSHOT
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
package/README.md ADDED
@@ -0,0 +1,165 @@
1
+ ## airbrowser-client@1.1.8
2
+
3
+ This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
+
5
+ Environment
6
+ * Node.js
7
+ * Webpack
8
+ * Browserify
9
+
10
+ Language level
11
+ * ES5 - you must have a Promises/A+ library installed
12
+ * ES6
13
+
14
+ Module system
15
+ * CommonJS
16
+ * ES6 module system
17
+
18
+ It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
19
+
20
+ ### Building
21
+
22
+ To build and compile the typescript sources to javascript use:
23
+ ```
24
+ npm install
25
+ npm run build
26
+ ```
27
+
28
+ ### Publishing
29
+
30
+ First build the package then run `npm publish`
31
+
32
+ ### Consuming
33
+
34
+ navigate to the folder of your consuming project and run one of the following commands.
35
+
36
+ _published:_
37
+
38
+ ```
39
+ npm install airbrowser-client@1.1.8 --save
40
+ ```
41
+
42
+ _unPublished (not recommended):_
43
+
44
+ ```
45
+ npm install PATH_TO_GENERATED_PACKAGE --save
46
+ ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to */api/v1*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *BrowserApi* | [**checkElement**](docs/BrowserApi.md#checkelement) | **POST** /browser/{browser_id}/check_element | Check if element exists or is visible
55
+ *BrowserApi* | [**click**](docs/BrowserApi.md#click) | **POST** /browser/{browser_id}/click | Click element
56
+ *BrowserApi* | [**closeAllBrowsers**](docs/BrowserApi.md#closeallbrowsers) | **POST** /browser/close_all | Close all active browser instances
57
+ *BrowserApi* | [**closeBrowser**](docs/BrowserApi.md#closebrowser) | **POST** /browser/{browser_id}/close | Close a browser instance
58
+ *BrowserApi* | [**consoleLogs**](docs/BrowserApi.md#consolelogs) | **POST** /browser/{browser_id}/console | Get or clear console logs
59
+ *BrowserApi* | [**createBrowser**](docs/BrowserApi.md#createbrowser) | **POST** /browser/create | Create a new browser instance
60
+ *BrowserApi* | [**deleteBrowser**](docs/BrowserApi.md#deletebrowser) | **DELETE** /browser/{browser_id} | Close and remove a browser instance
61
+ *BrowserApi* | [**detectCoordinates**](docs/BrowserApi.md#detectcoordinates) | **POST** /browser/{browser_id}/detect_coordinates | Detect element coordinates using AI vision
62
+ *BrowserApi* | [**dialog**](docs/BrowserApi.md#dialog) | **POST** /browser/{browser_id}/dialog | Manage browser dialogs: get, accept, or dismiss
63
+ *BrowserApi* | [**emulate**](docs/BrowserApi.md#emulate) | **POST** /browser/{browser_id}/emulate | Manage device emulation: set, clear, or list_devices
64
+ *BrowserApi* | [**executeScript**](docs/BrowserApi.md#executescript) | **POST** /browser/{browser_id}/execute | Execute JavaScript
65
+ *BrowserApi* | [**fillForm**](docs/BrowserApi.md#fillform) | **POST** /browser/{browser_id}/fill_form | Fill multiple form fields
66
+ *BrowserApi* | [**getBrowser**](docs/BrowserApi.md#getbrowser) | **GET** /browser/{browser_id} | Get browser instance details
67
+ *BrowserApi* | [**getBrowserStatus**](docs/BrowserApi.md#getbrowserstatus) | **GET** /browser/{browser_id}/status | Get browser status
68
+ *BrowserApi* | [**getContent**](docs/BrowserApi.md#getcontent) | **GET** /browser/{browser_id}/content | Get page HTML content
69
+ *BrowserApi* | [**getElementData**](docs/BrowserApi.md#getelementdata) | **POST** /browser/{browser_id}/element_data | Get element text, attribute, or property
70
+ *BrowserApi* | [**getPoolStatus**](docs/BrowserApi.md#getpoolstatus) | **GET** /browser/pool/status | Get browser pool status
71
+ *BrowserApi* | [**getUrl**](docs/BrowserApi.md#geturl) | **GET** /browser/{browser_id}/url | Get current page URL
72
+ *BrowserApi* | [**guiClick**](docs/BrowserApi.md#guiclick) | **POST** /browser/{browser_id}/gui_click | Click using selector or screen coordinates
73
+ *BrowserApi* | [**history**](docs/BrowserApi.md#history) | **POST** /browser/{browser_id}/history | Execute history action: back, forward, or refresh
74
+ *BrowserApi* | [**listBrowsers**](docs/BrowserApi.md#listbrowsers) | **GET** /browser/list | List all active browser instances
75
+ *BrowserApi* | [**mouse**](docs/BrowserApi.md#mouse) | **POST** /browser/{browser_id}/mouse | Mouse action: hover or drag
76
+ *BrowserApi* | [**navigateBrowser**](docs/BrowserApi.md#navigatebrowser) | **POST** /browser/{browser_id}/navigate | Navigate to a URL
77
+ *BrowserApi* | [**networkLogs**](docs/BrowserApi.md#networklogs) | **POST** /browser/{browser_id}/network | Get or clear network logs
78
+ *BrowserApi* | [**performance**](docs/BrowserApi.md#performance) | **POST** /browser/{browser_id}/performance | Manage performance: start_trace, stop_trace, metrics, or analyze
79
+ *BrowserApi* | [**pressKeys**](docs/BrowserApi.md#presskeys) | **POST** /browser/{browser_id}/press_keys | Press keys on an element
80
+ *BrowserApi* | [**resize**](docs/BrowserApi.md#resize) | **POST** /browser/{browser_id}/resize | Resize viewport
81
+ *BrowserApi* | [**scroll**](docs/BrowserApi.md#scroll) | **POST** /browser/{browser_id}/scroll | Scroll to element/coordinates (absolute) or by delta (relative)
82
+ *BrowserApi* | [**select**](docs/BrowserApi.md#select) | **POST** /browser/{browser_id}/select | Select dropdown: select option or get options
83
+ *BrowserApi* | [**tabs**](docs/BrowserApi.md#tabs) | **POST** /browser/{browser_id}/tabs | Manage browser tabs: list, new, switch, close, or current
84
+ *BrowserApi* | [**takeScreenshot**](docs/BrowserApi.md#takescreenshot) | **POST** /browser/{browser_id}/screenshot | Take a screenshot
85
+ *BrowserApi* | [**takeSnapshot**](docs/BrowserApi.md#takesnapshot) | **POST** /browser/{browser_id}/snapshot | Take DOM/accessibility snapshot
86
+ *BrowserApi* | [**typeText**](docs/BrowserApi.md#typetext) | **POST** /browser/{browser_id}/type | Type text into an element
87
+ *BrowserApi* | [**uploadFile**](docs/BrowserApi.md#uploadfile) | **POST** /browser/{browser_id}/upload_file | Upload a file
88
+ *BrowserApi* | [**waitElement**](docs/BrowserApi.md#waitelement) | **POST** /browser/{browser_id}/wait_element | Wait for element to become visible or hidden
89
+ *BrowserApi* | [**whatIsVisible**](docs/BrowserApi.md#whatisvisible) | **GET** /browser/{browser_id}/what_is_visible | Analyze visible page content using AI
90
+ *HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health/ | Check the health status of the browser pool
91
+ *HealthApi* | [**prometheusMetrics**](docs/HealthApi.md#prometheusmetrics) | **GET** /health/metrics | Get Prometheus-style metrics for monitoring
92
+ *PoolApi* | [**scalePool**](docs/PoolApi.md#scalepool) | **POST** /pool/scale | Scale the browser pool to a new maximum size
93
+ *PoolApi* | [**shutdownServer**](docs/PoolApi.md#shutdownserver) | **POST** /pool/shutdown | Gracefully shutdown the browser pool server
94
+ *ProfilesApi* | [**createProfile**](docs/ProfilesApi.md#createprofile) | **POST** /profiles/ | Create a new browser profile
95
+ *ProfilesApi* | [**deleteProfile**](docs/ProfilesApi.md#deleteprofile) | **DELETE** /profiles/{profile_name} | Delete a browser profile
96
+ *ProfilesApi* | [**getProfile**](docs/ProfilesApi.md#getprofile) | **GET** /profiles/{profile_name} | Get profile information
97
+ *ProfilesApi* | [**listProfiles**](docs/ProfilesApi.md#listprofiles) | **GET** /profiles/ | List all browser profiles
98
+
99
+
100
+ ### Documentation For Models
101
+
102
+ - [ActionResult](docs/ActionResult.md)
103
+ - [AttributeResponse](docs/AttributeResponse.md)
104
+ - [BaseResponse](docs/BaseResponse.md)
105
+ - [BrowserConfig](docs/BrowserConfig.md)
106
+ - [BrowserCreated](docs/BrowserCreated.md)
107
+ - [BrowserCreationData](docs/BrowserCreationData.md)
108
+ - [BrowserInfoResponse](docs/BrowserInfoResponse.md)
109
+ - [BrowserList](docs/BrowserList.md)
110
+ - [BrowserListData](docs/BrowserListData.md)
111
+ - [CheckElementRequest](docs/CheckElementRequest.md)
112
+ - [ClickRequest](docs/ClickRequest.md)
113
+ - [CombinedDialogRequest](docs/CombinedDialogRequest.md)
114
+ - [CombinedEmulateRequest](docs/CombinedEmulateRequest.md)
115
+ - [CombinedGuiClickRequest](docs/CombinedGuiClickRequest.md)
116
+ - [CombinedScrollRequest](docs/CombinedScrollRequest.md)
117
+ - [ConsoleLogsRequest](docs/ConsoleLogsRequest.md)
118
+ - [ContentData](docs/ContentData.md)
119
+ - [ContentResponse](docs/ContentResponse.md)
120
+ - [CreateProfileRequest](docs/CreateProfileRequest.md)
121
+ - [DetectCoordinatesRequest](docs/DetectCoordinatesRequest.md)
122
+ - [DetectCoordinatesResult](docs/DetectCoordinatesResult.md)
123
+ - [ElementDataRequest](docs/ElementDataRequest.md)
124
+ - [ErrorResponse](docs/ErrorResponse.md)
125
+ - [ExecuteData](docs/ExecuteData.md)
126
+ - [ExecuteRequest](docs/ExecuteRequest.md)
127
+ - [ExecuteResponse](docs/ExecuteResponse.md)
128
+ - [FillFormRequest](docs/FillFormRequest.md)
129
+ - [FormField](docs/FormField.md)
130
+ - [HealthStatus](docs/HealthStatus.md)
131
+ - [HistoryRequest](docs/HistoryRequest.md)
132
+ - [LogsResponse](docs/LogsResponse.md)
133
+ - [MouseRequest](docs/MouseRequest.md)
134
+ - [NavigateRequest](docs/NavigateRequest.md)
135
+ - [NetworkLogsRequest](docs/NetworkLogsRequest.md)
136
+ - [PerformanceRequest](docs/PerformanceRequest.md)
137
+ - [PoolScaled](docs/PoolScaled.md)
138
+ - [PoolStatusResponse](docs/PoolStatusResponse.md)
139
+ - [PressKeysRequest](docs/PressKeysRequest.md)
140
+ - [ProfileInfo](docs/ProfileInfo.md)
141
+ - [ProfileListData](docs/ProfileListData.md)
142
+ - [ProfileListResponse](docs/ProfileListResponse.md)
143
+ - [ProfileResponse](docs/ProfileResponse.md)
144
+ - [ResizeRequest](docs/ResizeRequest.md)
145
+ - [ScaleData](docs/ScaleData.md)
146
+ - [ScalePool](docs/ScalePool.md)
147
+ - [ScreenshotData](docs/ScreenshotData.md)
148
+ - [ScreenshotResponse](docs/ScreenshotResponse.md)
149
+ - [SelectRequest](docs/SelectRequest.md)
150
+ - [SnapshotRequest](docs/SnapshotRequest.md)
151
+ - [SuccessResponse](docs/SuccessResponse.md)
152
+ - [TabsRequest](docs/TabsRequest.md)
153
+ - [TypeRequest](docs/TypeRequest.md)
154
+ - [UploadFileRequest](docs/UploadFileRequest.md)
155
+ - [UrlData](docs/UrlData.md)
156
+ - [UrlResponse](docs/UrlResponse.md)
157
+ - [WaitElementRequest](docs/WaitElementRequest.md)
158
+ - [WhatIsVisibleResult](docs/WhatIsVisibleResult.md)
159
+
160
+
161
+ <a id="documentation-for-authorization"></a>
162
+ ## Documentation For Authorization
163
+
164
+ Endpoints do not require authorization.
165
+