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

regula/documentreader/webclient/gen/models/mrz_detector_result.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 ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.result import Result
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+from regula.documentreader.webclient.gen.models.result_mrz_detector import ResultMRZDetector
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MRZDetectorResult(ResultItem):
+    """
+    MRZDetectorResult
+    """ # noqa: E501
+    result_mrz_detector: ResultMRZDetector = Field(alias="ResultMRZDetector")
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "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 MRZDetectorResult 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 MRZDetectorResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "buf_length": obj.get("buf_length"),
+            "light": obj.get("light"),
+            "list_idx": obj.get("list_idx"),
+            "page_idx": obj.get("page_idx"),
+            "result_type": obj.get("result_type"),
+            "ResultMRZDetector": ResultMRZDetector.from_dict(obj["ResultMRZDetector"]) if obj.get("ResultMRZDetector") is not None else None
+        })
+        return _obj
+
+

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

@@ -4,102 +4,30 @@
     Generated by: https://openapi-generator.tech
 """
 
-import pprint
-import re  # noqa: F401
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
 
-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 *
-
-
-"""
-
-"""
-class MRZFormat(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class MRZFormat(str, Enum):
+    """
+    MRZFormat
     """
-
-    IDL = "1x30"
-
-    ID1 = "3x30"
-
-    ID2 = "2x36"
-
-    ID3 = "2x44"
-
-    CAN = "1x6"
-
-    ID1_2_30 = "2x30"
-
-    allowable_values = [IDL, ID1, ID2, ID3, CAN, ID1_2_30]  # noqa: E501
 
     """
-    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.
+    allowed enum values
     """
-    openapi_types = {
-    }
-
-    attribute_map = {
-    }
-
-    def __init__(self, local_vars_configuration=None):  # noqa: E501
-        """MRZFormat - 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.discriminator = None
-
-    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, MRZFormat):
-            return False
+    IDL = '1x30'
+    ID1 = '3x30'
+    ID2 = '2x36'
+    ID3 = '2x44'
+    CAN = '1x6'
+    ID1_2_30 = '2x30'
 
