|
| 1 | +# openapi-client |
| 2 | +API for online agents |
| 3 | + |
| 4 | +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
| 5 | + |
| 6 | +- API version: v1 |
| 7 | +- Package version: 1.0.0 |
| 8 | +- Generator version: 7.14.0 |
| 9 | +- Build package: org.openapitools.codegen.languages.PythonClientCodegen |
| 10 | + |
| 11 | +## Requirements. |
| 12 | + |
| 13 | +Python 3.9+ |
| 14 | + |
| 15 | +## Installation & Usage |
| 16 | +### pip install |
| 17 | + |
| 18 | +If the python package is hosted on a repository, you can install directly using: |
| 19 | + |
| 20 | +```sh |
| 21 | +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git |
| 22 | +``` |
| 23 | +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) |
| 24 | + |
| 25 | +Then import the package: |
| 26 | +```python |
| 27 | +import openapi_client |
| 28 | +``` |
| 29 | + |
| 30 | +### Setuptools |
| 31 | + |
| 32 | +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 33 | + |
| 34 | +```sh |
| 35 | +python setup.py install --user |
| 36 | +``` |
| 37 | +(or `sudo python setup.py install` to install the package for all users) |
| 38 | + |
| 39 | +Then import the package: |
| 40 | +```python |
| 41 | +import openapi_client |
| 42 | +``` |
| 43 | + |
| 44 | +### Tests |
| 45 | + |
| 46 | +Execute `pytest` to run the tests. |
| 47 | + |
| 48 | +## Getting Started |
| 49 | + |
| 50 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 51 | + |
| 52 | +```python |
| 53 | + |
| 54 | +import openapi_client |
| 55 | +from openapi_client.rest import ApiException |
| 56 | +from pprint import pprint |
| 57 | + |
| 58 | +# Defining the host is optional and defaults to http://localhost:8000 |
| 59 | +# See configuration.py for a list of all supported configuration parameters. |
| 60 | +configuration = openapi_client.Configuration( |
| 61 | + host = "http://localhost:8000" |
| 62 | +) |
| 63 | + |
| 64 | +# The client must configure the authentication and authorization parameters |
| 65 | +# in accordance with the API server security policy. |
| 66 | +# Examples for each auth method are provided below, use the example that |
| 67 | +# satisfies your auth use case. |
| 68 | + |
| 69 | +# Configure HTTP basic authorization: Basic |
| 70 | +configuration = openapi_client.Configuration( |
| 71 | + username = os.environ["USERNAME"], |
| 72 | + password = os.environ["PASSWORD"] |
| 73 | +) |
| 74 | + |
| 75 | + |
| 76 | +# Enter a context with an instance of the API client |
| 77 | +with openapi_client.ApiClient(configuration) as api_client: |
| 78 | + # Create an instance of the API class |
| 79 | + api_instance = openapi_client.CsatApi(api_client) |
| 80 | + |
| 81 | + try: |
| 82 | + api_instance.csat_save_create() |
| 83 | + except ApiException as e: |
| 84 | + print("Exception when calling CsatApi->csat_save_create: %s\n" % e) |
| 85 | + |
| 86 | +``` |
| 87 | + |
| 88 | +## Documentation for API Endpoints |
| 89 | + |
| 90 | +All URIs are relative to *http://localhost:8000* |
| 91 | + |
| 92 | +Class | Method | HTTP request | Description |
| 93 | +------------ | ------------- | ------------- | ------------- |
| 94 | +*CsatApi* | [**csat_save_create**](docs/CsatApi.md#csat_save_create) | **POST** /csat/save/ | |
| 95 | +*MetricsApi* | [**metrics_save_create**](docs/MetricsApi.md#metrics_save_create) | **POST** /metrics/save/ | |
| 96 | +*OnlineAgentsApi* | [**online_agents_list**](docs/OnlineAgentsApi.md#online_agents_list) | **GET** /online-agents/ | |
| 97 | +*SampleApi* | [**sample_save_create**](docs/SampleApi.md#sample_save_create) | **POST** /sample/save/ | |
| 98 | + |
| 99 | + |
| 100 | +## Documentation For Models |
| 101 | + |
| 102 | + - [ShiftAgent](docs/ShiftAgent.md) |
| 103 | + |
| 104 | + |
| 105 | +<a id="documentation-for-authorization"></a> |
| 106 | +## Documentation For Authorization |
| 107 | + |
| 108 | + |
| 109 | +Authentication schemes defined for the API: |
| 110 | +<a id="Basic"></a> |
| 111 | +### Basic |
| 112 | + |
| 113 | +- **Type**: HTTP basic authentication |
| 114 | + |
| 115 | + |
| 116 | +## Author |
| 117 | + |
| 118 | + |
| 119 | + |
| 120 | + |
0 commit comments