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

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

@@ -4,258 +4,88 @@
     Generated by: https://openapi-generator.tech
 """
 
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
+import json
 
-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 LivenessParams(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
 
+class LivenessParams(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 = {
-        'check_ovi': 'bool',
-        'check_mli': 'bool',
-        'check_holo': 'bool',
-        'check_ed': 'bool',
-        'check_black_and_white_copy': 'bool',
-        'check_dynaprint': 'bool'
-    }
-
-    attribute_map = {
-        'check_ovi': 'checkOVI',
-        'check_mli': 'checkMLI',
-        'check_holo': 'checkHolo',
-        'check_ed': 'checkED',
-        'check_black_and_white_copy': 'checkBlackAndWhiteCopy',
-        'check_dynaprint': 'checkDynaprint'
-    }
-
-    def __init__(self, check_ovi=None, check_mli=None, check_holo=None, check_ed=None, check_black_and_white_copy=None, check_dynaprint=None, local_vars_configuration=None):  # noqa: E501
-        """LivenessParams - 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._check_ovi = None
-        self._check_mli = None
-        self._check_holo = None
-        self._check_ed = None
-        self._check_black_and_white_copy = None
-        self._check_dynaprint = None
-        self.discriminator = None
-
-        if check_ovi is not None:
-            self.check_ovi = check_ovi
-        if check_mli is not None:
-            self.check_mli = check_mli
-        if check_holo is not None:
-            self.check_holo = check_holo
-        if check_ed is not None:
-            self.check_ed = check_ed
-        if check_black_and_white_copy is not None:
-            self.check_black_and_white_copy = check_black_and_white_copy
-        if check_dynaprint is not None:
-            self.check_dynaprint = check_dynaprint
-
-    @property
-    def check_ovi(self):
-        """Gets the check_ovi of this LivenessParams.  # noqa: E501
-
-        This parameter is used to enable OVI check  # noqa: E501
-
-        :return: The check_ovi of this LivenessParams.  # noqa: E501
-        :rtype: bool
+    LivenessParams
+    """ # noqa: E501
+    check_ovi: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable OVI check", alias="checkOVI")
+    check_mli: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable MLI check", alias="checkMLI")
+    check_holo: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Hologram detection", alias="checkHolo")
+    check_ed: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Electronic device detection", alias="checkED")
+    check_black_and_white_copy: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Black and white copy check", alias="checkBlackAndWhiteCopy")
+    check_dynaprint: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Dynaprint check", alias="checkDynaprint")
+    check_geometry: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Geometry check", alias="checkGeometry")
+    __properties: ClassVar[List[str]] = ["checkOVI", "checkMLI", "checkHolo", "checkED", "checkBlackAndWhiteCopy", "checkDynaprint", "checkGeometry"]
+
+    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 LivenessParams 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.
         """
-        return self._check_ovi
-
-    @check_ovi.setter
-    def check_ovi(self, check_ovi):
-        """Sets the check_ovi of this LivenessParams.
-
-        This parameter is used to enable OVI check  # noqa: E501
-
-        :param check_ovi: The check_ovi of this LivenessParams.  # noqa: E501
-        :type check_ovi: bool
-        """
-
-        self._check_ovi = check_ovi
-
-    @property
-    def check_mli(self):
-        """Gets the check_mli of this LivenessParams.  # noqa: E501
-
-        This parameter is used to enable MLI check  # noqa: E501
-
-        :return: The check_mli of this LivenessParams.  # noqa: E501
-        :rtype: bool
-        """
-        return self._check_mli
-
-    @check_mli.setter
-    def check_mli(self, check_mli):
-        """Sets the check_mli of this LivenessParams.
-
-        This parameter is used to enable MLI check  # noqa: E501
-
-        :param check_mli: The check_mli of this LivenessParams.  # noqa: E501
-        :type check_mli: bool
-        """
-
-        self._check_mli = check_mli
-
-    @property
-    def check_holo(self):
-        """Gets the check_holo of this LivenessParams.  # noqa: E501
-
-        This parameter is used to enable Hologram detection  # noqa: E501
-
-        :return: The check_holo of this LivenessParams.  # noqa: E501
-        :rtype: bool
-        """
-        return self._check_holo
-
-    @check_holo.setter
-    def check_holo(self, check_holo):
-        """Sets the check_holo of this LivenessParams.
-
-        This parameter is used to enable Hologram detection  # noqa: E501
-
-        :param check_holo: The check_holo of this LivenessParams.  # noqa: E501
-        :type check_holo: bool
-        """
-
-        self._check_holo = check_holo
-
-    @property
-    def check_ed(self):
-        """Gets the check_ed of this LivenessParams.  # noqa: E501
-
-        This parameter is used to enable Electronic device detection  # noqa: E501
-
-        :return: The check_ed of this LivenessParams.  # noqa: E501
-        :rtype: bool
-        """
-        return self._check_ed
-
-    @check_ed.setter
-    def check_ed(self, check_ed):
-        """Sets the check_ed of this LivenessParams.
-
-        This parameter is used to enable Electronic device detection  # noqa: E501
-
-        :param check_ed: The check_ed of this LivenessParams.  # noqa: E501
-        :type check_ed: bool
-        """
-
-        self._check_ed = check_ed
-
-    @property
-    def check_black_and_white_copy(self):
-        """Gets the check_black_and_white_copy of this LivenessParams.  # noqa: E501
-
-        This parameter is used to enable Black and white copy check  # noqa: E501
-
-        :return: The check_black_and_white_copy of this LivenessParams.  # noqa: E501
-        :rtype: bool
-        """
-        return self._check_black_and_white_copy
-
-    @check_black_and_white_copy.setter
-    def check_black_and_white_copy(self, check_black_and_white_copy):
-        """Sets the check_black_and_white_copy of this LivenessParams.
-
-        This parameter is used to enable Black and white copy check  # noqa: E501
-
-        :param check_black_and_white_copy: The check_black_and_white_copy of this LivenessParams.  # noqa: E501
-        :type check_black_and_white_copy: bool
-        """
-
-        self._check_black_and_white_copy = check_black_and_white_copy
-
-    @property
-    def check_dynaprint(self):
-        """Gets the check_dynaprint of this LivenessParams.  # noqa: E501
-
-        This parameter is used to enable Dynaprint check  # noqa: E501
-
-        :return: The check_dynaprint of this LivenessParams.  # noqa: E501
-        :rtype: bool
-        """
-        return self._check_dynaprint
-
-    @check_dynaprint.setter
-    def check_dynaprint(self, check_dynaprint):
-        """Sets the check_dynaprint of this LivenessParams.
-
-        This parameter is used to enable Dynaprint check  # noqa: E501
-
-        :param check_dynaprint: The check_dynaprint of this LivenessParams.  # noqa: E501
-        :type check_dynaprint: bool
-        """
-
-        self._check_dynaprint = check_dynaprint
-
-    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, LivenessParams):
-            return False
-
-        return self.to_dict() == other.to_dict()
+        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 LivenessParams from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "checkOVI": obj.get("checkOVI"),
+            "checkMLI": obj.get("checkMLI"),
+            "checkHolo": obj.get("checkHolo"),
+            "checkED": obj.get("checkED"),
+            "checkBlackAndWhiteCopy": obj.get("checkBlackAndWhiteCopy"),
+            "checkDynaprint": obj.get("checkDynaprint"),
+            "checkGeometry": obj.get("checkGeometry")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, LivenessParams):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,100 +4,29 @@
     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 LogLevel(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class LogLevel(str, Enum):
+    """
+    LogLevel
     """
-
-    FATAL_ERROR = "FatalError"
-
-    ERROR = "Error"
-
-    WARNING = "Warning"
-
-    INFO = "Info"
-
-    DEBUG = "Debug"
-
-    allowable_values = [FATAL_ERROR, ERROR, WARNING, INFO, DEBUG]  # 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
-        """LogLevel - 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, LogLevel):
-            return False
+    FATAL_ERROR = 'FatalError'
+    ERROR = 'Error'
+    WARNING = 'Warning'
+    INFO = 'Info'
+    DEBUG = 'Debug'
 
