regula-documentreader-webclient 8.4.556.dev0__py3-none-any.whl → 8.4.558rc0__py3-none-any.whl

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/gen/__init__.py

@@ -12,6 +12,7 @@ __version__ = "1.0.0"
 __all__ = [
     "HealthcheckApi",
     "ProcessApi",
+    "ResourcesApi",
     "TransactionApi",
     "ApiResponse",
     "ApiClient",
@@ -52,6 +53,8 @@ __all__ = [
     "Critical",
     "CrossSourceValueComparison",
     "DataModule",
+    "DatabaseDocument",
+    "DatabaseDocumentList",
     "DetailsOptical",
     "DetailsRFID",
     "DeviceInfo",
@@ -256,6 +259,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
@@ -300,6 +304,8 @@ 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_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
@@ -510,6 +516,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
@@ -554,6 +561,8 @@ 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_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

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/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

@@ -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

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

@@ -37,6 +37,8 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.critical import Critical
     from regula.documentreader.webclient.gen.models.cross_source_value_comparison import CrossSourceValueComparison
     from regula.documentreader.webclient.gen.models.data_module import DataModule
+    from regula.documentreader.webclient.gen.models.database_document import DatabaseDocument
+    from regula.documentreader.webclient.gen.models.database_document_list import DatabaseDocumentList
     from regula.documentreader.webclient.gen.models.details_optical import DetailsOptical
     from regula.documentreader.webclient.gen.models.details_rfid import DetailsRFID
     from regula.documentreader.webclient.gen.models.device_info import DeviceInfo
@@ -273,6 +275,8 @@ from regula.documentreader.webclient.gen.models.container_list_list_inner import
 from regula.documentreader.webclient.gen.models.critical import Critical
 from regula.documentreader.webclient.gen.models.cross_source_value_comparison import CrossSourceValueComparison
 from regula.documentreader.webclient.gen.models.data_module import DataModule
+from regula.documentreader.webclient.gen.models.database_document import DatabaseDocument
+from regula.documentreader.webclient.gen.models.database_document_list import DatabaseDocumentList
 from regula.documentreader.webclient.gen.models.details_optical import DetailsOptical
 from regula.documentreader.webclient.gen.models.details_rfid import DetailsRFID
 from regula.documentreader.webclient.gen.models.device_info import DeviceInfo

regula/documentreader/webclient/gen/models/database_document.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.document_type import DocumentType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class DatabaseDocument(BaseModel):
+    """
+    DatabaseDocument
+    """ # noqa: E501
+    barcode_fields: SkipValidation[bool] = Field(alias="barcode_fields", description="Whether the document has a barcode.")
+    country: SkipValidation[str] = Field(alias="country", description="Country name.")
+    createad: SkipValidation[str] = Field(alias="createad", description="Date when the document description was created in the database.")
+    doc_type: SkipValidation[DocumentType] = Field(alias="doc_type")
+    document: SkipValidation[str] = Field(alias="document", description="Document name.")
+    graphic_fields: SkipValidation[bool] = Field(alias="graphic_fields", description="The presence of graphic fields in the document.")
+    id: SkipValidation[int] = Field(alias="id", description="Document code.")
+    mrz: SkipValidation[bool] = Field(alias="mrz", description="The document has an MRZ.")
+    region: SkipValidation[Optional[str]] = Field(alias="region", default=None, description="Country region.")
+    rfid_chip: SkipValidation[bool] = Field(alias="rfid_chip", description="The document has an RFID chip.")
+    text_fields: SkipValidation[bool] = Field(alias="text_fields", description="The presence of text fields in the document.")
+    updated: SkipValidation[str] = Field(alias="updated", description="Date when the document description was updated in the database.")
+    year: SkipValidation[Optional[str]] = Field(alias="year", default=None, description="The year when the document was issued.")
+    sovereignty: SkipValidation[Optional[str]] = Field(alias="sovereignty", default=None, description="Guardian country.")
+    deprecated: SkipValidation[Optional[bool]] = Field(alias="deprecated", default=None, description="Whether the document is no longer in circulation.")
+    __properties: ClassVar[List[str]] = ["barcode_fields", "country", "createad", "doc_type", "document", "graphic_fields", "id", "mrz", "region", "rfid_chip", "text_fields", "updated", "year", "sovereignty", "deprecated"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DatabaseDocument from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatabaseDocument from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "barcode_fields": obj.get("barcode_fields"),
+            "country": obj.get("country"),
+            "createad": obj.get("createad"),
+            "doc_type": obj.get("doc_type"),
+            "document": obj.get("document"),
+            "graphic_fields": obj.get("graphic_fields"),
+            "id": obj.get("id"),
+            "mrz": obj.get("mrz"),
+            "region": obj.get("region"),
+            "rfid_chip": obj.get("rfid_chip"),
+            "text_fields": obj.get("text_fields"),
+            "updated": obj.get("updated"),
+            "year": obj.get("year"),
+            "sovereignty": obj.get("sovereignty"),
+            "deprecated": obj.get("deprecated")
+        })
+        return _obj
+
+

regula/documentreader/webclient/gen/models/database_document_list.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.database_document import DatabaseDocument
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class DatabaseDocumentList(BaseModel):
+    """
+    DatabaseDocumentList
+    """ # noqa: E501
+    items: SkipValidation[List[DatabaseDocument]] = Field(alias="items", description="The list of documents stored in the database.")
+    __properties: ClassVar[List[str]] = ["items"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DatabaseDocumentList from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatabaseDocumentList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "items": [DatabaseDocument.from_dict(_item) for _item in obj.get("items", []) if DatabaseDocument.from_dict(_item) is not None]
+        })
+        return _obj
+
+

