eis-accounting 1.1.0__tar.gz

eis-accounting-1.1.0/PKG-INFO

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

eis-accounting-1.1.0/README.md

@@ -0,0 +1,194 @@
+# eis-accounting
+The EMIL AccountingService API description
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- 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.accounting
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import eis.accounting
+```
+
+### 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.accounting
+```
+
+## 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.accounting
+from pprint import pprint
+from eis.accounting.api import booking_processes_api
+from eis.accounting.model.create_booking_process_request_dto import CreateBookingProcessRequestDto
+from eis.accounting.model.create_booking_process_response_class import CreateBookingProcessResponseClass
+from eis.accounting.model.list_booking_process_response_class import ListBookingProcessResponseClass
+# 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.accounting.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.accounting.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.accounting.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = booking_processes_api.BookingProcessesApi(api_client)
+    create_booking_process_request_dto = CreateBookingProcessRequestDto(
+        policy_number="POL_700001",
+        status="paid",
+        booking_process_type="recurringInvoice",
+        custom_fields={},
+        booking_entries=[
+            CreateBookingEntryRequestDto(
+                booking_date=dateutil_parser('2024-06-24T10:12:46.493Z'),
+                description="Invoice payment for policy 010101489/V",
+                policy_number="POL_700001",
+                entity_name="invoice",
+                entity_number="INV2405840",
+                currency="EUR",
+                amount=100,
+                booking_process_id=12345,
+                custom_fields={},
+                financial_transactions=[
+                    FinancialTransactionDataDto(
+                        financial_account_number="40010001",
+                        amount=100,
+                        debit_credit="CREDIT",
+                        partner_number="1234567890",
+                        partner_group="Partner Group",
+                        policy_number="1234567890",
+                        custom_fields={},
+                        description="Monthly premium payment for policy 1234567890",
+                    ),
+                ],
+            ),
+        ],
+    ) # CreateBookingProcessRequestDto | 
+    authorization = "Authorization_example" # str | Bearer Token: provided by the login endpoint under the name accessToken. (optional)
+
+    try:
+        # Create the booking process
+        api_response = api_instance.create_booking_process(create_booking_process_request_dto, authorization=authorization)
+        pprint(api_response)
+    except eis.accounting.ApiException as e:
+        print("Exception when calling BookingProcessesApi->create_booking_process: %s\n" % e)
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://apiv2.emil.de*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BookingProcessesApi* | [**create_booking_process**](docs/BookingProcessesApi.md#create_booking_process) | **POST** /accountingservice/v1/booking-processes | Create the booking process
+*BookingProcessesApi* | [**list_booking_processes**](docs/BookingProcessesApi.md#list_booking_processes) | **GET** /accountingservice/v1/booking-processes | List Booking processes
+*FinancialAccountsApi* | [**create_financial_account**](docs/FinancialAccountsApi.md#create_financial_account) | **POST** /accountingservice/v1/financial-accounts | Create the Financial Account
+*FinancialAccountsApi* | [**delete_financial_account**](docs/FinancialAccountsApi.md#delete_financial_account) | **DELETE** /accountingservice/v1/financial-accounts/{code} | Delete the Financial Account
+*FinancialAccountsApi* | [**get_financial_account**](docs/FinancialAccountsApi.md#get_financial_account) | **GET** /accountingservice/v1/financial-accounts/{code} | Retrieve the Financial Account
+*FinancialAccountsApi* | [**list_financial_accounts**](docs/FinancialAccountsApi.md#list_financial_accounts) | **GET** /accountingservice/v1/financial-accounts | List Financial Accounts
+*HealthApi* | [**check**](docs/HealthApi.md#check) | **GET** /accountingservice/health | Health Check
+
+
+## Documentation For Models
+
+ - [BookingEntryClass](docs/BookingEntryClass.md)
+ - [BookingProcessClass](docs/BookingProcessClass.md)
+ - [CreateBookingEntryRequestDto](docs/CreateBookingEntryRequestDto.md)
+ - [CreateBookingProcessRequestDto](docs/CreateBookingProcessRequestDto.md)
+ - [CreateBookingProcessResponseClass](docs/CreateBookingProcessResponseClass.md)
+ - [CreateFinancialAccountRequestDto](docs/CreateFinancialAccountRequestDto.md)
+ - [CreateFinancialAccountResponseClass](docs/CreateFinancialAccountResponseClass.md)
+ - [FinancialAccountClass](docs/FinancialAccountClass.md)
+ - [FinancialTransactionClass](docs/FinancialTransactionClass.md)
+ - [FinancialTransactionDataDto](docs/FinancialTransactionDataDto.md)
+ - [GetFinancialAccountResponseClass](docs/GetFinancialAccountResponseClass.md)
+ - [InlineResponse200](docs/InlineResponse200.md)
+ - [InlineResponse503](docs/InlineResponse503.md)
+ - [ListBookingProcessResponseClass](docs/ListBookingProcessResponseClass.md)
+ - [ListFinancialAccountsResponseClass](docs/ListFinancialAccountsResponseClass.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.accounting.apis and eis.accounting.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.accounting.api.default_api import DefaultApi`
+- `from eis.accounting.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.accounting
+from eis.accounting.apis import *
+from eis.accounting.models import *
+```
+

eis-accounting-1.1.0/eis/accounting/__init__.py

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

eis-accounting-1.1.0/eis/accounting/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.accounting.apis import BookingProcessesApi

eis-accounting-1.1.0/eis/accounting/api/booking_processes_api.py

@@ -0,0 +1,352 @@
+"""
+    EMIL AccountingService
+
+    The EMIL AccountingService API description  # noqa: E501
+
+    The version of the OpenAPI document: 1.0
+    Contact: kontakt@emil.de
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from eis.accounting.api_client import ApiClient, Endpoint as _Endpoint
+from eis.accounting.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from eis.accounting.model.create_booking_process_request_dto import CreateBookingProcessRequestDto
+from eis.accounting.model.create_booking_process_response_class import CreateBookingProcessResponseClass
+from eis.accounting.model.list_booking_process_response_class import ListBookingProcessResponseClass
+
+
+class BookingProcessesApi(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.create_booking_process_endpoint = _Endpoint(
+            settings={
+                'response_type': (CreateBookingProcessResponseClass,),
+                'auth': [
+                    'bearer'
+                ],
+                'endpoint_path': '/accountingservice/v1/booking-processes',
+                'operation_id': 'create_booking_process',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'create_booking_process_request_dto',
+                    'authorization',
+                ],
+                'required': [
+                    'create_booking_process_request_dto',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'create_booking_process_request_dto':
+                        (CreateBookingProcessRequestDto,),
+                    'authorization':
+                        (str,),
+                },
+                'attribute_map': {
+                    'authorization': 'Authorization',
+                },
+                'location_map': {
+                    'create_booking_process_request_dto': 'body',
+                    'authorization': 'header',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
+        self.list_booking_processes_endpoint = _Endpoint(
+            settings={
+                'response_type': (ListBookingProcessResponseClass,),
+                'auth': [
+                    'bearer'
+                ],
+                'endpoint_path': '/accountingservice/v1/booking-processes',
+                'operation_id': 'list_booking_processes',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'authorization',
+                    'page_size',
+                    'page_token',
+                    'filter',
+                    'search',
+                    'order',
+                    'expand',
+                    'filters',
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'authorization':
+                        (str,),
+                    'page_size':
+                        (bool, date, datetime, dict, float, int, list, str, none_type,),
+                    'page_token':
+                        (bool, date, datetime, dict, float, int, list, str, none_type,),
+                    'filter':
+                        (str,),
+                    'search':
+                        (bool, date, datetime, dict, float, int, list, str, none_type,),
+                    'order':
+                        (str,),
+                    'expand':
+                        (bool, date, datetime, dict, float, int, list, str, none_type,),
+                    'filters':
+                        (str,),
+                },
+                'attribute_map': {
+                    'authorization': 'Authorization',
+                    'page_size': 'pageSize',
+                    'page_token': 'pageToken',
+                    'filter': 'filter',
+                    'search': 'search',
+                    'order': 'order',
+                    'expand': 'expand',
+                    'filters': 'filters',
+                },
+                'location_map': {
+                    'authorization': 'header',
+                    'page_size': 'query',
+                    'page_token': 'query',
+                    'filter': 'query',
+                    'search': 'query',
+                    'order': 'query',
+                    'expand': 'query',
+                    'filters': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+
+    def create_booking_process(
+        self,
+        create_booking_process_request_dto,
+        **kwargs
+    ):
+        """Create the booking process  # noqa: E501
+
+        This endpoint creates a new booking process.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.create_booking_process(create_booking_process_request_dto, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            create_booking_process_request_dto (CreateBookingProcessRequestDto):
+
+        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:
+            CreateBookingProcessResponseClass
+                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)
+        kwargs['create_booking_process_request_dto'] = \
+            create_booking_process_request_dto
+        return self.create_booking_process_endpoint.call_with_http_info(**kwargs)
+
+    def list_booking_processes(
+        self,
+        **kwargs
+    ):
+        """List Booking processes  # noqa: E501
+
+        Returns a list of Booking processes you have previously created.          The Booking processes are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.list_booking_processes(async_req=True)
+        >>> result = thread.get()
+
+
+        Keyword Args:
+            authorization (str): Bearer Token: provided by the login endpoint under the name accessToken.. [optional]
+            page_size (bool, date, datetime, dict, float, int, list, str, none_type): A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.. [optional]
+            page_token (bool, date, datetime, dict, float, int, list, str, none_type): A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken=1,     your subsequent call can include pageToken=2 in order to fetch the next page of the list.. [optional]
+            filter (str): Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code</i>. [optional]
+            search (bool, date, datetime, dict, float, int, list, str, none_type): To search the list by any field, pass search=xxx to fetch the result.. [optional]
+            order (str): Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, updatedAt, createdAt</i>. [optional]
+            expand (bool, date, datetime, dict, float, int, list, str, none_type): Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.. [optional]
+            filters (str): Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code</i>. [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:
+            ListBookingProcessResponseClass
+                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.list_booking_processes_endpoint.call_with_http_info(**kwargs)
+