vefaas-browser-session 0.0.1
veFaaS Browser Session Manager API
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, veFaaS Browser Session Manager API

# vefaas-browser-session
API for managing browser sessions in veFaaS platform

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1
- Package version: 0.0.1
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [http://www.vefaas.com/support](http://www.vefaas.com/support)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import vefaas_browser_session
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import vefaas_browser_session
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import vefaas_browser_session
from vefaas_browser_session.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = vefaas_browser_session.Configuration(
    host = "http://localhost:8000/v1"
)



# Enter a context with an instance of the API client
with vefaas_browser_session.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vefaas_browser_session.BrowsersApi(api_client)
    request = vefaas_browser_session.V1CreateBrowserRequest() # V1CreateBrowserRequest | Browser creation options (optional)

    try:
        # Create a new browser
        api_response = api_instance.create_browser(request=request)
        print("The response of BrowsersApi->create_browser:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BrowsersApi->create_browser: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8000/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BrowsersApi* | [**create_browser**](docs/BrowsersApi.md#create_browser) | **POST** /browsers | Create a new browser
*BrowsersApi* | [**delete_browser**](docs/BrowsersApi.md#delete_browser) | **DELETE** /browsers/{browser_id} | Delete a browser
*BrowsersApi* | [**get_browser**](docs/BrowsersApi.md#get_browser) | **GET** /browsers/{browser_id} | Get a browser by ID
*BrowsersApi* | [**get_browser_json_version**](docs/BrowsersApi.md#get_browser_json_version) | **GET** /browsers/{browser_id}/json/version | Get browser JSON version
*BrowsersApi* | [**list_browsers**](docs/BrowsersApi.md#list_browsers) | **GET** /browsers | List all browsers


## Documentation For Models

 - [BrowserBrowser](docs/BrowserBrowser.md)
 - [BrowserBrowserMeta](docs/BrowserBrowserMeta.md)
 - [BrowserBrowserOptions](docs/BrowserBrowserOptions.md)
 - [V1CreateBrowserRequest](docs/V1CreateBrowserRequest.md)
 - [V1Error](docs/V1Error.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author

support@vefaas.com