regula/documentreader/webclient/gen/models/process_params.py

@@ -101,7 +101,8 @@ class ProcessParams(BaseModel):
     pdf_pages_limit: SkipValidation[Optional[int]] = Field(alias="pdfPagesLimit", default=None, description="Limits the number of pages to be processed from a PDF file.")
     disable_auth_resolution_filter: SkipValidation[Optional[bool]] = Field(alias="disableAuthResolutionFilter", default=None, description="This parameter if enabled will ignore the minimum barcode resolution needed to start processing.")
     strict_security_checks: SkipValidation[Optional[bool]] = Field(alias="strictSecurityChecks", default=None, description="When enabled, this parameter marks security checks that don’t meet minimum requirements as 'Failed' (instead of 'WasNotDone'), which causes the overall security status to be 'Failed'.")
-    __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry", "generateAlpha2Codes", "pdfPagesLimit", "disableAuthResolutionFilter", "strictSecurityChecks"]
+    return_transliterated_fields: SkipValidation[Optional[bool]] = Field(alias="returnTransliteratedFields", default=None, description="Allows transliteration to be turned on or off; by default, it is enabled.")
+    __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry", "generateAlpha2Codes", "pdfPagesLimit", "disableAuthResolutionFilter", "strictSecurityChecks", "returnTransliteratedFields"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -239,7 +240,8 @@ class ProcessParams(BaseModel):
             "generateAlpha2Codes": obj.get("generateAlpha2Codes"),
             "pdfPagesLimit": obj.get("pdfPagesLimit"),
             "disableAuthResolutionFilter": obj.get("disableAuthResolutionFilter"),
-            "strictSecurityChecks": obj.get("strictSecurityChecks")
+            "strictSecurityChecks": obj.get("strictSecurityChecks"),
+            "returnTransliteratedFields": obj.get("returnTransliteratedFields")
         })
         return _obj
 

{regula_documentreader_webclient-8.4.556.dev0.dist-info → regula_documentreader_webclient-8.4.558rc0.dist-info}/METADATA

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

{regula_documentreader_webclient-8.4.556.dev0.dist-info → regula_documentreader_webclient-8.4.558rc0.dist-info}/RECORD

@@ -3,7 +3,7 @@ regula/documentreader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 regula/documentreader/webclient/__init__.py,sha256=9hNPg8FLQRyDZAueC34R9NnYD6krtWSlnUczVs-jYyU,100
 regula/documentreader/webclient/ext/__init__.py,sha256=9ahgPOBtNOMhuCo7I0FqNOlrlUfoHq1rQucZcEF6bnQ,1119
 regula/documentreader/webclient/ext/api/__init__.py,sha256=Xzygo6zcLQaUJmchHGc2awK1kGwgIcqdBBqexU8iZfI,90
-regula/documentreader/webclient/ext/api/document_reader_api.py,sha256=oXapG6vVGn8EtuyGmDkERulgdCfphVG0JmH2Nd9Ays0,2292
+regula/documentreader/webclient/ext/api/document_reader_api.py,sha256=WTEGSAsvwkzXnIzjGBrLYYBwJzuN9yCehJwrMLrRBd4,2352
 regula/documentreader/webclient/ext/models/__init__.py,sha256=c8SIj9HZVotag-5rsFbSeQdTAD_kkCe4POpf6WHgSs0,1103
 regula/documentreader/webclient/ext/models/images.py,sha256=x4BU2eQoE7AlDskSFlXHzMDJtEUldiN84VHyxWoN980,1409
 regula/documentreader/webclient/ext/models/recognition_request.py,sha256=GWOhOqSm8weoo4ngHK1G1sKbmCpxmy1O33RhooCTpMQ,3385
