eis-commenting 1.2.0__tar.gz

eis_commenting-1.2.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: eis_commenting
+Version: 1.2.0
+Summary: EMIL Commentingservice
+Home-page: UNKNOWN
+Author: Contact us
+Author-email: kontakt@emil.de
+License: UNKNOWN
+Keywords: OpenAPI,OpenAPI-Generator,EMIL Commentingservice
+Platform: UNKNOWN
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+    The EMIL Commentingservice API description  # noqa: E501
+    
+

eis_commenting-1.2.0/README.md

@@ -0,0 +1,165 @@
+# eis_commenting
+The EMIL Commentingservice API description
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: 1.2.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.commenting
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/emilDev/eis-commenting-sdk.git`)
+
+Then import the package:
+```python
+import eis.commenting
+```
+
+### 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.commenting
+```
+
+## 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.commenting
+from pprint import pprint
+from eis.commenting.api import comments_api
+from eis.commenting.model.create_comment_request_dto import CreateCommentRequestDto
+from eis.commenting.model.create_comment_response_class import CreateCommentResponseClass
+from eis.commenting.model.get_comment_response_class import GetCommentResponseClass
+from eis.commenting.model.list_comment_response_class import ListCommentResponseClass
+from eis.commenting.model.update_comment_request_dto import UpdateCommentRequestDto
+from eis.commenting.model.update_comment_response_class import UpdateCommentResponseClass
+# 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.commenting.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.commenting.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.commenting.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = comments_api.CommentsApi(api_client)
+    create_comment_request_dto = CreateCommentRequestDto(
+        entity_type="Policy",
+        entity_code="pol_Qei9aALKz-pYPZ2V",
+        content="This policy needs review before approval.",
+        parent_comment_code="cmnt_b_FFzNWna2",
+    ) # CreateCommentRequestDto | 
+    authorization = "Authorization_example" # str | Bearer Token: provided by the login endpoint under the name accessToken. (optional)
+
+    try:
+        # Create the comment
+        api_response = api_instance.create_comment(create_comment_request_dto, authorization=authorization)
+        pprint(api_response)
+    except eis.commenting.ApiException as e:
+        print("Exception when calling CommentsApi->create_comment: %s\n" % e)
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://apiv2.emil.de*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CommentsApi* | [**create_comment**](docs/CommentsApi.md#create_comment) | **POST** /commentingservice/v1/comments | Create the comment
+*CommentsApi* | [**delete_comment**](docs/CommentsApi.md#delete_comment) | **DELETE** /commentingservice/v1/comments/{code} | Delete the comment
+*CommentsApi* | [**get_comment**](docs/CommentsApi.md#get_comment) | **GET** /commentingservice/v1/comments/{code} | Retrieve the comment
+*CommentsApi* | [**list_comments**](docs/CommentsApi.md#list_comments) | **GET** /commentingservice/v1/comments | List comments
+*CommentsApi* | [**update_comment**](docs/CommentsApi.md#update_comment) | **PATCH** /commentingservice/v1/comments/{code} | Update the comment
+*HealthApi* | [**check**](docs/HealthApi.md#check) | **GET** /commentingservice/health | Health Check
+
+
+## Documentation For Models
+
+ - [CommentClass](docs/CommentClass.md)
+ - [CreateCommentRequestDto](docs/CreateCommentRequestDto.md)
+ - [CreateCommentResponseClass](docs/CreateCommentResponseClass.md)
+ - [GetCommentResponseClass](docs/GetCommentResponseClass.md)
+ - [InlineResponse200](docs/InlineResponse200.md)
+ - [InlineResponse503](docs/InlineResponse503.md)
+ - [ListCommentResponseClass](docs/ListCommentResponseClass.md)
+ - [UpdateCommentRequestDto](docs/UpdateCommentRequestDto.md)
+ - [UpdateCommentResponseClass](docs/UpdateCommentResponseClass.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.commenting.apis and eis.commenting.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.commenting.api.default_api import DefaultApi`
+- `from eis.commenting.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.commenting
+from eis.commenting.apis import *
+from eis.commenting.models import *
+```
+

eis_commenting-1.2.0/eis/commenting/__init__.py

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

eis_commenting-1.2.0/eis/commenting/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.commenting.apis import CommentsApi