Skip to content

Latest commit

 

History

History
145 lines (103 loc) · 4.54 KB

README.md

File metadata and controls

145 lines (103 loc) · 4.54 KB

supportpal-python-client

API for accessing SupportPal tickets, messages, operators, and feedback for AI-powered ticket analysis.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.21.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

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

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:

import supportpal_client

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 supportpal_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import supportpal_client
from supportpal_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://yourdomain.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = supportpal_client.Configuration(
    host = "https://yourdomain.com/api"
)

# 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 HTTP basic authorization: BasicAuth
configuration = supportpal_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with supportpal_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = supportpal_client.FeedbackApi(api_client)
    id = 56 # int | 

    try:
        # Get feedback by ID
        api_response = api_instance.get_feedback(id)
        print("The response of FeedbackApi->get_feedback:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FeedbackApi->get_feedback: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://yourdomain.com/api

Class Method HTTP request Description
FeedbackApi get_feedback GET /ticket/feedback/{id} Get feedback by ID
FeedbackApi list_feedback GET /ticket/feedback List ticket feedback
MessageApi get_message GET /ticket/message/{id} Get message by ID
MessageApi list_messages GET /ticket/message List messages for a ticket
OperatorApi get_operator GET /user/operator/{id} Get operator by ID
OperatorApi list_operators GET /user/operator List operators
TicketApi get_ticket GET /ticket/ticket/{id} Get ticket by ID
TicketApi list_tickets GET /ticket/ticket List tickets

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

Author