agent-push-kit

The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with apk_. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with apt_.

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

• API version: 0.1.0
• Package version: 0.1.0
• Generator version: 7.24.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://agentpushkit.com

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install git+https://github.com/JustinBStrong/agent-push-kit-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/JustinBStrong/agent-push-kit-python.git)

Then import the package:

import agent_push_kit

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 agent_push_kit

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import agent_push_kit
from agent_push_kit.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.chatdna.co/agent-push-kit/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = agent_push_kit.Configuration(
    host = "https://api.chatdna.co/agent-push-kit/v1"
)

# 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 (Agent Push Kit JWT or apt_ token): UserOrAgent
configuration = agent_push_kit.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with agent_push_kit.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = agent_push_kit.AccountApi(api_client)

    try:
        # Delete the current user and customer accounts they own
        api_response = api_instance.delete_current_account()
        print("The response of AccountApi->delete_current_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->delete_current_account: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.chatdna.co/agent-push-kit/v1

Documentation For Models

• AcceptedResponse
• AddMemberInput
• AgentToken
• AgentTokenCreated
• ApiKeySummary
• AuthResponse
• CreateAgentTokenInput
• CreateOrganizationInput
• CurrentAccount
• DeletedResponse
• DeliverySummary
• Device
• DisabledResponse
• ErrorResponse
• EventDetail
• EventFilter
• EventPage
• EventSummary
• FilterGroup
• FilterNot
• HealthResponse
• IngestionResult
• InheritedResponse
• Membership
• MembershipUser
• Organization
• OrganizationApiKeyCreated
• OrganizationCount
• OrganizationCreated
• OrganizationRecord
• PasswordLoginInput
• PasswordResetCompleteInput
• PasswordResetRequestInput
• PreferenceRecord
• ProviderLoginInput
• RegisterDeviceInput
• RegisterInput
• RegisterWebPushSubscriptionInput
• RegisterWebPushSubscriptionInputKeys
• RevokedResponse
• SearchEventsInput
• SendEventInput
• Service
• ServiceAllOfCount
• ServicePreference
• ServiceSummary
• SetEnabledInput
• TextFilterCondition
• TimeFilterCondition
• TypeOverride
• User
• WebPushConfiguration
• WebPushSubscription

Documentation For Authorization

Authentication schemes defined for the API:

UserOrAgent

• Type: Bearer authentication (Agent Push Kit JWT or apt_ token)

AgentToken

• Type: Bearer authentication (apt_)

OrganizationApiKey

• Type: Bearer authentication (apk_)

Author