https://github.com/qualityunit/liveagent-internal-api-python-client
https://github.com/qualityunit/liveagent-internal-api-python-client
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/qualityunit/liveagent-internal-api-python-client
- Owner: QualityUnit
- Created: 2023-05-16T11:00:15.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T20:50:55.000Z (about 2 years ago)
- Last Synced: 2025-12-31T14:02:50.962Z (6 months ago)
- Language: Python
- Size: 98.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# qu.la-internal
This API is for async event communication
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.8
- Package version: 1.0.8
- Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen
## Requirements.
Python 3.7+
## 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/qualityunit/LiveAgent-Internal-Api-Python-client.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/qualityunit/LiveAgent-Internal-Api-Python-client.git`)
Then import the package:
```python
import qu.la_internal
```
### 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 qu.la_internal
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import qu.la_internal
from qu.la_internal.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/public/api/internal
# See configuration.py for a list of all supported configuration parameters.
configuration = qu.la_internal.Configuration(
host = "http://localhost/public/api/internal"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): bearerAuth
configuration = qu.la_internal.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
async with qu.la_internal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = qu.la_internal.EventsApi(api_client)
handler_payload = qu.la_internal.HandlerPayload() # HandlerPayload | (optional)
try:
# Execute event handlers
await api_instance.execute_handler(handler_payload=handler_payload)
except ApiException as e:
print("Exception when calling EventsApi->execute_handler: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost/public/api/internal*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EventsApi* | [**execute_handler**](docs/EventsApi.md#execute_handler) | **POST** /handlers | Execute event handlers
*EventsApi* | [**get_event_consumers**](docs/EventsApi.md#get_event_consumers) | **GET** /handlers | Get event consumer definitions
## Documentation For Models
- [Consumer](docs/Consumer.md)
- [Event](docs/Event.md)
- [HandlerPayload](docs/HandlerPayload.md)
## Documentation For Authorization
## bearerAuth
- **Type**: Bearer authentication (JWT)
## Author
mcivan@qualityunit.com