regula-documentreader-webclient 8.4.557rc0__tar.gz → 8.4.558rc0__tar.gz

{regula_documentreader_webclient-8.4.557rc0 → regula_documentreader_webclient-8.4.558rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 8.4.557rc0
+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.557rc0 → regula_documentreader_webclient-8.4.558rc0}/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.557rc0 → regula_documentreader_webclient-8.4.558rc0}/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",
@@ -92,6 +95,7 @@ __all__ = [
     "FieldItem",
     "FileImage",
     "GetTransactionsByTagResponse",
+    "GlaresCheckParams",
     "GraphData",
     "GraphicField",
     "GraphicFieldType",
@@ -255,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
@@ -299,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
@@ -339,6 +346,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
@@ -508,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
@@ -552,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
@@ -592,6 +603,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

{regula_documentreader_webclient-8.4.557rc0 → regula_documentreader_webclient-8.4.558rc0}/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-8.4.558rc0/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.557rc0 → regula_documentreader_webclient-8.4.558rc0}/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-8.4.557rc0 → regula_documentreader_webclient-8.4.558rc0}/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
@@ -77,6 +79,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.field_item import FieldItem
     from regula.documentreader.webclient.gen.models.file_image import FileImage
     from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse
+    from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams
     from regula.documentreader.webclient.gen.models.graph_data import GraphData
     from regula.documentreader.webclient.gen.models.graphic_field import GraphicField
     from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType
@@ -272,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
@@ -312,6 +317,7 @@ from regula.documentreader.webclient.gen.models.fiber_result import FiberResult
 from regula.documentreader.webclient.gen.models.field_item import FieldItem
 from regula.documentreader.webclient.gen.models.file_image import FileImage
 from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse
+from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams
 from regula.documentreader.webclient.gen.models.graph_data import GraphData
 from regula.documentreader.webclient.gen.models.graphic_field import GraphicField
 from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType

{regula_documentreader_webclient-8.4.557rc0 → regula_documentreader_webclient-8.4.558rc0}/regula/documentreader/webclient/gen/models/check_diagnose.py

@@ -68,6 +68,8 @@ class CheckDiagnose(int, Enum):
     FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR = 84
     FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR = 85
     FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION = 86
+    FIELD_POS_CORRECTOR_AGE_CHECK_ERROR = 87
+    FIELD_POS_CORRECTOR_SEX_CHECK_ERROR = 88
     OVI_IR_INVISIBLE = 90
     OVI_INSUFFICIENT_AREA = 91
     OVI_COLOR_INVARIABLE = 92

regula_documentreader_webclient-8.4.558rc0/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
+
+