eis-webhook 1.1.0__tar.gz

eis_webhook-1.1.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: eis_webhook
+Version: 1.1.0
+Summary: EMIL Webhookservice
+Home-page: 
+Author: Contact us
+Author-email: kontakt@emil.de
+Keywords: OpenAPI,OpenAPI-Generator,EMIL Webhookservice
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3>=1.25.3
+Requires-Dist: python-dateutil
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+    The EMIL Webhookservice API description  # noqa: E501
+    

eis_webhook-1.1.0/README.md

@@ -0,0 +1,161 @@
+# eis_webhook
+The EMIL Webhookservice API description
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.19.3
+- Package version: 1.1.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://www.emil.de](https://www.emil.de)
+
+## Requirements.
+
+Python >=3.6
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install eis.webhook
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/emilDev/eis-webhook-sdk.git`)
+
+Then import the package:
+```python
+import eis.webhook
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import eis.webhook
+```
+
+## Getting Started
+
+The environment variables must be set in order to properly use this SDK.
+
+```shell 
+export EMIL_USERNAME=XXXXXXX
+export EMIL_PASSWORD=XXXXXXX
+```
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+import time
+import eis.webhook
+from pprint import pprint
+from eis.webhook.api import health_checks_api
+from eis.webhook.model.inline_response200 import InlineResponse200
+from eis.webhook.model.inline_response503 import InlineResponse503
+# Defining the host is optional and defaults to https://apiv2.emil.de
+# See configuration.py for a list of all supported configuration parameters.
+configuration = eis.webhook.Configuration(
+    host = "https://apiv2.emil.de"
+)
+
+# 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.
+
+# Bearer is automatically handled with exported environment variables. However, you
+# can manuallay configure Bearer authorization (JWT): bearer
+configuration = eis.webhook.Configuration(
+    access_token = 'YOUR_BEARER_TOKEN'
+)
+
+# After manual token becomes invalid, the SDK will default to re-login automatically
+# with environment variable credentials.
+
+
+# Enter a context with an instance of the API client
+with eis.webhook.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = health_checks_api.HealthChecksApi(api_client)
+    authorization = "Authorization_example" # str | Bearer Token: provided by the login endpoint under the name accessToken. (optional)
+
+    try:
+        # Health Check
+        api_response = api_instance.check(authorization=authorization)
+        pprint(api_response)
+    except eis.webhook.ApiException as e:
+        print("Exception when calling HealthChecksApi->check: %s\n" % e)
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://apiv2.emil.de*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*HealthChecksApi* | [**check**](docs/HealthChecksApi.md#check) | **GET** /webhookservice/health | Health Check
+*InboundWebhooksApi* | [**create_inbound_webhook**](docs/InboundWebhooksApi.md#create_inbound_webhook) | **POST** /webhookservice/v1/inbound-webhooks | Create the inbound webhook
+*InboundWebhooksApi* | [**delete_inbound_webhook**](docs/InboundWebhooksApi.md#delete_inbound_webhook) | **DELETE** /webhookservice/v1/inbound-webhooks/{code} | Delete the inbound webhook
+*InboundWebhooksApi* | [**get_inbound_webhook**](docs/InboundWebhooksApi.md#get_inbound_webhook) | **GET** /webhookservice/v1/inbound-webhooks/{code} | Retrieve the inbound webhook
+*InboundWebhooksApi* | [**list_inbound_webhooks**](docs/InboundWebhooksApi.md#list_inbound_webhooks) | **GET** /webhookservice/v1/inbound-webhooks | List inbound webhooks
+*InboundWebhooksApi* | [**update_inbound_webhook**](docs/InboundWebhooksApi.md#update_inbound_webhook) | **PATCH** /webhookservice/v1/inbound-webhooks/{code} | Update the inbound webhook
+*TriggerInboundWebhooksApi* | [**trigger_incoming_webhook**](docs/TriggerInboundWebhooksApi.md#trigger_incoming_webhook) | **POST** /webhookservice/v1/in/{code} | Execute incoming webhook
+*WebhookRequestsApi* | [**list_webhook_requests**](docs/WebhookRequestsApi.md#list_webhook_requests) | **GET** /webhookservice/v1/webhook-requests | List webhook requests
+
+
+## Documentation For Models
+
+ - [CreateInboundWebhookRequestDto](docs/CreateInboundWebhookRequestDto.md)
+ - [CreateInboundWebhookResponseClass](docs/CreateInboundWebhookResponseClass.md)
+ - [GetInboundWebhookResponseClass](docs/GetInboundWebhookResponseClass.md)
+ - [InboundWebhookClass](docs/InboundWebhookClass.md)
+ - [InlineResponse200](docs/InlineResponse200.md)
+ - [InlineResponse503](docs/InlineResponse503.md)
+ - [ListInboundWebhookResponseClass](docs/ListInboundWebhookResponseClass.md)
+ - [ListWebhookRequestsResponseClass](docs/ListWebhookRequestsResponseClass.md)
+ - [TriggerInboundWebhookAcceptedResponseClass](docs/TriggerInboundWebhookAcceptedResponseClass.md)
+ - [TriggerInboundWebhookRejectedResponseClass](docs/TriggerInboundWebhookRejectedResponseClass.md)
+ - [UpdateInboundWebhookRequestDto](docs/UpdateInboundWebhookRequestDto.md)
+ - [UpdateInboundWebhookResponseClass](docs/UpdateInboundWebhookResponseClass.md)
+ - [WebhookRequestClass](docs/WebhookRequestClass.md)
+
+
+## Documentation For Authorization
+
+
+## bearer
+
+- **Type**: Bearer authentication (JWT)
+
+
+## Author
+
+kontakt@emil.de
+
+
+## Notes for Large OpenAPI documents
+If the OpenAPI document is large, imports in eis.webhook.apis and eis.webhook.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 eis.webhook.api.default_api import DefaultApi`
+- `from eis.webhook.model.pet import Pet`
+
+Solution 2:
+Before importing the package, adjust the maximum recursion limit as shown below:
+```
+import sys
+sys.setrecursionlimit(1500)
+import eis.webhook
+from eis.webhook.apis import *
+from eis.webhook.models import *
+```
+

