qu.la-internal

This API is for async event communication

This Python package is automatically generated by the OpenAPI Generator 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:

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:

import qu.la_internal

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import qu.la_internal

Getting Started

Please follow the installation procedure and then run the following:

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 POST /handlers Execute event handlers
EventsApi get_event_consumers GET /handlers Get event consumer definitions

Documentation For Models

Documentation For Authorization

bearerAuth

  • Type: Bearer authentication (JWT)

Author

mcivan@qualityunit.com