regula-documentreader-webclient 8.4.515.dev0__tar.gz → 9.2.659.dev0__tar.gz

{regula_documentreader_webclient-8.4.515.dev0 → regula_documentreader_webclient-9.2.659.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 8.4.515.dev0
+Version: 9.2.659.dev0
 Summary: Regula's Document Reader python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_documentreader_webclient-8.4.515.dev0 → regula_documentreader_webclient-9.2.659.dev0}/regula/documentreader/webclient/ext/api/document_reader_api.py

@@ -3,14 +3,14 @@ from typing import Union
 from regula.documentreader.webclient import ProcessResponse
 from regula.documentreader.webclient.gen import ApiClient
 from regula.documentreader.webclient.ext.models.recognition_response import RecognitionResponse
-from regula.documentreader.webclient.gen.api import HealthcheckApi, ProcessApi
+from regula.documentreader.webclient.gen.api import HealthcheckApi, ProcessApi, ResourcesApi, TransactionApi
 from regula.documentreader.webclient.gen.configuration import Configuration
 from regula.documentreader.webclient.gen.models import ProcessRequest
 
 Base64String = str
 
 
-class DocumentReaderApi(HealthcheckApi, ProcessApi):
+class DocumentReaderApi(HealthcheckApi, ProcessApi, ResourcesApi, TransactionApi):
 
     def __init__(self, host=None, debug=False, verify_ssl=True, api_client=None):
         if api_client:

{regula_documentreader_webclient-8.4.515.dev0 → regula_documentreader_webclient-9.2.659.dev0}/regula/documentreader/webclient/gen/__init__.py

@@ -12,6 +12,7 @@ __version__ = "1.0.0"
 __all__ = [
     "HealthcheckApi",
     "ProcessApi",
+    "ResourcesApi",
     "TransactionApi",
     "ApiResponse",
     "ApiClient",
@@ -52,6 +53,9 @@ __all__ = [
     "Critical",
     "CrossSourceValueComparison",
     "DataModule",
+    "DatabaseDocument",
+    "DatabaseDocumentList",
+    "DetailsAge",
     "DetailsOptical",
     "DetailsRFID",
     "DeviceInfo",
@@ -59,6 +63,7 @@ __all__ = [
     "DocBarCodeInfo",
     "DocBarCodeInfoFieldsList",
     "DocBarCodeInfoItem",
+    "DocFeature",
     "DocGraphicsInfoItem",
     "DocVisualExtendedField",
     "DocVisualExtendedFieldItem",
@@ -92,6 +97,7 @@ __all__ = [
     "FieldItem",
     "FileImage",
     "GetTransactionsByTagResponse",
+    "GlaresCheckParams",
     "GraphData",
     "GraphicField",
     "GraphicFieldType",
@@ -130,6 +136,11 @@ __all__ = [
     "ListVerifiedFieldsItem",
     "LivenessParams",
     "LogLevel",
+    "MDLDeviceEngagement",
+    "MDLDeviceRetrieval",
+    "MDLItem",
+    "MDLResult",
+    "MDLServerRetrieval",
     "MRZDetectorResult",
     "MRZFormat",
     "MRZPositionResult",
@@ -138,6 +149,7 @@ __all__ = [
     "MRZTestQualityItem",
     "MRZTestQualityResult",
     "MeasureSystem",
+    "Message",
     "MrzDetectModeEnum",
     "MrzPositionItem",
     "OCRSecurityTextItem",
@@ -148,6 +160,7 @@ __all__ = [
     "OutData",
     "OutDataTransactionImagesFieldValue",
     "PArrayField",
+    "PID",
     "ParsedData",
     "ParsingErrorCodes",
     "ParsingNotificationCodes",
@@ -245,6 +258,14 @@ __all__ = [
     "TransactionProcessResult",
     "TrfFtBytes",
     "TrfFtString",
+    "VDItem",
+    "VDSData",
+    "VDSDataItem",
+    "VDSDataResult",
+    "VDSNCData",
+    "VDSNCDataItem",
+    "VDSNCDataResult",
+    "VEItem",
     "VerificationResult",
     "VerifiedFieldMap",
     "Visibility",
@@ -255,6 +276,7 @@ if __import__("typing").TYPE_CHECKING:
     # import apis into sdk package
     from regula.documentreader.webclient.gen.api.healthcheck_api import HealthcheckApi as HealthcheckApi
     from regula.documentreader.webclient.gen.api.process_api import ProcessApi as ProcessApi
+    from regula.documentreader.webclient.gen.api.resources_api import ResourcesApi as ResourcesApi
     from regula.documentreader.webclient.gen.api.transaction_api import TransactionApi as TransactionApi
     
     # import ApiClient
@@ -299,6 +321,9 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.critical import Critical as Critical
     from regula.documentreader.webclient.gen.models.cross_source_value_comparison import CrossSourceValueComparison as CrossSourceValueComparison
     from regula.documentreader.webclient.gen.models.data_module import DataModule as DataModule
+    from regula.documentreader.webclient.gen.models.database_document import DatabaseDocument as DatabaseDocument
+    from regula.documentreader.webclient.gen.models.database_document_list import DatabaseDocumentList as DatabaseDocumentList
+    from regula.documentreader.webclient.gen.models.details_age import DetailsAge as DetailsAge
     from regula.documentreader.webclient.gen.models.details_optical import DetailsOptical as DetailsOptical
     from regula.documentreader.webclient.gen.models.details_rfid import DetailsRFID as DetailsRFID
     from regula.documentreader.webclient.gen.models.device_info import DeviceInfo as DeviceInfo
@@ -306,6 +331,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.doc_bar_code_info import DocBarCodeInfo as DocBarCodeInfo
     from regula.documentreader.webclient.gen.models.doc_bar_code_info_fields_list import DocBarCodeInfoFieldsList as DocBarCodeInfoFieldsList
     from regula.documentreader.webclient.gen.models.doc_bar_code_info_item import DocBarCodeInfoItem as DocBarCodeInfoItem
+    from regula.documentreader.webclient.gen.models.doc_feature import DocFeature as DocFeature
     from regula.documentreader.webclient.gen.models.doc_graphics_info_item import DocGraphicsInfoItem as DocGraphicsInfoItem
     from regula.documentreader.webclient.gen.models.doc_visual_extended_field import DocVisualExtendedField as DocVisualExtendedField
     from regula.documentreader.webclient.gen.models.doc_visual_extended_field_item import DocVisualExtendedFieldItem as DocVisualExtendedFieldItem
@@ -339,6 +365,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.field_item import FieldItem as FieldItem
     from regula.documentreader.webclient.gen.models.file_image import FileImage as FileImage
     from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse as GetTransactionsByTagResponse
+    from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams as GlaresCheckParams
     from regula.documentreader.webclient.gen.models.graph_data import GraphData as GraphData
     from regula.documentreader.webclient.gen.models.graphic_field import GraphicField as GraphicField
     from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType as GraphicFieldType
@@ -377,6 +404,11 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.list_verified_fields_item import ListVerifiedFieldsItem as ListVerifiedFieldsItem
     from regula.documentreader.webclient.gen.models.liveness_params import LivenessParams as LivenessParams
     from regula.documentreader.webclient.gen.models.log_level import LogLevel as LogLevel
+    from regula.documentreader.webclient.gen.models.mdl_device_engagement import MDLDeviceEngagement as MDLDeviceEngagement
+    from regula.documentreader.webclient.gen.models.mdl_device_retrieval import MDLDeviceRetrieval as MDLDeviceRetrieval
+    from regula.documentreader.webclient.gen.models.mdl_item import MDLItem as MDLItem
+    from regula.documentreader.webclient.gen.models.mdl_result import MDLResult as MDLResult
+    from regula.documentreader.webclient.gen.models.mdl_server_retrieval import MDLServerRetrieval as MDLServerRetrieval
     from regula.documentreader.webclient.gen.models.mrz_detector_result import MRZDetectorResult as MRZDetectorResult
     from regula.documentreader.webclient.gen.models.mrz_format import MRZFormat as MRZFormat
     from regula.documentreader.webclient.gen.models.mrz_position_result import MRZPositionResult as MRZPositionResult
@@ -385,6 +417,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.mrz_test_quality_item import MRZTestQualityItem as MRZTestQualityItem
     from regula.documentreader.webclient.gen.models.mrz_test_quality_result import MRZTestQualityResult as MRZTestQualityResult
     from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem as MeasureSystem
+    from regula.documentreader.webclient.gen.models.message import Message as Message
     from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzDetectModeEnum as MrzDetectModeEnum
     from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem as MrzPositionItem
     from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem as OCRSecurityTextItem
@@ -395,6 +428,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.out_data import OutData as OutData
     from regula.documentreader.webclient.gen.models.out_data_transaction_images_field_value import OutDataTransactionImagesFieldValue as OutDataTransactionImagesFieldValue
     from regula.documentreader.webclient.gen.models.p_array_field import PArrayField as PArrayField
+    from regula.documentreader.webclient.gen.models.pid import PID as PID
     from regula.documentreader.webclient.gen.models.parsed_data import ParsedData as ParsedData
     from regula.documentreader.webclient.gen.models.parsing_error_codes import ParsingErrorCodes as ParsingErrorCodes
     from regula.documentreader.webclient.gen.models.parsing_notification_codes import ParsingNotificationCodes as ParsingNotificationCodes
@@ -492,6 +526,14 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.transaction_process_result import TransactionProcessResult as TransactionProcessResult
     from regula.documentreader.webclient.gen.models.trf_ft_bytes import TrfFtBytes as TrfFtBytes
     from regula.documentreader.webclient.gen.models.trf_ft_string import TrfFtString as TrfFtString
+    from regula.documentreader.webclient.gen.models.vd_item import VDItem as VDItem
+    from regula.documentreader.webclient.gen.models.vds_data import VDSData as VDSData
+    from regula.documentreader.webclient.gen.models.vds_data_item import VDSDataItem as VDSDataItem
+    from regula.documentreader.webclient.gen.models.vds_data_result import VDSDataResult as VDSDataResult
+    from regula.documentreader.webclient.gen.models.vdsnc_data import VDSNCData as VDSNCData
+    from regula.documentreader.webclient.gen.models.vdsnc_data_item import VDSNCDataItem as VDSNCDataItem
+    from regula.documentreader.webclient.gen.models.vdsnc_data_result import VDSNCDataResult as VDSNCDataResult
+    from regula.documentreader.webclient.gen.models.ve_item import VEItem as VEItem
     from regula.documentreader.webclient.gen.models.verification_result import VerificationResult as VerificationResult
     from regula.documentreader.webclient.gen.models.verified_field_map import VerifiedFieldMap as VerifiedFieldMap
     from regula.documentreader.webclient.gen.models.visibility import Visibility as Visibility
@@ -508,6 +550,7 @@ else:
             """# import apis into sdk package
 from regula.documentreader.webclient.gen.api.healthcheck_api import HealthcheckApi as HealthcheckApi
 from regula.documentreader.webclient.gen.api.process_api import ProcessApi as ProcessApi
+from regula.documentreader.webclient.gen.api.resources_api import ResourcesApi as ResourcesApi
 from regula.documentreader.webclient.gen.api.transaction_api import TransactionApi as TransactionApi
 
 # import ApiClient
@@ -552,6 +595,9 @@ from regula.documentreader.webclient.gen.models.container_list_list_inner import
 from regula.documentreader.webclient.gen.models.critical import Critical as Critical
 from regula.documentreader.webclient.gen.models.cross_source_value_comparison import CrossSourceValueComparison as CrossSourceValueComparison
 from regula.documentreader.webclient.gen.models.data_module import DataModule as DataModule
+from regula.documentreader.webclient.gen.models.database_document import DatabaseDocument as DatabaseDocument
+from regula.documentreader.webclient.gen.models.database_document_list import DatabaseDocumentList as DatabaseDocumentList
+from regula.documentreader.webclient.gen.models.details_age import DetailsAge as DetailsAge
 from regula.documentreader.webclient.gen.models.details_optical import DetailsOptical as DetailsOptical
 from regula.documentreader.webclient.gen.models.details_rfid import DetailsRFID as DetailsRFID
 from regula.documentreader.webclient.gen.models.device_info import DeviceInfo as DeviceInfo
@@ -559,6 +605,7 @@ from regula.documentreader.webclient.gen.models.device_info_documents_database i
 from regula.documentreader.webclient.gen.models.doc_bar_code_info import DocBarCodeInfo as DocBarCodeInfo
 from regula.documentreader.webclient.gen.models.doc_bar_code_info_fields_list import DocBarCodeInfoFieldsList as DocBarCodeInfoFieldsList
 from regula.documentreader.webclient.gen.models.doc_bar_code_info_item import DocBarCodeInfoItem as DocBarCodeInfoItem
+from regula.documentreader.webclient.gen.models.doc_feature import DocFeature as DocFeature
 from regula.documentreader.webclient.gen.models.doc_graphics_info_item import DocGraphicsInfoItem as DocGraphicsInfoItem
 from regula.documentreader.webclient.gen.models.doc_visual_extended_field import DocVisualExtendedField as DocVisualExtendedField
 from regula.documentreader.webclient.gen.models.doc_visual_extended_field_item import DocVisualExtendedFieldItem as DocVisualExtendedFieldItem
@@ -592,6 +639,7 @@ from regula.documentreader.webclient.gen.models.fiber_result import FiberResult
 from regula.documentreader.webclient.gen.models.field_item import FieldItem as FieldItem
 from regula.documentreader.webclient.gen.models.file_image import FileImage as FileImage
 from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse as GetTransactionsByTagResponse
+from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams as GlaresCheckParams
 from regula.documentreader.webclient.gen.models.graph_data import GraphData as GraphData
 from regula.documentreader.webclient.gen.models.graphic_field import GraphicField as GraphicField
 from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType as GraphicFieldType
@@ -630,6 +678,11 @@ from regula.documentreader.webclient.gen.models.list_verified_fields import List
 from regula.documentreader.webclient.gen.models.list_verified_fields_item import ListVerifiedFieldsItem as ListVerifiedFieldsItem
 from regula.documentreader.webclient.gen.models.liveness_params import LivenessParams as LivenessParams
 from regula.documentreader.webclient.gen.models.log_level import LogLevel as LogLevel
+from regula.documentreader.webclient.gen.models.mdl_device_engagement import MDLDeviceEngagement as MDLDeviceEngagement
+from regula.documentreader.webclient.gen.models.mdl_device_retrieval import MDLDeviceRetrieval as MDLDeviceRetrieval
+from regula.documentreader.webclient.gen.models.mdl_item import MDLItem as MDLItem
+from regula.documentreader.webclient.gen.models.mdl_result import MDLResult as MDLResult
+from regula.documentreader.webclient.gen.models.mdl_server_retrieval import MDLServerRetrieval as MDLServerRetrieval
 from regula.documentreader.webclient.gen.models.mrz_detector_result import MRZDetectorResult as MRZDetectorResult
 from regula.documentreader.webclient.gen.models.mrz_format import MRZFormat as MRZFormat
 from regula.documentreader.webclient.gen.models.mrz_position_result import MRZPositionResult as MRZPositionResult
@@ -638,6 +691,7 @@ from regula.documentreader.webclient.gen.models.mrz_test_quality import MRZTestQ
 from regula.documentreader.webclient.gen.models.mrz_test_quality_item import MRZTestQualityItem as MRZTestQualityItem
 from regula.documentreader.webclient.gen.models.mrz_test_quality_result import MRZTestQualityResult as MRZTestQualityResult
 from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem as MeasureSystem
+from regula.documentreader.webclient.gen.models.message import Message as Message
 from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzDetectModeEnum as MrzDetectModeEnum
 from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem as MrzPositionItem
 from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem as OCRSecurityTextItem
@@ -648,6 +702,7 @@ from regula.documentreader.webclient.gen.models.original_symbol import OriginalS
 from regula.documentreader.webclient.gen.models.out_data import OutData as OutData
 from regula.documentreader.webclient.gen.models.out_data_transaction_images_field_value import OutDataTransactionImagesFieldValue as OutDataTransactionImagesFieldValue
 from regula.documentreader.webclient.gen.models.p_array_field import PArrayField as PArrayField
+from regula.documentreader.webclient.gen.models.pid import PID as PID
 from regula.documentreader.webclient.gen.models.parsed_data import ParsedData as ParsedData
 from regula.documentreader.webclient.gen.models.parsing_error_codes import ParsingErrorCodes as ParsingErrorCodes
 from regula.documentreader.webclient.gen.models.parsing_notification_codes import ParsingNotificationCodes as ParsingNotificationCodes
@@ -745,6 +800,14 @@ from regula.documentreader.webclient.gen.models.transaction_process_request impo
 from regula.documentreader.webclient.gen.models.transaction_process_result import TransactionProcessResult as TransactionProcessResult
 from regula.documentreader.webclient.gen.models.trf_ft_bytes import TrfFtBytes as TrfFtBytes
 from regula.documentreader.webclient.gen.models.trf_ft_string import TrfFtString as TrfFtString
+from regula.documentreader.webclient.gen.models.vd_item import VDItem as VDItem
+from regula.documentreader.webclient.gen.models.vds_data import VDSData as VDSData
+from regula.documentreader.webclient.gen.models.vds_data_item import VDSDataItem as VDSDataItem
+from regula.documentreader.webclient.gen.models.vds_data_result import VDSDataResult as VDSDataResult
+from regula.documentreader.webclient.gen.models.vdsnc_data import VDSNCData as VDSNCData
+from regula.documentreader.webclient.gen.models.vdsnc_data_item import VDSNCDataItem as VDSNCDataItem
+from regula.documentreader.webclient.gen.models.vdsnc_data_result import VDSNCDataResult as VDSNCDataResult
+from regula.documentreader.webclient.gen.models.ve_item import VEItem as VEItem
 from regula.documentreader.webclient.gen.models.verification_result import VerificationResult as VerificationResult
 from regula.documentreader.webclient.gen.models.verified_field_map import VerifiedFieldMap as VerifiedFieldMap
 from regula.documentreader.webclient.gen.models.visibility import Visibility as Visibility

{regula_documentreader_webclient-8.4.515.dev0 → regula_documentreader_webclient-9.2.659.dev0}/regula/documentreader/webclient/gen/api/__init__.py

@@ -4,6 +4,7 @@ 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:
@@ -15,6 +16,7 @@ else:
             """# 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
 
 """,

regula_documentreader_webclient-9.2.659.dev0/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-8.4.515.dev0 → regula_documentreader_webclient-9.2.659.dev0}/regula/documentreader/webclient/gen/api/transaction_api.py

@@ -1107,6 +1107,7 @@ class TransactionApi:
         self,
         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)],
@@ -1127,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
@@ -1152,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,
@@ -1179,6 +1183,7 @@ class TransactionApi:
         self,
         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)],
@@ -1199,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
@@ -1224,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,
@@ -1251,6 +1259,7 @@ class TransactionApi:
         self,
         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)],
@@ -1271,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
@@ -1296,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,
@@ -1318,6 +1330,7 @@ class TransactionApi:
         self,
         transaction_id,
         transaction_process_request,
+        use_cache,
         _request_auth,
         _content_type,
         _headers,
@@ -1342,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