agentcat-api
API for AgentCat application
The agentcat_api package is automatically generated by the OpenAPI Generator project:
- API version: v1
- Package version: 1.0.2
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
This python library package is generated without supporting files like setup.py or requirements files
To be able to use it, you will need these dependencies in your own package that uses this library:
- urllib3 >= 2.1.0, < 3.0.0
- python-dateutil >= 2.8.2
- pydantic >= 2
- typing-extensions >= 4.7.1
Getting Started
In your own code, to use this library to connect and interact with agentcat-api, you can run the following:
import agentcat_api
from agentcat_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.agentcat.com
# See configuration.py for a list of all supported configuration parameters.
configuration = agentcat_api.Configuration(
host = "https://api.agentcat.com"
)
# Enter a context with an instance of the API client
with agentcat_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = agentcat_api.AlertsApi(api_client)
token = 'token_example' # str | (optional)
try:
# Show the confirmation page for removing an email address from one alert rule
api_response = api_instance.unsubscribe_alert_get(token=token)
print("The response of AlertsApi->unsubscribe_alert_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertsApi->unsubscribe_alert_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.agentcat.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AlertsApi | unsubscribe_alert_get | GET /v1/public/alerts/unsubscribe | Show the confirmation page for removing an email address from one alert rule |
| AlertsApi | unsubscribe_alert_post | POST /v1/public/alerts/unsubscribe | Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form) |
| EventsApi | publish_event | POST /v1/public/events/ | Publish analytics event |
| NotificationsApi | unsubscribe_notification | POST /v1/public/notifications/unsubscribe | Disable an email notification type for the token's user |
| NotificationsApi | verify_email_channel | POST /v1/public/notifications/channels/verify | Activate an email channel from its verification link |
Documentation For Models
- EmailChannelVerifyRequest
- EmailChannelVerifyResponse
- Error
- EventAcceptedResponse
- PublishEventRequest
- QueryTimeout
- UnsubscribeRequestRequest
- ValidationErrorValue
Documentation For Authorization
Authentication schemes defined for the API:
tokenAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
Metadata
Release files for agentcat-api 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| agentcat_api-1.0.2.tar.gz | 28.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| agentcat_api-1.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 75.4 kB
Release files / agentcat_api-1.0.2.tar.gz
| Download URL | agentcat_api-1.0.2.tar.gz |
|---|---|
| Size | 28.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f09a748cd3f2ca5037ff8b2bfb8dea879b62d4390e855d696c762203340cd24f
|
|
BLAKE2b-256 checksum How to use checksums |
70f4e4aeed9d9f98ec9d3e9026b2fcc701b20f923b4d3af54a6dd4152e0e5589
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / agentcat_api-1.0.2-py3-none-any.whl
| Download URL | agentcat_api-1.0.2-py3-none-any.whl |
|---|---|
| Size | 47.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b1e41467260f95495b043856be46222c175ada35407c5563c417eb940a2a1ebb
|
|
BLAKE2b-256 checksum How to use checksums |
9ca8f1e919c298b9cc27922ff9ee117d15e2d32166353447dada93dc754ea9fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|