claudi
caacb339dd
- Implement tests for basic and bearer authentication headers in `test_auth.py`. - Create tests for the `EasybillWebhookParser` in `test_webhooks.py`, covering JSON and form-encoded payloads, as well as a generic parse and acknowledgement method.
226 lines
9.2 KiB
Python
226 lines
9.2 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
easybill REST API
|
|
|
|
The first version of the easybill REST API. [CHANGELOG](https://api.easybill.de/rest/v1/CHANGELOG.md) ## Authentication You can choose between two available methods: `Basic Auth` or `Bearer Token`. In each HTTP request, one of the following HTTP headers is required: ``` # Basic Auth Authorization: Basic base64_encode('<email>:<api_key>') # Bearer Token Authorization: Bearer <api_key> ``` ## Limitations ### Request Limit * PLUS: 10 requests per minute * BUSINESS: 60 requests per minute If the limit is exceeded, you will receive the HTTP error: `429 Too Many Requests` ### Result Limit All result lists are limited to 100 by default. This limit can be increased by the query parameter `limit` to a maximum of 1000. ## Query filter Many list resources can be filtered. In `/documents` you can filter e.g. by number with `/documents?number=111028654`. If you want to filter multiple numbers, you can either enter them separated by commas `/documents?number=111028654,222006895` or as an array `/documents?number[]=111028654&number[]=222006895`. **Warning**: The maximum size of an HTTP request line in bytes is 4094. If this limit is exceeded, you will receive the HTTP error: `414 Request-URI Too Large` ### Escape commas in query You can escape commans in query `name=Patrick\\, Peter` if you submit the header `X-Easybill-Escape: true` in your request. ## Property login_id This is the login of your admin or employee account. ## Date and Date-Time format Please use the timezone `Europe/Berlin`. * **date** = *Y-m-d* = `2016-12-31` * **date-time** = *Y-m-d H:i:s* = `2016-12-31 03:13:37` Date or datetime can be `null` because the attributes have been added later and the entry is older.
|
|
|
|
The version of the OpenAPI document: 1.96.0
|
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
|
|
Do not edit the class manually.
|
|
""" # noqa: E501
|
|
|
|
|
|
import io
|
|
import json
|
|
import re
|
|
import ssl
|
|
from typing import Optional, Union
|
|
|
|
import aiohttp
|
|
import aiohttp_retry
|
|
|
|
from easybill_generated_async.exceptions import ApiException, ApiValueError
|
|
|
|
RESTResponseType = aiohttp.ClientResponse
|
|
|
|
ALLOW_RETRY_METHODS = frozenset({'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PUT', 'TRACE'})
|
|
|
|
class RESTResponse(io.IOBase):
|
|
|
|
def __init__(self, resp) -> None:
|
|
self.response = resp
|
|
self.status = resp.status
|
|
self.reason = resp.reason
|
|
self.data = None
|
|
|
|
async def read(self):
|
|
if self.data is None:
|
|
self.data = await self.response.read()
|
|
return self.data
|
|
|
|
@property
|
|
def headers(self):
|
|
"""Returns a CIMultiDictProxy of response headers."""
|
|
return self.response.headers
|
|
|
|
def getheaders(self):
|
|
"""Returns a CIMultiDictProxy of the response headers; use ``headers`` instead."""
|
|
return self.response.headers
|
|
|
|
def getheader(self, name, default=None):
|
|
"""Returns a given response header; use ``headers.get()`` instead."""
|
|
return self.response.headers.get(name, default)
|
|
|
|
|
|
class RESTClientObject:
|
|
|
|
def __init__(self, configuration) -> None:
|
|
|
|
# maxsize is number of requests to host that are allowed in parallel
|
|
self.maxsize = configuration.connection_pool_maxsize
|
|
|
|
self.ssl_context = ssl.create_default_context(
|
|
cafile=configuration.ssl_ca_cert,
|
|
cadata=configuration.ca_cert_data,
|
|
)
|
|
if configuration.cert_file:
|
|
self.ssl_context.load_cert_chain(
|
|
configuration.cert_file, keyfile=configuration.key_file
|
|
)
|
|
|
|
if not configuration.verify_ssl:
|
|
self.ssl_context.check_hostname = False
|
|
self.ssl_context.verify_mode = ssl.CERT_NONE
|
|
|
|
self.proxy = configuration.proxy
|
|
self.proxy_headers = configuration.proxy_headers
|
|
|
|
retries = configuration.retries
|
|
if retries is None:
|
|
self._effective_retry_options = None
|
|
elif isinstance(retries, aiohttp_retry.RetryOptionsBase):
|
|
self._effective_retry_options = retries
|
|
elif isinstance(retries, int):
|
|
self._effective_retry_options = aiohttp_retry.ExponentialRetry(
|
|
attempts=retries,
|
|
factor=2.0,
|
|
start_timeout=0.1,
|
|
max_timeout=120.0
|
|
)
|
|
else:
|
|
self._effective_retry_options = None
|
|
|
|
self.pool_manager: Optional[aiohttp.ClientSession] = None
|
|
self.retry_client: Optional[aiohttp_retry.RetryClient] = None
|
|
|
|
async def close(self) -> None:
|
|
if self.pool_manager:
|
|
await self.pool_manager.close()
|
|
if self.retry_client is not None:
|
|
await self.retry_client.close()
|
|
|
|
async def request(
|
|
self,
|
|
method,
|
|
url,
|
|
headers=None,
|
|
body=None,
|
|
post_params=None,
|
|
_request_timeout=None
|
|
):
|
|
"""Execute request
|
|
|
|
:param method: http request method
|
|
:param url: http request url
|
|
:param headers: http request headers
|
|
:param body: request json body, for `application/json`
|
|
:param post_params: request post parameters,
|
|
`application/x-www-form-urlencoded`
|
|
and `multipart/form-data`
|
|
:param _request_timeout: 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.
|
|
"""
|
|
method = method.upper()
|
|
assert method in [
|
|
'GET',
|
|
'HEAD',
|
|
'DELETE',
|
|
'POST',
|
|
'PUT',
|
|
'PATCH',
|
|
'OPTIONS'
|
|
]
|
|
|
|
if post_params and body:
|
|
raise ApiValueError(
|
|
"body parameter cannot be used with post_params parameter."
|
|
)
|
|
|
|
post_params = post_params or {}
|
|
headers = headers or {}
|
|
# url already contains the URL query string
|
|
timeout = _request_timeout or 5 * 60
|
|
|
|
if 'Content-Type' not in headers:
|
|
headers['Content-Type'] = 'application/json'
|
|
|
|
args = {
|
|
"method": method,
|
|
"url": url,
|
|
"timeout": timeout,
|
|
"headers": headers
|
|
}
|
|
|
|
if self.proxy:
|
|
args["proxy"] = self.proxy
|
|
if self.proxy_headers:
|
|
args["proxy_headers"] = self.proxy_headers
|
|
|
|
# For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
|
|
if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
|
|
if re.search('json', headers['Content-Type'], re.IGNORECASE):
|
|
if body is not None:
|
|
body = json.dumps(body)
|
|
args["data"] = body
|
|
elif headers['Content-Type'] == 'application/x-www-form-urlencoded':
|
|
args["data"] = aiohttp.FormData(post_params)
|
|
elif headers['Content-Type'] == 'multipart/form-data':
|
|
# must del headers['Content-Type'], or the correct
|
|
# Content-Type which generated by aiohttp
|
|
del headers['Content-Type']
|
|
data = aiohttp.FormData()
|
|
for param in post_params:
|
|
k, v = param
|
|
if isinstance(v, tuple) and len(v) == 3:
|
|
data.add_field(
|
|
k,
|
|
value=v[1],
|
|
filename=v[0],
|
|
content_type=v[2]
|
|
)
|
|
else:
|
|
# Ensures that dict objects are serialized
|
|
if isinstance(v, dict):
|
|
v = json.dumps(v)
|
|
elif isinstance(v, int):
|
|
v = str(v)
|
|
data.add_field(k, v)
|
|
args["data"] = data
|
|
|
|
# Pass a `bytes` or `str` parameter directly in the body to support
|
|
# other content types than Json when `body` argument is provided
|
|
# in serialized form
|
|
elif isinstance(body, str) or isinstance(body, bytes):
|
|
args["data"] = body
|
|
else:
|
|
# Cannot generate the request from given parameters
|
|
msg = """Cannot prepare a request message for provided
|
|
arguments. Please check that your arguments match
|
|
declared content type."""
|
|
raise ApiException(status=0, reason=msg)
|
|
|
|
pool_manager: Union[aiohttp.ClientSession, aiohttp_retry.RetryClient]
|
|
|
|
# https pool manager
|
|
if self.pool_manager is None:
|
|
self.pool_manager = aiohttp.ClientSession(
|
|
connector=aiohttp.TCPConnector(limit=self.maxsize, ssl=self.ssl_context),
|
|
trust_env=True,
|
|
)
|
|
pool_manager = self.pool_manager
|
|
|
|
if self._effective_retry_options is not None and method in ALLOW_RETRY_METHODS:
|
|
if self.retry_client is None:
|
|
self.retry_client = aiohttp_retry.RetryClient(
|
|
client_session=self.pool_manager,
|
|
retry_options=self._effective_retry_options
|
|
)
|
|
pool_manager = self.retry_client
|
|
|
|
r = await pool_manager.request(**args)
|
|
|
|
return RESTResponse(r)
|