regula-documentreader-webclient 8.3.512__py3-none-any.whl → 8.4.584__py3-none-any.whl

regula/documentreader/webclient/gen/api/__init__.py

@@ -1,7 +1,26 @@
 # flake8: noqa
 
-# import apis into api package
+if __import__("typing").TYPE_CHECKING:
+    # import apis into api package
+    from regula.documentreader.webclient.gen.api.healthcheck_api import HealthcheckApi
+    from regula.documentreader.webclient.gen.api.process_api import ProcessApi
+    from regula.documentreader.webclient.gen.api.resources_api import ResourcesApi
+    from regula.documentreader.webclient.gen.api.transaction_api import TransactionApi
+    
+else:
+    from lazy_imports import LazyModule, as_package, load
+
+    load(
+        LazyModule(
+            *as_package(__file__),
+            """# import apis into api package
 from regula.documentreader.webclient.gen.api.healthcheck_api import HealthcheckApi
 from regula.documentreader.webclient.gen.api.process_api import ProcessApi
+from regula.documentreader.webclient.gen.api.resources_api import ResourcesApi
 from regula.documentreader.webclient.gen.api.transaction_api import TransactionApi
 
+""",
+            name=__name__,
+            doc=__doc__,
+        )
+    )

regula/documentreader/webclient/gen/api/resources_api.py