@@ -17,18 +17,19 @@ regula/documentreader/webclient/ext/models/authenticity/ident.py,sha256=DSmXEJ-v
 regula/documentreader/webclient/ext/models/authenticity/image_ident.py,sha256=QmKTghP4Lo7bHBEubwzsVt1ob97NNaNIu_5QN_LUF9M,370
 regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py,sha256=BV0h2_UDrwUlWczoJQW8qTSkdZ0icm0n0pPDRY9Qwq4,407
 regula/documentreader/webclient/ext/models/authenticity/security_feature.py,sha256=t8egDyT1wlGvsyvZboAFOvcaYsALGpj41E50FUbvx68,622
-regula/documentreader/webclient/gen/__init__.py,sha256=GCZqiHii-kQ6CTxfkpCwcKqW7S9v2jJutKst8bxS8a4,60707
+regula/documentreader/webclient/gen/__init__.py,sha256=gR3bW_kkK7ZSqQUbUYhdc0S9Y2wX9QFnR0pjkJ22Amw,61447
 regula/documentreader/webclient/gen/api_client.py,sha256=BZ1SIy0PwA4khadeMet9fNj8pt1j_OaaebUSHChq31k,27673
 regula/documentreader/webclient/gen/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
 regula/documentreader/webclient/gen/configuration.py,sha256=0hMqlAxYaL30050LBPnHrh6Sg1EIfSfQLr0eGNRNz1w,18084
 regula/documentreader/webclient/gen/exceptions.py,sha256=fYFXlhg-wAlI9z7BBe-1Eifxm9tiBONwsXkH_VMq4RE,6228
 regula/documentreader/webclient/gen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 regula/documentreader/webclient/gen/rest.py,sha256=y7sJJqeEmZH-cdSovKzh4w3GhJZ7-fQH6C9tNr7NLao,9246
-regula/documentreader/webclient/gen/api/__init__.py,sha256=v4_OMiqFnSqq6QQtO51dXylWfQroQu9OxkAwog10xmM,839
+regula/documentreader/webclient/gen/api/__init__.py,sha256=tV8dT21wd7mWggGTykkC8-V4TIMw8VrGcy8GmHXpQmU,1001
 regula/documentreader/webclient/gen/api/healthcheck_api.py,sha256=g3Q3XsdgYfEmmdgnnspRX5DluONia4bDANKUZLRMMlQ,29942
 regula/documentreader/webclient/gen/api/process_api.py,sha256=RnJXVZy-M1bNfiXK0tHEQEuhOgxkXk9jMG-hpZfTjZ8,12123
-regula/documentreader/webclient/gen/api/transaction_api.py,sha256=lVfSEe4-iWrP_2gdQ3Pg5XJu9MNtKK7fyKJC-M0y8Rk,65548
-regula/documentreader/webclient/gen/models/__init__.py,sha256=CA-hi89GT7USlPrYyOtazj0BGeMQtWFPU1pDID5dLWk,43117
+regula/documentreader/webclient/gen/api/resources_api.py,sha256=grQfqv8hZNJnR1hC72jG614D_Y9MDn3sMyZYWllk15U,10264
+regula/documentreader/webclient/gen/api/transaction_api.py,sha256=53uZvktOfFNr_b9iWYR0AqD4YGTzvVtfUa25ir5ooqE,66657
+regula/documentreader/webclient/gen/models/__init__.py,sha256=PDtw9Ds3a-mP2OnXUz8mIwyPHRJJZyQVt-8a5GFShU0,43503
 regula/documentreader/webclient/gen/models/area_array.py,sha256=cWpxUR1lpgj1UalajIiU8s3OjhWEZqYli9bV02ixT2M,3684
 regula/documentreader/webclient/gen/models/area_container.py,sha256=E6e1gPW516A0KCAmHm05ad_I0yD3FauruZgNxU-EIdA,3665
 regula/documentreader/webclient/gen/models/auth_params.py,sha256=XY1Exfwh68u6FKGhZdjnzHPmB2pFlKxiywcV7f5dj2E,6743
