regula-documentreader-webclient 8.1.349rc0__py3-none-any.whl → 8.1.351.dev0__py3-none-any.whl

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

@@ -4,272 +4,95 @@
     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 *
-
-
-"""
-
-"""
-class ImageQualityCheck(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
-    """
-    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.
+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.area_array import AreaArray
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
+from regula.documentreader.webclient.gen.models.image_quality_check_type import ImageQualityCheckType
+from regula.documentreader.webclient.gen.models.security_feature_type import SecurityFeatureType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ImageQualityCheck(BaseModel):
     """
-    openapi_types = {
-        'type': 'ImageQualityCheckType',
-        'result': 'CheckResult',
-        'feature_type': 'SecurityFeatureType',
-        'areas': 'AreaArray',
-        'mean': 'float',
-        'std_dev': 'float',
-        'probability': 'int'
-    }
-
-    attribute_map = {
-        'type': 'type',
-        'result': 'result',
-        'feature_type': 'featureType',
-        'areas': 'areas',
-        'mean': 'mean',
-        'std_dev': 'std_dev',
-        'probability': 'probability'
-    }
-
-    def __init__(self, type=None, result=None, feature_type=None, areas=None, mean=None, std_dev=None, probability=None, local_vars_configuration=None):  # noqa: E501
-        """ImageQualityCheck - 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._type = None
-        self._result = None
-        self._feature_type = None
-        self._areas = None
-        self._mean = None
-        self._std_dev = None
-        self._probability = None
-        self.discriminator = None
-
-        if type is not None:
-            self.type = type
-        if result is not None:
-            self.result = result
-        if feature_type is not None:
-            self.feature_type = feature_type
-        if areas is not None:
-            self.areas = areas
-        if mean is not None:
-            self.mean = mean
-        if std_dev is not None:
-            self.std_dev = std_dev
-        if probability is not None:
-            self.probability = probability
-
-    @property
-    def type(self):
-        """Gets the type of this ImageQualityCheck.  # noqa: E501
-
-
-        :return: The type of this ImageQualityCheck.  # noqa: E501
-        :rtype: ImageQualityCheckType
-        """
-        return self._type
-
-    @type.setter
-    def type(self, type):
-        """Sets the type of this ImageQualityCheck.
-
-
-        :param type: The type of this ImageQualityCheck.  # noqa: E501
-        :type type: ImageQualityCheckType
-        """
-
-        self._type = type
-
-    @property
-    def result(self):
-        """Gets the result of this ImageQualityCheck.  # noqa: E501
-
-
-        :return: The result of this ImageQualityCheck.  # noqa: E501
-        :rtype: CheckResult
-        """
-        return self._result
-
-    @result.setter
-    def result(self, result):
-        """Sets the result of this ImageQualityCheck.
-
-
-        :param result: The result of this ImageQualityCheck.  # noqa: E501
-        :type result: CheckResult
-        """
-
-        self._result = result
-
-    @property
-    def feature_type(self):
-        """Gets the feature_type of this ImageQualityCheck.  # noqa: E501
-
-
-        :return: The feature_type of this ImageQualityCheck.  # noqa: E501
-        :rtype: SecurityFeatureType
-        """
-        return self._feature_type
-
-    @feature_type.setter
-    def feature_type(self, feature_type):
-        """Sets the feature_type of this ImageQualityCheck.
-
-
-        :param feature_type: The feature_type of this ImageQualityCheck.  # noqa: E501
-        :type feature_type: SecurityFeatureType
-        """
-
-        self._feature_type = feature_type
-
-    @property
-    def areas(self):
-        """Gets the areas of this ImageQualityCheck.  # noqa: E501
-
-
-        :return: The areas of this ImageQualityCheck.  # noqa: E501
-        :rtype: AreaArray
-        """
-        return self._areas
-
-    @areas.setter
-    def areas(self, areas):
-        """Sets the areas of this ImageQualityCheck.
-
-
-        :param areas: The areas of this ImageQualityCheck.  # noqa: E501
-        :type areas: AreaArray
-        """
-
-        self._areas = areas
-
-    @property
-    def mean(self):
-        """Gets the mean of this ImageQualityCheck.  # noqa: E501
-
-
-        :return: The mean of this ImageQualityCheck.  # noqa: E501
-        :rtype: float
-        """
-        return self._mean
-
-    @mean.setter
-    def mean(self, mean):
-        """Sets the mean of this ImageQualityCheck.
-
-
-        :param mean: The mean of this ImageQualityCheck.  # noqa: E501
-        :type mean: float
-        """
-
-        self._mean = mean
-
-    @property
-    def std_dev(self):
-        """Gets the std_dev of this ImageQualityCheck.  # noqa: E501
-
-
-        :return: The std_dev of this ImageQualityCheck.  # noqa: E501
-        :rtype: float
+    ImageQualityCheck
+    """ # noqa: E501
+    type: ImageQualityCheckType
+    result: CheckResult
+    feature_type: SecurityFeatureType = Field(alias="featureType")
+    areas: Optional[AreaArray] = None
+    mean: Union[StrictFloat, StrictInt] = Field(description="Check mean value")
+    std_dev: Union[StrictFloat, StrictInt] = Field(description="Check deviation value")
+    probability: StrictInt = Field(description="Check probability value")
+    __properties: ClassVar[List[str]] = ["type", "result", "featureType", "areas", "mean", "std_dev", "probability"]
+
+    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 ImageQualityCheck 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._std_dev
-
-    @std_dev.setter
-    def std_dev(self, std_dev):
-        """Sets the std_dev of this ImageQualityCheck.
-
-
-        :param std_dev: The std_dev of this ImageQualityCheck.  # noqa: E501
-        :type std_dev: float
-        """
-
-        self._std_dev = std_dev
-
-    @property
-    def probability(self):
-        """Gets the probability of this ImageQualityCheck.  # noqa: E501
-
-
-        :return: The probability of this ImageQualityCheck.  # noqa: E501
-        :rtype: int
-        """
-        return self._probability
-
-    @probability.setter
-    def probability(self, probability):
-        """Sets the probability of this ImageQualityCheck.
-
-
-        :param probability: The probability of this ImageQualityCheck.  # noqa: E501
-        :type probability: int
-        """
-
-        self._probability = probability
-
-    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, ImageQualityCheck):
-            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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of areas
+        if self.areas:
+            _dict['areas'] = self.areas.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ImageQualityCheck from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "result": obj.get("result"),
+            "featureType": obj.get("featureType"),
+            "areas": AreaArray.from_dict(obj["areas"]) if obj.get("areas") is not None else None,
+            "mean": obj.get("mean"),
+            "std_dev": obj.get("std_dev"),
+            "probability": obj.get("probability")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, ImageQualityCheck):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,144 +4,89 @@
     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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
+from regula.documentreader.webclient.gen.models.image_quality_check import ImageQualityCheck
+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 ImageQualityCheckList(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
-    """
-    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.
+class ImageQualityCheckList(BaseModel):
     """
-    openapi_types = {
-        'result': 'CheckResult',
-        'list': 'list[ImageQualityCheck]'
-    }
-
-    attribute_map = {
-        'result': 'result',
-        'list': 'List'
-    }
-
-    def __init__(self, result=None, list=None, local_vars_configuration=None):  # noqa: E501
-        """ImageQualityCheckList - 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._result = None
-        self._list = None
-        self.discriminator = None
-
-        self.result = result
-        self.list = list
-
-    @property
-    def result(self):
-        """Gets the result of this ImageQualityCheckList.  # noqa: E501
-
-
-        :return: The result of this ImageQualityCheckList.  # noqa: E501
-        :rtype: CheckResult
+    ImageQualityCheckList
+    """ # noqa: E501
+    result: CheckResult
+    list: List[ImageQualityCheck] = Field(alias="List")
+    count: Union[StrictFloat, StrictInt] = Field(description="Number of List array elements", alias="Count")
+    __properties: ClassVar[List[str]] = ["result", "List", "Count"]
+
+    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 ImageQualityCheckList 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._result
-
-    @result.setter
-    def result(self, result):
-        """Sets the result of this ImageQualityCheckList.
-
-
-        :param result: The result of this ImageQualityCheckList.  # noqa: E501
-        :type result: CheckResult
-        """
-        if self.local_vars_configuration.client_side_validation and result is None:  # noqa: E501
-            raise ValueError("Invalid value for `result`, must not be `None`")  # noqa: E501
-
-        self._result = result
+        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 list (list)
+        _items = []
+        if self.list:
+            for _item_list in self.list:
+                if _item_list:
+                    _items.append(_item_list.to_dict())
+            _dict['List'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ImageQualityCheckList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "result": obj.get("result"),
+            "List": [ImageQualityCheck.from_dict(_item) for _item in obj["List"]] if obj.get("List") is not None else None,
+            "Count": obj.get("Count")
+        })
+        return _obj
 
-    @property
-    def list(self):
-        """Gets the list of this ImageQualityCheckList.  # noqa: E501
 
-
-        :return: The list of this ImageQualityCheckList.  # noqa: E501
-        :rtype: list[ImageQualityCheck]
-        """
-        return self._list
-
-    @list.setter
-    def list(self, list):
-        """Sets the list of this ImageQualityCheckList.
-
-
-        :param list: The list of this ImageQualityCheckList.  # noqa: E501
-        :type list: list[ImageQualityCheck]
-        """
-        if self.local_vars_configuration.client_side_validation and list is None:  # noqa: E501
-            raise ValueError("Invalid value for `list`, must not be `None`")  # noqa: E501
-
-        self._list = list
-
-    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, ImageQualityCheckList):
-            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, ImageQualityCheckList):
-            return True
-
-        return self.to_dict() != other.to_dict()

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