eis_webhook-1.1.0/eis/webhook/__init__.py

@@ -0,0 +1,28 @@
+# flake8: noqa
+
+"""
+    EMIL Webhookservice
+
+    The EMIL Webhookservice API description  # noqa: E501
+
+    The version of the OpenAPI document: 1.19.3
+    Contact: kontakt@emil.de
+    Generated by: https://openapi-generator.tech
+"""
+
+
+__version__ = "1.1.0"
+
+# import ApiClient
+from eis.webhook.api_client import ApiClient
+
+# import Configuration
+from eis.webhook.configuration import Configuration
+
+# import exceptions
+from eis.webhook.exceptions import OpenApiException
+from eis.webhook.exceptions import ApiAttributeError
+from eis.webhook.exceptions import ApiTypeError
+from eis.webhook.exceptions import ApiValueError
+from eis.webhook.exceptions import ApiKeyError
+from eis.webhook.exceptions import ApiException

eis_webhook-1.1.0/eis/webhook/api/__init__.py

@@ -0,0 +1,3 @@
+# do not import all apis into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all apis from one package, import them with
+# from eis.webhook.apis import HealthChecksApi

eis_webhook-1.1.0/eis/webhook/api/health_checks_api.py

@@ -0,0 +1,168 @@
+"""
+    EMIL Webhookservice
+
+    The EMIL Webhookservice API description  # noqa: E501
+
+    The version of the OpenAPI document: 1.19.3
+    Contact: kontakt@emil.de
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from eis.webhook.api_client import ApiClient, Endpoint as _Endpoint
+from eis.webhook.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from eis.webhook.model.inline_response200 import InlineResponse200
+from eis.webhook.model.inline_response503 import InlineResponse503
+
+
+class HealthChecksApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.check_endpoint = _Endpoint(
+            settings={
+                'response_type': (InlineResponse200,),
+                'auth': [
+                    'bearer'
+                ],
+                'endpoint_path': '/webhookservice/health',
+                'operation_id': 'check',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'authorization',
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'authorization':
+                        (str,),
+                },
+                'attribute_map': {
+                    'authorization': 'Authorization',
+                },
+                'location_map': {
+                    'authorization': 'header',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+
+    def check(
+        self,
+        **kwargs
+    ):
+        """Health Check  # noqa: E501
+
+        Returns the health status of the webhook service.        This endpoint is used to monitor the operational status of the webhook service.        It typically returns a simple status indicator, such as 'UP' or 'OK', confirming that the service is operational and available.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.check(async_req=True)
+        >>> result = thread.get()
+
+
+        Keyword Args:
+            authorization (str): Bearer Token: provided by the login endpoint under the name accessToken.. [optional]
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            InlineResponse200
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        return self.check_endpoint.call_with_http_info(**kwargs)
+