Scout9 API Client

APIs for managing Scout9 users and conversations

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

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

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/Scout9Official/scout9-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Scout9Official/scout9-python.git)

Then import the package:

import scout9

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 scout9

Getting Started

Please follow the installation procedure and then run the following:

import time
import scout9
from pprint import pprint
from scout9.apis.tags import scout9_api
from scout9.model.create_customer_request import CreateCustomerRequest
from scout9.model.create_customer_response import CreateCustomerResponse
from scout9.model.create_customers_request import CreateCustomersRequest
from scout9.model.create_customers_response import CreateCustomersResponse
from scout9.model.delete_customer_response import DeleteCustomerResponse
from scout9.model.delete_customers_response import DeleteCustomersResponse
from scout9.model.list_customers_response import ListCustomersResponse
from scout9.model.update_customer_request import UpdateCustomerRequest
from scout9.model.update_customer_response import UpdateCustomerResponse
from scout9.model.update_customers_response import UpdateCustomersResponse
# Defining the host is optional and defaults to https://us-central1-jumpstart.cloudfunctions.net
# See configuration.py for a list of all supported configuration parameters.
configuration = scout9.Configuration(
    host = "https://us-central1-jumpstart.cloudfunctions.net"
)


# Enter a context with an instance of the API client
with scout9.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scout9_api.Scout9Api(api_client)
    create_customer_request = CreateCustomerRequest(None) # CreateCustomerRequest | 

    try:
        # Creates a new customer
        api_response = api_instance.create_customer(create_customer_request)
        pprint(api_response)
    except scout9.ApiException as e:
        print("Exception when calling Scout9Api->create_customer: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://us-central1-jumpstart.cloudfunctions.net

Class	Method	HTTP request	Description
Scout9Api	create_customer	post /v1/customer	Creates a new customer
Scout9Api	create_customers	post /v1/customers	Creates new customers
Scout9Api	delete_customer	delete /v1/customer	Deletes a customer
Scout9Api	delete_customers	delete /v1/customers	Deletes multiple customers
Scout9Api	get_customer	get /v1/customer	Gets a customer
Scout9Api	get_customers	get /v1/customers	Gets all or specific set of customers
Scout9Api	update_customer	put /v1/customer	Updates a customer
Scout9Api	update_customers	put /v1/customers	Updates multiple customers

Documentation For Models

• BlockInfo
• CreateCustomerRequest
• CreateCustomerResponse
• CreateCustomersRequest
• CreateCustomersResponse
• Customer
• DeleteCustomerResponse
• DeleteCustomersResponse
• Error
• ErrorResponse
• GetCustomerResponse
• ListCustomersResponse
• OperationResponse
• UpdateCustomerRequest
• UpdateCustomerResponse
• UpdateCustomersRequest
• UpdateCustomersResponse

Documentation For Authorization

Endpoints do not require authorization.

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in scout9.apis and scout9.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from scout9.apis.default_api import DefaultApi
• from scout9.model.pet import Pet

Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import scout9
from scout9.apis import *
from scout9.models import *