airbrowser-client 1.1.8

package/docs/HealthApi.md

@@ -0,0 +1,95 @@
+# HealthApi
+
+All URIs are relative to */api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**healthCheck**](#healthcheck) | **GET** /health/ | Check the health status of the browser pool|
+|[**prometheusMetrics**](#prometheusmetrics) | **GET** /health/metrics | Get Prometheus-style metrics for monitoring|
+
+# **healthCheck**
+> HealthStatus healthCheck()
+
+
+### Example
+
+```typescript
+import {
+    HealthApi,
+    Configuration
+} from 'airbrowser-client';
+
+const configuration = new Configuration();
+const apiInstance = new HealthApi(configuration);
+
+const { status, data } = await apiInstance.healthCheck();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**HealthStatus**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+
+[[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)
+
+# **prometheusMetrics**
+> prometheusMetrics()
+
+
+### Example
+
+```typescript
+import {
+    HealthApi,
+    Configuration
+} from 'airbrowser-client';
+
+const configuration = new Configuration();
+const apiInstance = new HealthApi(configuration);
+
+const { status, data } = await apiInstance.prometheusMetrics();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+
+[[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)
+

package/docs/HealthStatus.md

@@ -0,0 +1,24 @@
+# HealthStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Health status | [optional] [default to undefined]
+**pool** | **object** | Pool status information | [optional] [default to undefined]
+**timestamp** | **number** | Unix timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { HealthStatus } from 'airbrowser-client';
+
+const instance: HealthStatus = {
+    status,
+    pool,
+    timestamp,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/HistoryRequest.md

@@ -0,0 +1,20 @@
+# HistoryRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** | History action: back, forward, or refresh | [default to undefined]
+
+## Example
+
+```typescript
+import { HistoryRequest } from 'airbrowser-client';
+
+const instance: HistoryRequest = {
+    action,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/LogsResponse.md

@@ -0,0 +1,26 @@
+# LogsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** | Operation success | [default to undefined]
+**message** | **string** | Status message | [default to undefined]
+**timestamp** | **number** | Unix timestamp | [default to undefined]
+**data** | **object** | Log entries | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LogsResponse } from 'airbrowser-client';
+
+const instance: LogsResponse = {
+    success,
+    message,
+    timestamp,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MouseRequest.md

@@ -0,0 +1,28 @@
+# MouseRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** | Action: hover or drag | [default to undefined]
+**selector** | **string** | Element selector (for hover) | [optional] [default to undefined]
+**source** | **string** | Source selector (for drag) | [optional] [default to undefined]
+**target** | **string** | Target selector (for drag) | [optional] [default to undefined]
+**by** | **string** | Selector type: css, id, name, xpath | [optional] [default to 'css']
+
+## Example
+
+```typescript
+import { MouseRequest } from 'airbrowser-client';
+
+const instance: MouseRequest = {
+    action,
+    selector,
+    source,
+    target,
+    by,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NavigateRequest.md

@@ -0,0 +1,22 @@
+# NavigateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | URL to navigate to | [default to undefined]
+**timeout** | **number** | Navigation timeout in seconds | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NavigateRequest } from 'airbrowser-client';
+
+const instance: NavigateRequest = {
+    url,
+    timeout,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NetworkLogsRequest.md

@@ -0,0 +1,22 @@
+# NetworkLogsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** | Action: get or clear | [default to undefined]
+**limit** | **number** | Max number of logs to return (for get) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NetworkLogsRequest } from 'airbrowser-client';
+
+const instance: NetworkLogsRequest = {
+    action,
+    limit,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PerformanceRequest.md

@@ -0,0 +1,22 @@
+# PerformanceRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** | Performance action: start_trace, stop_trace, metrics, or analyze | [default to undefined]
+**categories** | **string** | Comma-separated trace categories (for start_trace) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PerformanceRequest } from 'airbrowser-client';
+
+const instance: PerformanceRequest = {
+    action,
+    categories,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PoolApi.md

@@ -0,0 +1,104 @@
+# PoolApi
+
+All URIs are relative to */api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**scalePool**](#scalepool) | **POST** /pool/scale | Scale the browser pool to a new maximum size|
+|[**shutdownServer**](#shutdownserver) | **POST** /pool/shutdown | Gracefully shutdown the browser pool server|
+
+# **scalePool**
+> PoolScaled scalePool(payload)
+
+
+### Example
+
+```typescript
+import {
+    PoolApi,
+    Configuration,
+    ScalePool
+} from 'airbrowser-client';
+
+const configuration = new Configuration();
+const apiInstance = new PoolApi(configuration);
+
+let payload: ScalePool; //
+
+const { status, data } = await apiInstance.scalePool(
+    payload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **payload** | **ScalePool**|  | |
+
+
+### Return type
+
+**PoolScaled**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**400** | Bad request |  -  |
+|**200** | Success |  -  |
+
+[[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)
+
+# **shutdownServer**
+> BaseResponse shutdownServer()
+
+
+### Example
+
+```typescript
+import {
+    PoolApi,
+    Configuration
+} from 'airbrowser-client';
+
+const configuration = new Configuration();
+const apiInstance = new PoolApi(configuration);
+
+const { status, data } = await apiInstance.shutdownServer();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**BaseResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+
+[[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)
+

package/docs/PoolScaled.md

@@ -0,0 +1,26 @@
+# PoolScaled
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** | Operation success | [default to undefined]
+**message** | **string** | Status message | [default to undefined]
+**timestamp** | **number** | Unix timestamp | [default to undefined]
+**data** | [**ScaleData**](ScaleData.md) | Scale result | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PoolScaled } from 'airbrowser-client';
+
+const instance: PoolScaled = {
+    success,
+    message,
+    timestamp,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PoolStatusResponse.md

@@ -0,0 +1,26 @@
+# PoolStatusResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** | Operation success | [default to undefined]
+**message** | **string** | Status message | [default to undefined]
+**timestamp** | **number** | Unix timestamp | [default to undefined]
+**data** | **object** | Pool status information | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PoolStatusResponse } from 'airbrowser-client';
+
+const instance: PoolStatusResponse = {
+    success,
+    message,
+    timestamp,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PressKeysRequest.md

@@ -0,0 +1,24 @@
+# PressKeysRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selector** | **string** | Element selector | [default to undefined]
+**by** | **string** | Selector type: css, id, name, xpath | [optional] [default to 'css']
+**keys** | **string** | Keys to press | [default to undefined]
+
+## Example
+
+```typescript
+import { PressKeysRequest } from 'airbrowser-client';
+
+const instance: PressKeysRequest = {
+    selector,
+    by,
+    keys,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProfileInfo.md

@@ -0,0 +1,28 @@
+# ProfileInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Profile name | [optional] [default to undefined]
+**path** | **string** | Profile storage path | [optional] [default to undefined]
+**size_mb** | **number** | Profile size in MB | [optional] [default to undefined]
+**last_used** | **string** | Last used timestamp (ISO format) | [optional] [default to undefined]
+**in_use** | **boolean** | Whether profile is currently in use by a browser | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProfileInfo } from 'airbrowser-client';
+
+const instance: ProfileInfo = {
+    name,
+    path,
+    size_mb,
+    last_used,
+    in_use,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProfileListData.md

@@ -0,0 +1,20 @@
+# ProfileListData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profiles** | [**Array<ProfileInfo>**](ProfileInfo.md) | List of profiles | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProfileListData } from 'airbrowser-client';
+
+const instance: ProfileListData = {
+    profiles,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProfileListResponse.md

@@ -0,0 +1,26 @@
+# ProfileListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** | Operation success | [optional] [default to undefined]
+**message** | **string** | Status message | [optional] [default to undefined]
+**timestamp** | **number** | Unix timestamp | [optional] [default to undefined]
+**data** | [**ProfileListData**](ProfileListData.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProfileListResponse } from 'airbrowser-client';
+
+const instance: ProfileListResponse = {
+    success,
+    message,
+    timestamp,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProfileResponse.md

@@ -0,0 +1,26 @@
+# ProfileResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** | Operation success | [optional] [default to undefined]
+**message** | **string** | Status message | [optional] [default to undefined]
+**timestamp** | **number** | Unix timestamp | [optional] [default to undefined]
+**data** | [**ProfileInfo**](ProfileInfo.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProfileResponse } from 'airbrowser-client';
+
+const instance: ProfileResponse = {
+    success,
+    message,
+    timestamp,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)