@@ -59,6 +60,8 @@ regula/documentreader/webclient/gen/models/container_list_list_inner.py,sha256=Q
 regula/documentreader/webclient/gen/models/critical.py,sha256=u_jXlQuCjH5mDzT79bswOCm3-mv3uGfd345QHRLIopk,564
 regula/documentreader/webclient/gen/models/cross_source_value_comparison.py,sha256=vErGJnUVL1wFNng3-9vZT6j9JRt4O_n40awdZf8hIPc,2849
 regula/documentreader/webclient/gen/models/data_module.py,sha256=gprIbhcuGDWFrfYyncW0XmkpUzm7k9bPsyebQQbJ8gs,3017
+regula/documentreader/webclient/gen/models/database_document.py,sha256=-Feuit0SvCg47y3FpPQUkNbinpUFRsg4lgO2g_egRuY,4970
+regula/documentreader/webclient/gen/models/database_document_list.py,sha256=6cW6klu0XBCoQgjUb3o92XIWMnRNWKHsjn-aR_A1p1U,2983
 regula/documentreader/webclient/gen/models/details_optical.py,sha256=4BqIREpkP_KLFjr7g5poV_juFOiv3sn9HSb016-mioE,3531
 regula/documentreader/webclient/gen/models/details_rfid.py,sha256=0E9egs-_npBsr5C9obstMx9ebRypofQg6f15_IkQwgU,3095
 regula/documentreader/webclient/gen/models/device_info.py,sha256=ug5JWmmRuwRuRZygdK6kzskEOWHNgCjfLR-O0ewzVX8,4594
@@ -165,7 +168,7 @@ regula/documentreader/webclient/gen/models/photo_ident_result.py,sha256=_BD7dYR8
 regula/documentreader/webclient/gen/models/point.py,sha256=TBIznHwx7KPGeWBoA9uGcQks_zYsm17w2AuQyagz9QU,2402
 regula/documentreader/webclient/gen/models/point_array.py,sha256=m7QaOSsfbOzL6Skd8dWdvJjMJrwGVJxqnqxVg0XaM8A,2893
 regula/documentreader/webclient/gen/models/points_container.py,sha256=4zYuorTsQpbPDHwcVlJVtfNj9sc6g9h5b1idHnRQEVU,3086
-regula/documentreader/webclient/gen/models/process_params.py,sha256=A6M_avvqWz9eTPl73gORfQsEZ4aWDk2VZ2buTsaUuEA,26118
+regula/documentreader/webclient/gen/models/process_params.py,sha256=_IIfhL56wNf1qZxGtEMNo3CZKjMsI8zdMA1HKoz53HM,26441
 regula/documentreader/webclient/gen/models/process_params_rfid.py,sha256=Uafaa-fWJi3_L49C_KsOnaOyB1c76qsFqzeUsfDrOug,2782
 regula/documentreader/webclient/gen/models/process_request.py,sha256=mfrFQREqd9MPBFnDbhr464tasA_6qncUbzc-bDX1wDA,6132
 regula/documentreader/webclient/gen/models/process_request_image.py,sha256=66CDZtzqPDrQQsl6GVzhbLvwaR2WUm_yvT2H_QzrqzQ,3148
@@ -260,7 +263,7 @@ regula/documentreader/webclient/gen/models/verification_result.py,sha256=E6bCVR5
 regula/documentreader/webclient/gen/models/verified_field_map.py,sha256=QjCCjZ82WhT5uzdFthwfiX4Kgi5RL_m7E0NprLhHAJs,4863
 regula/documentreader/webclient/gen/models/visibility.py,sha256=GACgQd_8lx_cwMwI5lCi7cTxEWxw2atbJo6uI4mTKpQ,602
 regula/documentreader/webclient/gen/models/visual_extended_field_item.py,sha256=ym9y5RWEoE_92NrJfcrKA6OCtE_E8IOuiRHF2Ar3EQc,5245
-regula_documentreader_webclient-8.4.556.dev0.dist-info/METADATA,sha256=biEtGzG7KuW5CyIOYPA8v3MvVd9aq_FIJSC1crD58zI,4036
-regula_documentreader_webclient-8.4.556.dev0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
-regula_documentreader_webclient-8.4.556.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
-regula_documentreader_webclient-8.4.556.dev0.dist-info/RECORD,,
+regula_documentreader_webclient-8.4.558rc0.dist-info/METADATA,sha256=0BMTmfezNPURxJJ6CI4s60zpfjMmSi6HFVQJeRtMMng,4034
+regula_documentreader_webclient-8.4.558rc0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
+regula_documentreader_webclient-8.4.558rc0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
+regula_documentreader_webclient-8.4.558rc0.dist-info/RECORD,,