-        return self.to_dict() == other.to_dict()
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of LogLevel 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, LogLevel):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,94 +4,26 @@
     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 MeasureSystem(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class MeasureSystem(int, Enum):
+    """
+    MeasureSystem
     """
-
-    METRIC = int("0")
-
-    IMPERIAL = int("1")
-
-    allowable_values = [METRIC, IMPERIAL]  # 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
-        """MeasureSystem - 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, MeasureSystem):
-            return False
+    METRIC = 0
+    IMPERIAL = 1
 
-        return self.to_dict() == other.to_dict()
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MeasureSystem 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, MeasureSystem):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,96 +4,27 @@
     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 *
-
-
-"""
-Make better MRZ detection on complex noisy backgrounds, like BW photocopy of some documents.
-"""
-class MrzDetectModeEnum(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class MrzDetectModeEnum(int, Enum):
+    """
+    Make better MRZ detection on complex noisy backgrounds, like BW photocopy of some documents.
     """
-
-    eMDM_Default = int("0")
-
-    eMDM_ResizeBinarizeWindow = int("1")
-
-    eMDM_BlurBeforeBinarization = int("2")
-
-    allowable_values = [eMDM_Default, eMDM_ResizeBinarizeWindow, eMDM_BlurBeforeBinarization]  # 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
-        """MrzDetectModeEnum - 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, MrzDetectModeEnum):
-            return False
+    eMDM_Default = 0
+    eMDM_ResizeBinarizeWindow = 1
+    eMDM_BlurBeforeBinarization = 2
 
-        return self.to_dict() == other.to_dict()
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MrzDetectModeEnum 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, MrzDetectModeEnum):
-            return True
 
-        return self.to_dict() != other.to_dict()