@@ -0,0 +1,270 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from regula.documentreader.webclient.gen.models.database_document_list import DatabaseDocumentList
+
+from regula.documentreader.webclient.gen.api_client import ApiClient, RequestSerialized
+from regula.documentreader.webclient.gen.api_response import ApiResponse
+from regula.documentreader.webclient.gen.rest import RESTResponseType
+
+
+class ResourcesApi:
+    """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) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def doclist(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> DatabaseDocumentList:
+        """Returns the list of documents stored in the database that the Web Service API is running with.
+
+
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._doclist_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "DatabaseDocumentList",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def doclist_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[DatabaseDocumentList]:
+        """Returns the list of documents stored in the database that the Web Service API is running with.
+
+
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._doclist_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "DatabaseDocumentList",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def doclist_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Returns the list of documents stored in the database that the Web Service API is running with.
+
+
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._doclist_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "DatabaseDocumentList",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _doclist_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/doclist',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

regula/documentreader/webclient/gen/api/transaction_api.py

@@ -11,6 +11,7 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictBool, StrictBytes, StrictStr
 from typing import Any, Dict, Optional, Tuple, Union
 from typing_extensions import Annotated
+from uuid import UUID
 from regula.documentreader.webclient.gen.models.list_transactions_by_tag_response import ListTransactionsByTagResponse
 from regula.documentreader.webclient.gen.models.process_response import ProcessResponse
 from regula.documentreader.webclient.gen.models.transaction_process_get_response import TransactionProcessGetResponse
@@ -38,7 +39,7 @@ class TransactionApi:
     @validate_call
     def api_v2_tag_tag_id_delete(
         self,
-        tag_id: Annotated[StrictStr, Field(description="Tag id")],
+        tag_id: Annotated[UUID, Field(description="Tag id")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -106,7 +107,7 @@ class TransactionApi:
     @validate_call
     def api_v2_tag_tag_id_delete_with_http_info(
         self,
-        tag_id: Annotated[StrictStr, Field(description="Tag id")],
+        tag_id: Annotated[UUID, Field(description="Tag id")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -174,7 +175,7 @@ class TransactionApi:
     @validate_call
     def api_v2_tag_tag_id_delete_without_preload_content(
         self,
-        tag_id: Annotated[StrictStr, Field(description="Tag id")],
+        tag_id: Annotated[UUID, Field(description="Tag id")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -564,7 +565,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_file_get(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         name: Annotated[StrictStr, Field(description="File name")],
         _request_timeout: Union[
             None,
@@ -635,7 +636,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_file_get_with_http_info(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         name: Annotated[StrictStr, Field(description="File name")],
         _request_timeout: Union[
             None,
@@ -706,7 +707,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_file_get_without_preload_content(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         name: Annotated[StrictStr, Field(description="File name")],
         _request_timeout: Union[
             None,
@@ -841,7 +842,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_get(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -909,7 +910,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_get_with_http_info(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -977,7 +978,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_get_without_preload_content(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1104,8 +1105,9 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_process_post(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         transaction_process_request: TransactionProcessRequest,
+        use_cache: Annotated[Optional[StrictBool], Field(description="Get processed values from storage in case transaction has already processed.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1126,6 +1128,8 @@ class TransactionApi:
         :type transaction_id: str
         :param transaction_process_request: (required)
         :type transaction_process_request: TransactionProcessRequest
+        :param use_cache: Get processed values from storage in case transaction has already processed.
+        :type use_cache: bool
         :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
@@ -1151,6 +1155,7 @@ class TransactionApi:
         _param = self._api_v2_transaction_transaction_id_process_post_serialize(
             transaction_id=transaction_id,
             transaction_process_request=transaction_process_request,
+            use_cache=use_cache,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1176,8 +1181,9 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_process_post_with_http_info(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         transaction_process_request: TransactionProcessRequest,
+        use_cache: Annotated[Optional[StrictBool], Field(description="Get processed values from storage in case transaction has already processed.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1198,6 +1204,8 @@ class TransactionApi:
         :type transaction_id: str
         :param transaction_process_request: (required)
         :type transaction_process_request: TransactionProcessRequest
+        :param use_cache: Get processed values from storage in case transaction has already processed.
+        :type use_cache: bool
         :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
@@ -1223,6 +1231,7 @@ class TransactionApi:
         _param = self._api_v2_transaction_transaction_id_process_post_serialize(
             transaction_id=transaction_id,
             transaction_process_request=transaction_process_request,
+            use_cache=use_cache,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1248,8 +1257,9 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_process_post_without_preload_content(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         transaction_process_request: TransactionProcessRequest,
+        use_cache: Annotated[Optional[StrictBool], Field(description="Get processed values from storage in case transaction has already processed.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1270,6 +1280,8 @@ class TransactionApi:
         :type transaction_id: str
         :param transaction_process_request: (required)
         :type transaction_process_request: TransactionProcessRequest
+        :param use_cache: Get processed values from storage in case transaction has already processed.
+        :type use_cache: bool
         :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
@@ -1295,6 +1307,7 @@ class TransactionApi:
         _param = self._api_v2_transaction_transaction_id_process_post_serialize(
             transaction_id=transaction_id,
             transaction_process_request=transaction_process_request,
+            use_cache=use_cache,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1317,6 +1330,7 @@ class TransactionApi:
         self,
         transaction_id,
         transaction_process_request,
+        use_cache,
         _request_auth,
         _content_type,
         _headers,
@@ -1341,6 +1355,10 @@ class TransactionApi:
         if transaction_id is not None:
             _path_params['transactionId'] = transaction_id
         # process the query parameters
+        if use_cache is not None:
+            
+            _query_params.append(('useCache', use_cache))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1395,7 +1413,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_results_get(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         with_images: Annotated[Optional[StrictBool], Field(description="With base64 images or url")] = None,
         _request_timeout: Union[
             None,
@@ -1467,7 +1485,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_results_get_with_http_info(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         with_images: Annotated[Optional[StrictBool], Field(description="With base64 images or url")] = None,
         _request_timeout: Union[
             None,
@@ -1539,7 +1557,7 @@ class TransactionApi:
     @validate_call
     def api_v2_transaction_transaction_id_results_get_without_preload_content(
         self,
-        transaction_id: Annotated[StrictStr, Field(description="Transaction id")],
+        transaction_id: Annotated[UUID, Field(description="Transaction id")],
         with_images: Annotated[Optional[StrictBool], Field(description="With base64 images or url")] = None,
         _request_timeout: Union[
             None,

regula/documentreader/webclient/gen/api_client.py

@@ -13,6 +13,7 @@ import mimetypes
 import os
 import re
 import tempfile
+import uuid
 
 from urllib.parse import quote
 from typing import Tuple, Optional, List, Dict, Union
@@ -348,6 +349,8 @@ class ApiClient:
             return obj.get_secret_value()
         elif isinstance(obj, self.PRIMITIVE_TYPES):
             return obj
+        elif isinstance(obj, uuid.UUID):
+            return str(obj)
         elif isinstance(obj, list):
             return [
                 self.sanitize_for_serialization(sub_obj) for sub_obj in obj
@@ -374,6 +377,10 @@ class ApiClient:
             else:
                 obj_dict = obj.__dict__
 
+        if isinstance(obj_dict, list):
+            # here we handle instances that can either be a list or something else, and only became a real list by calling to_dict()
+            return self.sanitize_for_serialization(obj_dict)
+
         return {
             key: self.sanitize_for_serialization(val)
             for key, val in obj_dict.items()
@@ -396,7 +403,7 @@ class ApiClient:
                 data = json.loads(response_text)
             except ValueError:
                 data = response_text
-        elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE):
+        elif re.match(r'^application/(json|[\w!#$&.+\-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE):
             if response_text == "":
                 data = ""
             else: