regula-documentreader-webclient 8.1.355rc0__py3-none-any.whl → 8.1.357.dev0__py3-none-any.whl

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

@@ -4,256 +4,206 @@
     Generated by: https://openapi-generator.tech
 """
 
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
-
-import six
-
-from regula.documentreader.webclient.gen.configuration import Configuration
-# this line was added to enable pycharm type hinting
-from regula.documentreader.webclient.gen.models import *
-
-
-"""
-Common fields for all result objects
-"""
-class ResultItem(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
+import json
+
+from importlib import import_module
+from pydantic import BaseModel, ConfigDict, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.result import Result
+from typing import Optional, Set
+from typing_extensions import Self
+
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from regula.documentreader.webclient.gen.models.document_image_result import DocumentImageResult
+    from regula.documentreader.webclient.gen.models.document_binary_info_result import DocumentBinaryInfoResult
+    from regula.documentreader.webclient.gen.models.rfid_text_data_result import RFIDTextDataResult
+    from regula.documentreader.webclient.gen.models.graphics_result import GraphicsResult
+    from regula.documentreader.webclient.gen.models.document_binary_info_result import DocumentBinaryInfoResult
+    from regula.documentreader.webclient.gen.models.rfid_graphics_info_result import RFIDGraphicsInfoResult
+    from regula.documentreader.webclient.gen.models.byte_array_result import ByteArrayResult
+    from regula.documentreader.webclient.gen.models.lexical_analysis_result import LexicalAnalysisResult
+    from regula.documentreader.webclient.gen.models.document_image_result import DocumentImageResult
+    from regula.documentreader.webclient.gen.models.text_data_result import TextDataResult
+    from regula.documentreader.webclient.gen.models.text_data_result import TextDataResult
+    from regula.documentreader.webclient.gen.models.graphics_result import GraphicsResult
+    from regula.documentreader.webclient.gen.models.authenticity_result import AuthenticityResult
+    from regula.documentreader.webclient.gen.models.text_data_result import TextDataResult
+    from regula.documentreader.webclient.gen.models.text_data_result import TextDataResult
+    from regula.documentreader.webclient.gen.models.image_quality_result import ImageQualityResult
+    from regula.documentreader.webclient.gen.models.graphics_result import GraphicsResult
+    from regula.documentreader.webclient.gen.models.status_result import StatusResult
+    from regula.documentreader.webclient.gen.models.authenticity_result import AuthenticityResult
+    from regula.documentreader.webclient.gen.models.graphics_result import GraphicsResult
+    from regula.documentreader.webclient.gen.models.text_result import TextResult
+    from regula.documentreader.webclient.gen.models.images_result import ImagesResult
+    from regula.documentreader.webclient.gen.models.graphics_result import GraphicsResult
+    from regula.documentreader.webclient.gen.models.authenticity_result import AuthenticityResult
+    from regula.documentreader.webclient.gen.models.encrypted_rcl_result import EncryptedRCLResult
+    from regula.documentreader.webclient.gen.models.doc_bar_code_info import DocBarCodeInfo
+    from regula.documentreader.webclient.gen.models.license_result import LicenseResult
+    from regula.documentreader.webclient.gen.models.graphics_result import GraphicsResult
+    from regula.documentreader.webclient.gen.models.mrz_position_result import MRZPositionResult
+    from regula.documentreader.webclient.gen.models.document_position_result import DocumentPositionResult
+    from regula.documentreader.webclient.gen.models.mrz_test_quality_result import MRZTestQualityResult
+    from regula.documentreader.webclient.gen.models.document_types_candidates_result import DocumentTypesCandidatesResult
+    from regula.documentreader.webclient.gen.models.document_position_result import DocumentPositionResult
+    from regula.documentreader.webclient.gen.models.mrz_detector_result import MRZDetectorResult
+    from regula.documentreader.webclient.gen.models.chosen_document_type_result import ChosenDocumentTypeResult
+    from regula.documentreader.webclient.gen.models.face_detection_result import FaceDetectionResult
+
+class ResultItem(BaseModel):
     """
-    Attributes:
-      openapi_types (dict): The key is attribute name
-                            and the value is attribute type.
-      attribute_map (dict): The key is attribute name
-                            and the value is json key in definition.
-    """
-    openapi_types = {
-        'buf_length': 'int',
-        'light': 'int',
-        'list_idx': 'int',
-        'page_idx': 'int',
-        'result_type': 'int'
-    }
-
-    attribute_map = {
-        'buf_length': 'buf_length',
-        'light': 'light',
-        'list_idx': 'list_idx',
-        'page_idx': 'page_idx',
-        'result_type': 'result_type'
-    }
-    discriminator_value_class_map = {
-        1 : 'DocumentImageResult',
-        102 : 'TextDataResult',
-        103 : 'GraphicsResult',
-        109 : 'ByteArrayResult',
-        15 : 'LexicalAnalysisResult',
-        16 : 'DocumentImageResult',
-        17 : 'TextDataResult',
-        18 : 'TextDataResult',
-        19 : 'GraphicsResult',
-        20 : 'AuthenticityResult',
-        3 : 'TextDataResult',
-        30 : 'ImageQualityResult',
-        33 : 'StatusResult',
-        34 : 'AuthenticityResult',
-        36 : 'TextResult',
-        37 : 'ImagesResult',
-        39 : 'AuthenticityResult',
-        49 : 'EncryptedRCLResult',
-        5 : 'DocBarCodeInfo',
-        50 : 'LicenseResult',
-        6 : 'GraphicsResult',
-        8 : 'DocumentTypesCandidatesResult',
-        85 : 'DocumentPositionResult',
-        9 : 'ChosenDocumentTypeResult',
+    Common fields for all result objects
+    """ # noqa: E501
+    buf_length: Optional[StrictInt] = None
+    light: Optional[StrictInt] = None
+    list_idx: Optional[StrictInt] = None
+    page_idx: Optional[StrictInt] = None
+    result_type: Result
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    # JSON field name that stores the object type
+    __discriminator_property_name: ClassVar[str] = 'result_type'
+
+    # discriminator mappings
+    __discriminator_value_class_map: ClassVar[Dict[str, str]] = {
+        '1': 'DocumentImageResult','101': 'DocumentBinaryInfoResult','102': 'RFIDTextDataResult','103': 'GraphicsResult','104': 'DocumentBinaryInfoResult','105': 'RFIDGraphicsInfoResult','109': 'ByteArrayResult','15': 'LexicalAnalysisResult','16': 'DocumentImageResult','17': 'TextDataResult','18': 'TextDataResult','19': 'GraphicsResult','20': 'AuthenticityResult','26': 'TextDataResult','3': 'TextDataResult','30': 'ImageQualityResult','32': 'GraphicsResult','33': 'StatusResult','34': 'AuthenticityResult','35': 'GraphicsResult','36': 'TextResult','37': 'ImagesResult','38': 'GraphicsResult','39': 'AuthenticityResult','49': 'EncryptedRCLResult','5': 'DocBarCodeInfo','50': 'LicenseResult','6': 'GraphicsResult','61': 'MRZPositionResult','62': 'DocumentPositionResult','7': 'MRZTestQualityResult','8': 'DocumentTypesCandidatesResult','85': 'DocumentPositionResult','87': 'MRZDetectorResult','9': 'ChosenDocumentTypeResult','97': 'FaceDetectionResult'
     }
 
-    def __init__(self, buf_length=None, light=None, list_idx=None, page_idx=None, result_type=0, local_vars_configuration=None):  # noqa: E501
-        """ResultItem - a model defined in OpenAPI"""  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._buf_length = None
-        self._light = None
-        self._list_idx = None
-        self._page_idx = None
-        self._result_type = None
-        self.discriminator = 'result_type'
-
-        if buf_length is not None:
-            self.buf_length = buf_length
-        if light is not None:
-            self.light = light
-        if list_idx is not None:
-            self.list_idx = list_idx
-        if page_idx is not None:
-            self.page_idx = page_idx
-        self.result_type = result_type
-
-    @property
-    def buf_length(self):
-        """Gets the buf_length of this ResultItem.  # noqa: E501
-
-
-        :return: The buf_length of this ResultItem.  # noqa: E501
-        :rtype: int
-        """
-        return self._buf_length
-
-    @buf_length.setter
-    def buf_length(self, buf_length):
-        """Sets the buf_length of this ResultItem.
-
-
-        :param buf_length: The buf_length of this ResultItem.  # noqa: E501
-        :type buf_length: int
+    @classmethod
+    def get_discriminator_value(cls, obj: Dict[str, Any]) -> Optional[str]:
+        """Returns the discriminator value (object type) of the data"""
+        discriminator_value = obj[cls.__discriminator_property_name]
+        if discriminator_value:
+            return cls.__discriminator_value_class_map.get(str(discriminator_value))
+        else:
+            return None
+
+    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[Union[DocumentImageResult, DocumentBinaryInfoResult, RFIDTextDataResult, GraphicsResult, DocumentBinaryInfoResult, RFIDGraphicsInfoResult, ByteArrayResult, LexicalAnalysisResult, DocumentImageResult, TextDataResult, TextDataResult, GraphicsResult, AuthenticityResult, TextDataResult, TextDataResult, ImageQualityResult, GraphicsResult, StatusResult, AuthenticityResult, GraphicsResult, TextResult, ImagesResult, GraphicsResult, AuthenticityResult, EncryptedRCLResult, DocBarCodeInfo, LicenseResult, GraphicsResult, MRZPositionResult, DocumentPositionResult, MRZTestQualityResult, DocumentTypesCandidatesResult, DocumentPositionResult, MRZDetectorResult, ChosenDocumentTypeResult, FaceDetectionResult]]:
+        """Create an instance of ResultItem 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: Dict[str, Any]) -> Optional[Union[DocumentImageResult, DocumentBinaryInfoResult, RFIDTextDataResult, GraphicsResult, DocumentBinaryInfoResult, RFIDGraphicsInfoResult, ByteArrayResult, LexicalAnalysisResult, DocumentImageResult, TextDataResult, TextDataResult, GraphicsResult, AuthenticityResult, TextDataResult, TextDataResult, ImageQualityResult, GraphicsResult, StatusResult, AuthenticityResult, GraphicsResult, TextResult, ImagesResult, GraphicsResult, AuthenticityResult, EncryptedRCLResult, DocBarCodeInfo, LicenseResult, GraphicsResult, MRZPositionResult, DocumentPositionResult, MRZTestQualityResult, DocumentTypesCandidatesResult, DocumentPositionResult, MRZDetectorResult, ChosenDocumentTypeResult, FaceDetectionResult]]:
+        """Create an instance of ResultItem from a dict"""
+        # look up the object type based on discriminator mapping
+        object_type = cls.get_discriminator_value(obj)
+        if object_type ==  'DocumentImageResult':
+            return import_module("regula.documentreader.webclient.gen.models.document_image_result").DocumentImageResult.from_dict(obj)
+        if object_type ==  'DocumentBinaryInfoResult':
+            return import_module("regula.documentreader.webclient.gen.models.document_binary_info_result").DocumentBinaryInfoResult.from_dict(obj)
+        if object_type ==  'RFIDTextDataResult':
+            return import_module("regula.documentreader.webclient.gen.models.rfid_text_data_result").RFIDTextDataResult.from_dict(obj)
+        if object_type ==  'GraphicsResult':
+            return import_module("regula.documentreader.webclient.gen.models.graphics_result").GraphicsResult.from_dict(obj)
+        if object_type ==  'DocumentBinaryInfoResult':
+            return import_module("regula.documentreader.webclient.gen.models.document_binary_info_result").DocumentBinaryInfoResult.from_dict(obj)
+        if object_type ==  'RFIDGraphicsInfoResult':
+            return import_module("regula.documentreader.webclient.gen.models.rfid_graphics_info_result").RFIDGraphicsInfoResult.from_dict(obj)
+        if object_type ==  'ByteArrayResult':
+            return import_module("regula.documentreader.webclient.gen.models.byte_array_result").ByteArrayResult.from_dict(obj)
+        if object_type ==  'LexicalAnalysisResult':
+            return import_module("regula.documentreader.webclient.gen.models.lexical_analysis_result").LexicalAnalysisResult.from_dict(obj)
+        if object_type ==  'DocumentImageResult':
+            return import_module("regula.documentreader.webclient.gen.models.document_image_result").DocumentImageResult.from_dict(obj)
+        if object_type ==  'TextDataResult':
+            return import_module("regula.documentreader.webclient.gen.models.text_data_result").TextDataResult.from_dict(obj)
+        if object_type ==  'TextDataResult':
+            return import_module("regula.documentreader.webclient.gen.models.text_data_result").TextDataResult.from_dict(obj)
+        if object_type ==  'GraphicsResult':
+            return import_module("regula.documentreader.webclient.gen.models.graphics_result").GraphicsResult.from_dict(obj)
+        if object_type ==  'AuthenticityResult':
+            return import_module("regula.documentreader.webclient.gen.models.authenticity_result").AuthenticityResult.from_dict(obj)
+        if object_type ==  'TextDataResult':
+            return import_module("regula.documentreader.webclient.gen.models.text_data_result").TextDataResult.from_dict(obj)
+        if object_type ==  'TextDataResult':
+            return import_module("regula.documentreader.webclient.gen.models.text_data_result").TextDataResult.from_dict(obj)
+        if object_type ==  'ImageQualityResult':
+            return import_module("regula.documentreader.webclient.gen.models.image_quality_result").ImageQualityResult.from_dict(obj)
+        if object_type ==  'GraphicsResult':
+            return import_module("regula.documentreader.webclient.gen.models.graphics_result").GraphicsResult.from_dict(obj)
+        if object_type ==  'StatusResult':
+            return import_module("regula.documentreader.webclient.gen.models.status_result").StatusResult.from_dict(obj)
+        if object_type ==  'AuthenticityResult':
+            return import_module("regula.documentreader.webclient.gen.models.authenticity_result").AuthenticityResult.from_dict(obj)
+        if object_type ==  'GraphicsResult':
+            return import_module("regula.documentreader.webclient.gen.models.graphics_result").GraphicsResult.from_dict(obj)
+        if object_type ==  'TextResult':
+            return import_module("regula.documentreader.webclient.gen.models.text_result").TextResult.from_dict(obj)
+        if object_type ==  'ImagesResult':
+            return import_module("regula.documentreader.webclient.gen.models.images_result").ImagesResult.from_dict(obj)
+        if object_type ==  'GraphicsResult':
+            return import_module("regula.documentreader.webclient.gen.models.graphics_result").GraphicsResult.from_dict(obj)
+        if object_type ==  'AuthenticityResult':
+            return import_module("regula.documentreader.webclient.gen.models.authenticity_result").AuthenticityResult.from_dict(obj)
+        if object_type ==  'EncryptedRCLResult':
+            return import_module("regula.documentreader.webclient.gen.models.encrypted_rcl_result").EncryptedRCLResult.from_dict(obj)
+        if object_type ==  'DocBarCodeInfo':
+            return import_module("regula.documentreader.webclient.gen.models.doc_bar_code_info").DocBarCodeInfo.from_dict(obj)
+        if object_type ==  'LicenseResult':
+            return import_module("regula.documentreader.webclient.gen.models.license_result").LicenseResult.from_dict(obj)
+        if object_type ==  'GraphicsResult':
+            return import_module("regula.documentreader.webclient.gen.models.graphics_result").GraphicsResult.from_dict(obj)
+        if object_type ==  'MRZPositionResult':
+            return import_module("regula.documentreader.webclient.gen.models.mrz_position_result").MRZPositionResult.from_dict(obj)
+        if object_type ==  'DocumentPositionResult':
+            return import_module("regula.documentreader.webclient.gen.models.document_position_result").DocumentPositionResult.from_dict(obj)
+        if object_type ==  'MRZTestQualityResult':
+            return import_module("regula.documentreader.webclient.gen.models.mrz_test_quality_result").MRZTestQualityResult.from_dict(obj)
+        if object_type ==  'DocumentTypesCandidatesResult':
+            return import_module("regula.documentreader.webclient.gen.models.document_types_candidates_result").DocumentTypesCandidatesResult.from_dict(obj)
+        if object_type ==  'DocumentPositionResult':
+            return import_module("regula.documentreader.webclient.gen.models.document_position_result").DocumentPositionResult.from_dict(obj)
+        if object_type ==  'MRZDetectorResult':
+            return import_module("regula.documentreader.webclient.gen.models.mrz_detector_result").MRZDetectorResult.from_dict(obj)
+        if object_type ==  'ChosenDocumentTypeResult':
+            return import_module("regula.documentreader.webclient.gen.models.chosen_document_type_result").ChosenDocumentTypeResult.from_dict(obj)
+        if object_type ==  'FaceDetectionResult':
+            return import_module("regula.documentreader.webclient.gen.models.face_detection_result").FaceDetectionResult.from_dict(obj)
+
+        raise ValueError("ResultItem failed to lookup discriminator value from " +
+                            json.dumps(obj) + ". Discriminator property name: " + cls.__discriminator_property_name +
+                            ", mapping: " + json.dumps(cls.__discriminator_value_class_map))
 
-        self._buf_length = buf_length
-
-    @property
-    def light(self):
-        """Gets the light of this ResultItem.  # noqa: E501
-
-
-        :return: The light of this ResultItem.  # noqa: E501
-        :rtype: int
-        """
-        return self._light
-
-    @light.setter
-    def light(self, light):
-        """Sets the light of this ResultItem.
-
-
-        :param light: The light of this ResultItem.  # noqa: E501
-        :type light: int
-        """
-
-        self._light = light
-
-    @property
-    def list_idx(self):
-        """Gets the list_idx of this ResultItem.  # noqa: E501
-
-
-        :return: The list_idx of this ResultItem.  # noqa: E501
-        :rtype: int
-        """
-        return self._list_idx
-
-    @list_idx.setter
-    def list_idx(self, list_idx):
-        """Sets the list_idx of this ResultItem.
-
-
-        :param list_idx: The list_idx of this ResultItem.  # noqa: E501
-        :type list_idx: int
-        """
-
-        self._list_idx = list_idx
-
-    @property
-    def page_idx(self):
-        """Gets the page_idx of this ResultItem.  # noqa: E501
-
-
-        :return: The page_idx of this ResultItem.  # noqa: E501
-        :rtype: int
-        """
-        return self._page_idx
-
-    @page_idx.setter
-    def page_idx(self, page_idx):
-        """Sets the page_idx of this ResultItem.
-
-
-        :param page_idx: The page_idx of this ResultItem.  # noqa: E501
-        :type page_idx: int
-        """
-
-        self._page_idx = page_idx
-
-    @property
-    def result_type(self):
-        """Gets the result_type of this ResultItem.  # noqa: E501
-
-        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
-
-        :return: The result_type of this ResultItem.  # noqa: E501
-        :rtype: int
-        """
-        return self._result_type
-
-    @result_type.setter
-    def result_type(self, result_type):
-        """Sets the result_type of this ResultItem.
-
-        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
-
-        :param result_type: The result_type of this ResultItem.  # noqa: E501
-        :type result_type: int
-        """
-        if self.local_vars_configuration.client_side_validation and result_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `result_type`, must not be `None`")  # noqa: E501
-
-        self._result_type = result_type
-
-    def get_real_child_model(self, data):
-        """Returns the real base class specified by the discriminator"""
-        discriminator_key = self.attribute_map[self.discriminator]
-        discriminator_value = data[discriminator_key]
-        from regula.documentreader.webclient.ext.models import RawResultItem
-        return self.discriminator_value_class_map.get(discriminator_value, RawResultItem.__name__)
-
-    def to_dict(self):
-        """Returns the model properties as a dict"""
-        result = {}
-
-        for attr, _ in six.iteritems(self.openapi_types):
-            value = getattr(self, attr)
-            if isinstance(value, list):
-                result[attr] = list(map(
-                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
-                    value
-                ))
-            elif hasattr(value, "to_dict"):
-                result[attr] = value.to_dict()
-            elif isinstance(value, dict):
-                result[attr] = dict(map(
-                    lambda item: (item[0], item[1].to_dict())
-                    if hasattr(item[1], "to_dict") else item,
-                    value.items()
-                ))
-            else:
-                result[attr] = value
-
-        return result
-
-    def to_str(self):
-        """Returns the string representation of the model"""
-        return pprint.pformat(self.to_dict())
-
-    def __repr__(self):
-        """For `print` and `pprint`"""
-        return self.to_str()
-
-    def __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, ResultItem):
-            return False
-
-        return self.to_dict() == other.to_dict()
-
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, ResultItem):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,93 @@
+# 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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from regula.documentreader.webclient.gen.models.mrz_rows_item import MRZRowsItem
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ResultMRZDetector(BaseModel):
+    """
+    ResultMRZDetector
+    """ # noqa: E501
+    mrz_format: StrictInt = Field(alias="MRZFormat")
+    mrz_rows: List[MRZRowsItem] = Field(alias="MRZRows")
+    mrz_rows_num: StrictInt = Field(alias="MRZRowsNum")
+    bounding_quadrangle: List[Union[StrictFloat, StrictInt]] = Field(alias="boundingQuadrangle")
+    __properties: ClassVar[List[str]] = ["MRZFormat", "MRZRows", "MRZRowsNum", "boundingQuadrangle"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    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 ResultMRZDetector 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 mrz_rows (list)
+        _items = []
+        if self.mrz_rows:
+            for _item_mrz_rows in self.mrz_rows:
+                if _item_mrz_rows:
+                    _items.append(_item_mrz_rows.to_dict())
+            _dict['MRZRows'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ResultMRZDetector from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "MRZFormat": obj.get("MRZFormat"),
+            "MRZRows": [MRZRowsItem.from_dict(_item) for _item in obj["MRZRows"]] if obj.get("MRZRows") is not None else None,
+            "MRZRowsNum": obj.get("MRZRowsNum"),
+            "boundingQuadrangle": obj.get("boundingQuadrangle")
+        })
+        return _obj
+
+

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

