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

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

@@ -4,314 +4,93 @@
     Generated by: https://openapi-generator.tech
 """
 
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
+import json
 
-import six
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.input_image_quality_checks import InputImageQualityChecks
+from typing import Optional, Set
+from typing_extensions import Self
 
-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 ImageQA(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class ImageQA(BaseModel):
     """
+    ImageQA
+    """ # noqa: E501
+    brightness_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Set the threshold for an actual document brightness below which the check fails", alias="brightnessThreshold")
+    dpi_threshold: Optional[StrictInt] = Field(default=None, description="This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.", alias="dpiThreshold")
+    angle_threshold: Optional[StrictInt] = Field(default=None, description="This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.", alias="angleThreshold")
+    focus_check: Optional[StrictBool] = Field(default=None, description="This option enables focus check while performing image quality validation.", alias="focusCheck")
+    glares_check: Optional[StrictBool] = Field(default=None, description="This option enables glares check while performing image quality validation.", alias="glaresCheck")
+    colorness_check: Optional[StrictBool] = Field(default=None, description="This option enables colorness check while performing image quality validation.", alias="colornessCheck")
+    moire_check: Optional[StrictBool] = Field(default=None, description="This option enables screen capture (moire patterns) check while performing image quality validation.", alias="moireCheck")
+    document_position_indent: Optional[StrictInt] = Field(default=None, description="This parameter specifies the necessary margin. Default 0.", alias="documentPositionIndent")
+    expected_pass: Optional[List[InputImageQualityChecks]] = Field(default=None, description="This parameter controls the quality checks that the image should pass to be considered a valid input during the scanning process.", alias="expectedPass")
+    __properties: ClassVar[List[str]] = ["brightnessThreshold", "dpiThreshold", "angleThreshold", "focusCheck", "glaresCheck", "colornessCheck", "moireCheck", "documentPositionIndent", "expectedPass"]
+
+    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 ImageQA 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 ImageQA from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "brightnessThreshold": obj.get("brightnessThreshold"),
+            "dpiThreshold": obj.get("dpiThreshold"),
+            "angleThreshold": obj.get("angleThreshold"),
+            "focusCheck": obj.get("focusCheck"),
+            "glaresCheck": obj.get("glaresCheck"),
+            "colornessCheck": obj.get("colornessCheck"),
+            "moireCheck": obj.get("moireCheck"),
+            "documentPositionIndent": obj.get("documentPositionIndent"),
+            "expectedPass": obj.get("expectedPass")
+        })
+        return _obj
 
-    """
-    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 = {
-        'brightness_threshold': 'float',
-        'dpi_threshold': 'int',
-        'angle_threshold': 'int',
-        'focus_check': 'bool',
-        'glares_check': 'bool',
-        'colorness_check': 'bool',
-        'document_position_indent': 'int',
-        'expected_pass': 'list[InputImageQualityChecks]'
-    }
-
-    attribute_map = {
-        'brightness_threshold': 'brightnessThreshold',
-        'dpi_threshold': 'dpiThreshold',
-        'angle_threshold': 'angleThreshold',
-        'focus_check': 'focusCheck',
-        'glares_check': 'glaresCheck',
-        'colorness_check': 'colornessCheck',
-        'document_position_indent': 'documentPositionIndent',
-        'expected_pass': 'expectedPass'
-    }
-
-    def __init__(self, brightness_threshold=None, dpi_threshold=None, angle_threshold=None, focus_check=None, glares_check=None, colorness_check=None, document_position_indent=None, expected_pass=None, local_vars_configuration=None):  # noqa: E501
-        """ImageQA - 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._brightness_threshold = None
-        self._dpi_threshold = None
-        self._angle_threshold = None
-        self._focus_check = None
-        self._glares_check = None
-        self._colorness_check = None
-        self._document_position_indent = None
-        self._expected_pass = None
-        self.discriminator = None
-
-        if brightness_threshold is not None:
-            self.brightness_threshold = brightness_threshold
-        if dpi_threshold is not None:
-            self.dpi_threshold = dpi_threshold
-        if angle_threshold is not None:
-            self.angle_threshold = angle_threshold
-        if focus_check is not None:
-            self.focus_check = focus_check
-        if glares_check is not None:
-            self.glares_check = glares_check
-        if colorness_check is not None:
-            self.colorness_check = colorness_check
-        if document_position_indent is not None:
-            self.document_position_indent = document_position_indent
-        if expected_pass is not None:
-            self.expected_pass = expected_pass
-
-    @property
-    def brightness_threshold(self):
-        """Gets the brightness_threshold of this ImageQA.  # noqa: E501
-
-        Set the threshold for an actual document brightness below which the check fails  # noqa: E501
-
-        :return: The brightness_threshold of this ImageQA.  # noqa: E501
-        :rtype: float
-        """
-        return self._brightness_threshold
-
-    @brightness_threshold.setter
-    def brightness_threshold(self, brightness_threshold):
-        """Sets the brightness_threshold of this ImageQA.
-
-        Set the threshold for an actual document brightness below which the check fails  # noqa: E501
-
-        :param brightness_threshold: The brightness_threshold of this ImageQA.  # noqa: E501
-        :type brightness_threshold: float
-        """
-
-        self._brightness_threshold = brightness_threshold
-
-    @property
-    def dpi_threshold(self):
-        """Gets the dpi_threshold of this ImageQA.  # noqa: E501
-
-        This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.  # noqa: E501
-
-        :return: The dpi_threshold of this ImageQA.  # noqa: E501
-        :rtype: int
-        """
-        return self._dpi_threshold
-
-    @dpi_threshold.setter
-    def dpi_threshold(self, dpi_threshold):
-        """Sets the dpi_threshold of this ImageQA.
-
-        This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.  # noqa: E501
-
-        :param dpi_threshold: The dpi_threshold of this ImageQA.  # noqa: E501
-        :type dpi_threshold: int
-        """
-
-        self._dpi_threshold = dpi_threshold
-
-    @property
-    def angle_threshold(self):
-        """Gets the angle_threshold of this ImageQA.  # noqa: E501
-
-        This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.  # noqa: E501
-
-        :return: The angle_threshold of this ImageQA.  # noqa: E501
-        :rtype: int
-        """
-        return self._angle_threshold
-
-    @angle_threshold.setter
-    def angle_threshold(self, angle_threshold):
-        """Sets the angle_threshold of this ImageQA.
-
-        This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.  # noqa: E501
-
-        :param angle_threshold: The angle_threshold of this ImageQA.  # noqa: E501
-        :type angle_threshold: int
-        """
-
-        self._angle_threshold = angle_threshold
-
-    @property
-    def focus_check(self):
-        """Gets the focus_check of this ImageQA.  # noqa: E501
-
-        This option enables focus check while performing image quality validation.  # noqa: E501
-
-        :return: The focus_check of this ImageQA.  # noqa: E501
-        :rtype: bool
-        """
-        return self._focus_check
-
-    @focus_check.setter
-    def focus_check(self, focus_check):
-        """Sets the focus_check of this ImageQA.
-
-        This option enables focus check while performing image quality validation.  # noqa: E501
-
-        :param focus_check: The focus_check of this ImageQA.  # noqa: E501
-        :type focus_check: bool
-        """
-
-        self._focus_check = focus_check
-
-    @property
-    def glares_check(self):
-        """Gets the glares_check of this ImageQA.  # noqa: E501
-
-        This option enables glares check while performing image quality validation.  # noqa: E501
-
-        :return: The glares_check of this ImageQA.  # noqa: E501
-        :rtype: bool
-        """
-        return self._glares_check
-
-    @glares_check.setter
-    def glares_check(self, glares_check):
-        """Sets the glares_check of this ImageQA.
-
-        This option enables glares check while performing image quality validation.  # noqa: E501
-
-        :param glares_check: The glares_check of this ImageQA.  # noqa: E501
-        :type glares_check: bool
-        """
-
-        self._glares_check = glares_check
-
-    @property
-    def colorness_check(self):
-        """Gets the colorness_check of this ImageQA.  # noqa: E501
-
-        This option enables colorness check while performing image quality validation.  # noqa: E501
-
-        :return: The colorness_check of this ImageQA.  # noqa: E501
-        :rtype: bool
-        """
-        return self._colorness_check
-
-    @colorness_check.setter
-    def colorness_check(self, colorness_check):
-        """Sets the colorness_check of this ImageQA.
-
-        This option enables colorness check while performing image quality validation.  # noqa: E501
-
-        :param colorness_check: The colorness_check of this ImageQA.  # noqa: E501
-        :type colorness_check: bool
-        """
-
-        self._colorness_check = colorness_check
-
-    @property
-    def document_position_indent(self):
-        """Gets the document_position_indent of this ImageQA.  # noqa: E501
-
-        This parameter specifies the necessary margin. Default 0.  # noqa: E501
-
-        :return: The document_position_indent of this ImageQA.  # noqa: E501
-        :rtype: int
-        """
-        return self._document_position_indent
-
-    @document_position_indent.setter
-    def document_position_indent(self, document_position_indent):
-        """Sets the document_position_indent of this ImageQA.
-
-        This parameter specifies the necessary margin. Default 0.  # noqa: E501
-
-        :param document_position_indent: The document_position_indent of this ImageQA.  # noqa: E501
-        :type document_position_indent: int
-        """
-
-        self._document_position_indent = document_position_indent
-
-    @property
-    def expected_pass(self):
-        """Gets the expected_pass of this ImageQA.  # noqa: E501
-
-        This parameter controls the quality checks that the image should pass to be considered a valid input during the scanning process.  # noqa: E501
-
-        :return: The expected_pass of this ImageQA.  # noqa: E501
-        :rtype: list[InputImageQualityChecks]
-        """
-        return self._expected_pass
-
-    @expected_pass.setter
-    def expected_pass(self, expected_pass):
-        """Sets the expected_pass of this ImageQA.
-
-        This parameter controls the quality checks that the image should pass to be considered a valid input during the scanning process.  # noqa: E501
-
-        :param expected_pass: The expected_pass of this ImageQA.  # noqa: E501
-        :type expected_pass: list[InputImageQualityChecks]
-        """
-
-        self._expected_pass = expected_pass
-
-    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, ImageQA):
-            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, ImageQA):
-            return True
 
-        return self.to_dict() != other.to_dict()