agentcat-api 0.0.1__tar.gz → 1.0.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- agentcat_api-1.0.2/MANIFEST.in +1 -0
- agentcat_api-1.0.2/PKG-INFO +116 -0
- agentcat_api-1.0.2/agentcat_api/__init__.py +67 -0
- agentcat_api-1.0.2/agentcat_api/api/__init__.py +7 -0
- agentcat_api-1.0.2/agentcat_api/api/alerts_api.py +582 -0
- agentcat_api-1.0.2/agentcat_api/api/events_api.py +324 -0
- agentcat_api-1.0.2/agentcat_api/api/notifications_api.py +644 -0
- agentcat_api-1.0.2/agentcat_api/api_client.py +801 -0
- agentcat_api-1.0.2/agentcat_api/api_response.py +21 -0
- agentcat_api-1.0.2/agentcat_api/configuration.py +602 -0
- agentcat_api-1.0.2/agentcat_api/exceptions.py +216 -0
- agentcat_api-1.0.2/agentcat_api/models/__init__.py +24 -0
- agentcat_api-1.0.2/agentcat_api/models/email_channel_verify_request.py +88 -0
- agentcat_api-1.0.2/agentcat_api/models/email_channel_verify_response.py +89 -0
- agentcat_api-1.0.2/agentcat_api/models/error.py +87 -0
- agentcat_api-1.0.2/agentcat_api/models/event_accepted_response.py +87 -0
- agentcat_api-1.0.2/agentcat_api/models/publish_event_request.py +170 -0
- agentcat_api-1.0.2/agentcat_api/models/query_timeout.py +96 -0
- agentcat_api-1.0.2/agentcat_api/models/unsubscribe_request_request.py +88 -0
- agentcat_api-1.0.2/agentcat_api/models/validation_error_value.py +143 -0
- agentcat_api-1.0.2/agentcat_api/rest.py +258 -0
- agentcat_api-1.0.2/agentcat_api/test/__init__.py +0 -0
- agentcat_api-1.0.2/agentcat_api/test/test_alerts_api.py +45 -0
- agentcat_api-1.0.2/agentcat_api/test/test_email_channel_verify_request.py +51 -0
- agentcat_api-1.0.2/agentcat_api/test/test_email_channel_verify_response.py +54 -0
- agentcat_api-1.0.2/agentcat_api/test/test_error.py +52 -0
- agentcat_api-1.0.2/agentcat_api/test/test_event_accepted_response.py +51 -0
- agentcat_api-1.0.2/agentcat_api/test/test_events_api.py +38 -0
- agentcat_api-1.0.2/agentcat_api/test/test_notifications_api.py +45 -0
- agentcat_api-1.0.2/agentcat_api/test/test_publish_event_request.py +81 -0
- agentcat_api-1.0.2/agentcat_api/test/test_query_timeout.py +54 -0
- agentcat_api-1.0.2/agentcat_api/test/test_unsubscribe_request_request.py +51 -0
- agentcat_api-1.0.2/agentcat_api/test/test_validation_error_value.py +50 -0
- agentcat_api-1.0.2/agentcat_api.egg-info/PKG-INFO +116 -0
- agentcat_api-1.0.2/agentcat_api.egg-info/SOURCES.txt +39 -0
- agentcat_api-1.0.2/agentcat_api.egg-info/dependency_links.txt +1 -0
- agentcat_api-1.0.2/agentcat_api.egg-info/requires.txt +3 -0
- agentcat_api-1.0.2/agentcat_api.egg-info/top_level.txt +1 -0
- agentcat_api-1.0.2/agentcat_api_README.md +103 -0
- agentcat_api-1.0.2/setup.cfg +4 -0
- agentcat_api-1.0.2/setup.py +24 -0
- agentcat_api-0.0.1/PKG-INFO +0 -16
- agentcat_api-0.0.1/README.md +0 -5
- agentcat_api-0.0.1/pyproject.toml +0 -19
- agentcat_api-0.0.1/src/agentcat_api/__init__.py +0 -3
|
@@ -0,0 +1 @@
|
|
|
1
|
+
include agentcat_api_README.md
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: agentcat_api
|
|
3
|
+
Version: 1.0.2
|
|
4
|
+
License: MIT
|
|
5
|
+
Description-Content-Type: text/markdown
|
|
6
|
+
Requires-Dist: urllib3<3.0.0,>=2.1.0
|
|
7
|
+
Requires-Dist: python-dateutil
|
|
8
|
+
Requires-Dist: pydantic<3,>=2.0.0
|
|
9
|
+
Dynamic: description
|
|
10
|
+
Dynamic: description-content-type
|
|
11
|
+
Dynamic: license
|
|
12
|
+
Dynamic: requires-dist
|
|
13
|
+
|
|
14
|
+
# agentcat-api
|
|
15
|
+
API for AgentCat application
|
|
16
|
+
|
|
17
|
+
The `agentcat_api` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
18
|
+
|
|
19
|
+
- API version: v1
|
|
20
|
+
- Package version: 1.0.2
|
|
21
|
+
- Generator version: 7.14.0
|
|
22
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
23
|
+
|
|
24
|
+
## Requirements.
|
|
25
|
+
|
|
26
|
+
Python 3.9+
|
|
27
|
+
|
|
28
|
+
## Installation & Usage
|
|
29
|
+
|
|
30
|
+
This python library package is generated without supporting files like setup.py or requirements files
|
|
31
|
+
|
|
32
|
+
To be able to use it, you will need these dependencies in your own package that uses this library:
|
|
33
|
+
|
|
34
|
+
* urllib3 >= 2.1.0, < 3.0.0
|
|
35
|
+
* python-dateutil >= 2.8.2
|
|
36
|
+
* pydantic >= 2
|
|
37
|
+
* typing-extensions >= 4.7.1
|
|
38
|
+
|
|
39
|
+
## Getting Started
|
|
40
|
+
|
|
41
|
+
In your own code, to use this library to connect and interact with agentcat-api,
|
|
42
|
+
you can run the following:
|
|
43
|
+
|
|
44
|
+
```python
|
|
45
|
+
|
|
46
|
+
import agentcat_api
|
|
47
|
+
from agentcat_api.rest import ApiException
|
|
48
|
+
from pprint import pprint
|
|
49
|
+
|
|
50
|
+
# Defining the host is optional and defaults to https://api.agentcat.com
|
|
51
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
52
|
+
configuration = agentcat_api.Configuration(
|
|
53
|
+
host = "https://api.agentcat.com"
|
|
54
|
+
)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
# Enter a context with an instance of the API client
|
|
59
|
+
with agentcat_api.ApiClient(configuration) as api_client:
|
|
60
|
+
# Create an instance of the API class
|
|
61
|
+
api_instance = agentcat_api.AlertsApi(api_client)
|
|
62
|
+
token = 'token_example' # str | (optional)
|
|
63
|
+
|
|
64
|
+
try:
|
|
65
|
+
# Show the confirmation page for removing an email address from one alert rule
|
|
66
|
+
api_response = api_instance.unsubscribe_alert_get(token=token)
|
|
67
|
+
print("The response of AlertsApi->unsubscribe_alert_get:\n")
|
|
68
|
+
pprint(api_response)
|
|
69
|
+
except ApiException as e:
|
|
70
|
+
print("Exception when calling AlertsApi->unsubscribe_alert_get: %s\n" % e)
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Documentation for API Endpoints
|
|
75
|
+
|
|
76
|
+
All URIs are relative to *https://api.agentcat.com*
|
|
77
|
+
|
|
78
|
+
Class | Method | HTTP request | Description
|
|
79
|
+
------------ | ------------- | ------------- | -------------
|
|
80
|
+
*AlertsApi* | [**unsubscribe_alert_get**](agentcat_api/docs/AlertsApi.md#unsubscribe_alert_get) | **GET** /v1/public/alerts/unsubscribe | Show the confirmation page for removing an email address from one alert rule
|
|
81
|
+
*AlertsApi* | [**unsubscribe_alert_post**](agentcat_api/docs/AlertsApi.md#unsubscribe_alert_post) | **POST** /v1/public/alerts/unsubscribe | Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form)
|
|
82
|
+
*EventsApi* | [**publish_event**](agentcat_api/docs/EventsApi.md#publish_event) | **POST** /v1/public/events/ | Publish analytics event
|
|
83
|
+
*NotificationsApi* | [**unsubscribe_notification**](agentcat_api/docs/NotificationsApi.md#unsubscribe_notification) | **POST** /v1/public/notifications/unsubscribe | Disable an email notification type for the token's user
|
|
84
|
+
*NotificationsApi* | [**verify_email_channel**](agentcat_api/docs/NotificationsApi.md#verify_email_channel) | **POST** /v1/public/notifications/channels/verify | Activate an email channel from its verification link
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
## Documentation For Models
|
|
88
|
+
|
|
89
|
+
- [EmailChannelVerifyRequest](agentcat_api/docs/EmailChannelVerifyRequest.md)
|
|
90
|
+
- [EmailChannelVerifyResponse](agentcat_api/docs/EmailChannelVerifyResponse.md)
|
|
91
|
+
- [Error](agentcat_api/docs/Error.md)
|
|
92
|
+
- [EventAcceptedResponse](agentcat_api/docs/EventAcceptedResponse.md)
|
|
93
|
+
- [PublishEventRequest](agentcat_api/docs/PublishEventRequest.md)
|
|
94
|
+
- [QueryTimeout](agentcat_api/docs/QueryTimeout.md)
|
|
95
|
+
- [UnsubscribeRequestRequest](agentcat_api/docs/UnsubscribeRequestRequest.md)
|
|
96
|
+
- [ValidationErrorValue](agentcat_api/docs/ValidationErrorValue.md)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<a id="documentation-for-authorization"></a>
|
|
100
|
+
## Documentation For Authorization
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
Authentication schemes defined for the API:
|
|
104
|
+
<a id="tokenAuth"></a>
|
|
105
|
+
### tokenAuth
|
|
106
|
+
|
|
107
|
+
- **Type**: API key
|
|
108
|
+
- **API key parameter name**: Authorization
|
|
109
|
+
- **Location**: HTTP header
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
## Author
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
AgentCat API
|
|
7
|
+
|
|
8
|
+
API for AgentCat application
|
|
9
|
+
|
|
10
|
+
The version of the OpenAPI document: v1
|
|
11
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
12
|
+
|
|
13
|
+
Do not edit the class manually.
|
|
14
|
+
""" # noqa: E501
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
__version__ = "1.0.2"
|
|
18
|
+
|
|
19
|
+
# Define package exports
|
|
20
|
+
__all__ = [
|
|
21
|
+
"AlertsApi",
|
|
22
|
+
"EventsApi",
|
|
23
|
+
"NotificationsApi",
|
|
24
|
+
"ApiResponse",
|
|
25
|
+
"ApiClient",
|
|
26
|
+
"Configuration",
|
|
27
|
+
"OpenApiException",
|
|
28
|
+
"ApiTypeError",
|
|
29
|
+
"ApiValueError",
|
|
30
|
+
"ApiKeyError",
|
|
31
|
+
"ApiAttributeError",
|
|
32
|
+
"ApiException",
|
|
33
|
+
"EmailChannelVerifyRequest",
|
|
34
|
+
"EmailChannelVerifyResponse",
|
|
35
|
+
"Error",
|
|
36
|
+
"EventAcceptedResponse",
|
|
37
|
+
"PublishEventRequest",
|
|
38
|
+
"QueryTimeout",
|
|
39
|
+
"UnsubscribeRequestRequest",
|
|
40
|
+
"ValidationErrorValue",
|
|
41
|
+
]
|
|
42
|
+
|
|
43
|
+
# import apis into sdk package
|
|
44
|
+
from agentcat_api.api.alerts_api import AlertsApi as AlertsApi
|
|
45
|
+
from agentcat_api.api.events_api import EventsApi as EventsApi
|
|
46
|
+
from agentcat_api.api.notifications_api import NotificationsApi as NotificationsApi
|
|
47
|
+
|
|
48
|
+
# import ApiClient
|
|
49
|
+
from agentcat_api.api_response import ApiResponse as ApiResponse
|
|
50
|
+
from agentcat_api.api_client import ApiClient as ApiClient
|
|
51
|
+
from agentcat_api.configuration import Configuration as Configuration
|
|
52
|
+
from agentcat_api.exceptions import OpenApiException as OpenApiException
|
|
53
|
+
from agentcat_api.exceptions import ApiTypeError as ApiTypeError
|
|
54
|
+
from agentcat_api.exceptions import ApiValueError as ApiValueError
|
|
55
|
+
from agentcat_api.exceptions import ApiKeyError as ApiKeyError
|
|
56
|
+
from agentcat_api.exceptions import ApiAttributeError as ApiAttributeError
|
|
57
|
+
from agentcat_api.exceptions import ApiException as ApiException
|
|
58
|
+
|
|
59
|
+
# import models into sdk package
|
|
60
|
+
from agentcat_api.models.email_channel_verify_request import EmailChannelVerifyRequest as EmailChannelVerifyRequest
|
|
61
|
+
from agentcat_api.models.email_channel_verify_response import EmailChannelVerifyResponse as EmailChannelVerifyResponse
|
|
62
|
+
from agentcat_api.models.error import Error as Error
|
|
63
|
+
from agentcat_api.models.event_accepted_response import EventAcceptedResponse as EventAcceptedResponse
|
|
64
|
+
from agentcat_api.models.publish_event_request import PublishEventRequest as PublishEventRequest
|
|
65
|
+
from agentcat_api.models.query_timeout import QueryTimeout as QueryTimeout
|
|
66
|
+
from agentcat_api.models.unsubscribe_request_request import UnsubscribeRequestRequest as UnsubscribeRequestRequest
|
|
67
|
+
from agentcat_api.models.validation_error_value import ValidationErrorValue as ValidationErrorValue
|