@@ -0,0 +1,83 @@
+# 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.result_mrz_detector import ResultMRZDetector
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ResultMRZDetectorItem(BaseModel):
+    """
+    ResultMRZDetectorItem
+    """ # noqa: E501
+    result_mrz_detector: ResultMRZDetector = Field(alias="ResultMRZDetector")
+    __properties: ClassVar[List[str]] = ["ResultMRZDetector"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    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 ResultMRZDetectorItem 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 result_mrz_detector
+        if self.result_mrz_detector:
+            _dict['ResultMRZDetector'] = self.result_mrz_detector.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ResultMRZDetectorItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ResultMRZDetector": ResultMRZDetector.from_dict(obj["ResultMRZDetector"]) if obj.get("ResultMRZDetector") is not None else None
+        })
+        return _obj
+
+

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

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class RfidAChip(int, Enum):
+    """
+    Enumeration contains a set of constants specifying the type of the RFIDchip from MIFARE® family (for chips of type A)
+    """
+
+    """
+    allowed enum values
+    """
+    UNKNOWN = 0
+    MIFARE_1K = 1
+    MIFARE_4K = 2
+    MIFARE_ULTRALIGHT = 3
+    MIFARE_DES_FIRE = 4
+    MIFARE_PROX = 5
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RfidAChip from a JSON string"""
+        return cls(json.loads(json_str))
+
+