-        return self.to_dict() == other.to_dict()
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MRZFormat from a JSON string"""
+        return cls(json.loads(json_str))
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, MRZFormat):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,124 @@
+# 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, Optional, Union
+from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
+from regula.documentreader.webclient.gen.models.point import Point
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MrzPosition(BaseModel):
+    """
+    MrzPosition
+    """ # noqa: E501
+    doc_format: DocumentFormat = Field(alias="docFormat")
+    angle: Union[StrictFloat, StrictInt] = Field(description="Document rotation angle", alias="Angle")
+    width: StrictInt = Field(description="Document width", alias="Width")
+    height: StrictInt = Field(description="Document height", alias="Height")
+    center: Point = Field(alias="Center")
+    left_bottom: Point = Field(alias="LeftBottom")
+    left_top: Point = Field(alias="LeftTop")
+    right_bottom: Point = Field(alias="RightBottom")
+    right_top: Point = Field(alias="RightTop")
+    dpi: StrictInt = Field(alias="Dpi")
+    inverse: Optional[StrictInt] = Field(default=None, alias="Inverse")
+    obj_area: Optional[StrictInt] = Field(default=None, alias="ObjArea")
+    obj_int_angle_dev: Optional[StrictInt] = Field(default=None, alias="ObjIntAngleDev")
+    perspective_tr: Optional[StrictInt] = Field(default=None, alias="PerspectiveTr")
+    result_status: Optional[StrictInt] = Field(default=None, alias="ResultStatus")
+    __properties: ClassVar[List[str]] = ["docFormat", "Angle", "Width", "Height", "Center", "LeftBottom", "LeftTop", "RightBottom", "RightTop", "Dpi", "Inverse", "ObjArea", "ObjIntAngleDev", "PerspectiveTr", "ResultStatus"]
+
+    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 MrzPosition 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 center
+        if self.center:
+            _dict['Center'] = self.center.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of left_bottom
+        if self.left_bottom:
+            _dict['LeftBottom'] = self.left_bottom.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of left_top
+        if self.left_top:
+            _dict['LeftTop'] = self.left_top.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of right_bottom
+        if self.right_bottom:
+            _dict['RightBottom'] = self.right_bottom.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of right_top
+        if self.right_top:
+            _dict['RightTop'] = self.right_top.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MrzPosition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "docFormat": obj.get("docFormat"),
+            "Angle": obj.get("Angle"),
+            "Width": obj.get("Width"),
+            "Height": obj.get("Height"),
+            "Center": Point.from_dict(obj["Center"]) if obj.get("Center") is not None else None,
+            "LeftBottom": Point.from_dict(obj["LeftBottom"]) if obj.get("LeftBottom") is not None else None,
+            "LeftTop": Point.from_dict(obj["LeftTop"]) if obj.get("LeftTop") is not None else None,
+            "RightBottom": Point.from_dict(obj["RightBottom"]) if obj.get("RightBottom") is not None else None,
+            "RightTop": Point.from_dict(obj["RightTop"]) if obj.get("RightTop") is not None else None,
+            "Dpi": obj.get("Dpi"),
+            "Inverse": obj.get("Inverse"),
+            "ObjArea": obj.get("ObjArea"),
+            "ObjIntAngleDev": obj.get("ObjIntAngleDev"),
+            "PerspectiveTr": obj.get("PerspectiveTr"),
+            "ResultStatus": obj.get("ResultStatus")
+        })
+        return _obj
+
+

regula/documentreader/webclient/gen/models/mrz_position_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.mrz_position import MrzPosition
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MrzPositionItem(BaseModel):
+    """
+    MrzPositionItem
+    """ # noqa: E501
+    mrz_position: MrzPosition = Field(alias="MrzPosition")
+    __properties: ClassVar[List[str]] = ["MrzPosition"]
+
+    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 MrzPositionItem 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 mrz_position
+        if self.mrz_position:
+            _dict['MrzPosition'] = self.mrz_position.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MrzPositionItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "MrzPosition": MrzPosition.from_dict(obj["MrzPosition"]) if obj.get("MrzPosition") is not None else None
+        })
+        return _obj
+
+

regula/documentreader/webclient/gen/models/mrz_position_result.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 ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.mrz_position import MrzPosition
+from regula.documentreader.webclient.gen.models.result import Result
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MRZPositionResult(ResultItem):
+    """
+    MRZPositionResult
+    """ # noqa: E501
+    mrz_position: MrzPosition = Field(alias="MrzPosition")
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "MrzPosition"]
+
+    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 MRZPositionResult 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 mrz_position
+        if self.mrz_position:
+            _dict['MrzPosition'] = self.mrz_position.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MRZPositionResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "buf_length": obj.get("buf_length"),
+            "light": obj.get("light"),
+            "list_idx": obj.get("list_idx"),
+            "page_idx": obj.get("page_idx"),
+            "result_type": obj.get("result_type"),
+            "MrzPosition": MrzPosition.from_dict(obj["MrzPosition"]) if obj.get("MrzPosition") is not None else None
+        })
+        return _obj
+
+

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

@@ -0,0 +1,91 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.symbol import Symbol
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MRZRowsItem(BaseModel):
+    """
+    MRZRowsItem
+    """ # noqa: E501
+    length: StrictInt
+    max_length: StrictInt = Field(alias="maxLength")
+    symbols: List[Symbol]
+    __properties: ClassVar[List[str]] = ["length", "maxLength", "symbols"]
+
+    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 MRZRowsItem 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 symbols (list)
+        _items = []
+        if self.symbols:
+            for _item_symbols in self.symbols:
+                if _item_symbols:
+                    _items.append(_item_symbols.to_dict())
+            _dict['symbols'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MRZRowsItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "length": obj.get("length"),
+            "maxLength": obj.get("maxLength"),
+            "symbols": [Symbol.from_dict(_item) for _item in obj["symbols"]] if obj.get("symbols") is not None else None
+        })
+        return _obj
+
+