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

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

@@ -4,431 +4,115 @@
     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 PhotoIdentResult(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 ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.authenticity_check_result_item import AuthenticityCheckResultItem
+from regula.documentreader.webclient.gen.models.authenticity_result_type import AuthenticityResultType
+from regula.documentreader.webclient.gen.models.check_diagnose import CheckDiagnose
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
+from regula.documentreader.webclient.gen.models.image_data import ImageData
+from regula.documentreader.webclient.gen.models.light import Light
+from regula.documentreader.webclient.gen.models.raw_image_container_list import RawImageContainerList
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PhotoIdentResult(AuthenticityCheckResultItem):
     """
-    openapi_types = {
-        'type': 'int',
-        'element_result': 'CheckResult',
-        'element_diagnose': 'CheckDiagnose',
-        'percent_value': 'int',
-        'light_index': 'Light',
-        'area': 'RectangleCoordinates',
-        'source_image': 'ImageData',
-        'result_images': 'RawImageContainerList',
-        'field_types_count': 'int',
-        'field_types_list': 'list[int]',
-        'step': 'int',
-        'angle': 'int',
-        'reserved3': 'int'
-    }
-
-    attribute_map = {
-        'type': 'Type',
-        'element_result': 'ElementResult',
-        'element_diagnose': 'ElementDiagnose',
-        'percent_value': 'PercentValue',
-        'light_index': 'LightIndex',
-        'area': 'Area',
-        'source_image': 'SourceImage',
-        'result_images': 'ResultImages',
-        'field_types_count': 'FieldTypesCount',
-        'field_types_list': 'FieldTypesList',
-        'step': 'Step',
-        'angle': 'Angle',
-        'reserved3': 'Reserved3'
-    }
-
-    def __init__(self, type=0, element_result=None, element_diagnose=None, percent_value=None, light_index=None, area=None, source_image=None, result_images=None, field_types_count=None, field_types_list=None, step=None, angle=None, reserved3=None, local_vars_configuration=None):  # noqa: E501
-        """PhotoIdentResult - 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._element_result = None
-        self._element_diagnose = None
-        self._percent_value = None
-        self._light_index = None
-        self._area = None
-        self._source_image = None
-        self._result_images = None
-        self._field_types_count = None
-        self._field_types_list = None
-        self._step = None
-        self._angle = None
-        self._reserved3 = None
-        self.discriminator = None
-
-        self.type = type
-        if element_result is not None:
-            self.element_result = element_result
-        if element_diagnose is not None:
-            self.element_diagnose = element_diagnose
-        if percent_value is not None:
-            self.percent_value = percent_value
-        if light_index is not None:
-            self.light_index = light_index
-        if area is not None:
-            self.area = area
-        if source_image is not None:
-            self.source_image = source_image
-        if result_images is not None:
-            self.result_images = result_images
-        if field_types_count is not None:
-            self.field_types_count = field_types_count
-        if field_types_list is not None:
-            self.field_types_list = field_types_list
-        if step is not None:
-            self.step = step
-        if angle is not None:
-            self.angle = angle
-        if reserved3 is not None:
-            self.reserved3 = reserved3
-
-    @property
-    def type(self):
-        """Gets the type of this PhotoIdentResult.  # noqa: E501
-
-        Same as authenticity result type, but used for safe parsing of not-described values: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/  # noqa: E501
-
-        :return: The type of this PhotoIdentResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._type
-
-    @type.setter
-    def type(self, type):
-        """Sets the type of this PhotoIdentResult.
-
-        Same as authenticity result type, but used for safe parsing of not-described values: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/  # noqa: E501
-
-        :param type: The type of this PhotoIdentResult.  # noqa: E501
-        :type type: int
-        """
-        if self.local_vars_configuration.client_side_validation and type is None:  # noqa: E501
-            raise ValueError("Invalid value for `type`, must not be `None`")  # noqa: E501
-
-        self._type = type
-
-    @property
-    def element_result(self):
-        """Gets the element_result of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The element_result of this PhotoIdentResult.  # noqa: E501
-        :rtype: CheckResult
-        """
-        return self._element_result
-
-    @element_result.setter
-    def element_result(self, element_result):
-        """Sets the element_result of this PhotoIdentResult.
-
-
-        :param element_result: The element_result of this PhotoIdentResult.  # noqa: E501
-        :type element_result: CheckResult
-        """
-
-        self._element_result = element_result
-
-    @property
-    def element_diagnose(self):
-        """Gets the element_diagnose of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The element_diagnose of this PhotoIdentResult.  # noqa: E501
-        :rtype: CheckDiagnose
-        """
-        return self._element_diagnose
-
-    @element_diagnose.setter
-    def element_diagnose(self, element_diagnose):
-        """Sets the element_diagnose of this PhotoIdentResult.
-
-
-        :param element_diagnose: The element_diagnose of this PhotoIdentResult.  # noqa: E501
-        :type element_diagnose: CheckDiagnose
-        """
-
-        self._element_diagnose = element_diagnose
-
-    @property
-    def percent_value(self):
-        """Gets the percent_value of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The percent_value of this PhotoIdentResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._percent_value
-
-    @percent_value.setter
-    def percent_value(self, percent_value):
-        """Sets the percent_value of this PhotoIdentResult.
-
-
-        :param percent_value: The percent_value of this PhotoIdentResult.  # noqa: E501
-        :type percent_value: int
-        """
-
-        self._percent_value = percent_value
-
-    @property
-    def light_index(self):
-        """Gets the light_index of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The light_index of this PhotoIdentResult.  # noqa: E501
-        :rtype: Light
-        """
-        return self._light_index
-
-    @light_index.setter
-    def light_index(self, light_index):
-        """Sets the light_index of this PhotoIdentResult.
-
-
-        :param light_index: The light_index of this PhotoIdentResult.  # noqa: E501
-        :type light_index: Light
-        """
-
-        self._light_index = light_index
-
-    @property
-    def area(self):
-        """Gets the area of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The area of this PhotoIdentResult.  # noqa: E501
-        :rtype: RectangleCoordinates
-        """
-        return self._area
-
-    @area.setter
-    def area(self, area):
-        """Sets the area of this PhotoIdentResult.
-
-
-        :param area: The area of this PhotoIdentResult.  # noqa: E501
-        :type area: RectangleCoordinates
-        """
-
-        self._area = area
-
-    @property
-    def source_image(self):
-        """Gets the source_image of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The source_image of this PhotoIdentResult.  # noqa: E501
-        :rtype: ImageData
-        """
-        return self._source_image
-
-    @source_image.setter
-    def source_image(self, source_image):
-        """Sets the source_image of this PhotoIdentResult.
-
-
-        :param source_image: The source_image of this PhotoIdentResult.  # noqa: E501
-        :type source_image: ImageData
-        """
-
-        self._source_image = source_image
-
-    @property
-    def result_images(self):
-        """Gets the result_images of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The result_images of this PhotoIdentResult.  # noqa: E501
-        :rtype: RawImageContainerList
-        """
-        return self._result_images
-
-    @result_images.setter
-    def result_images(self, result_images):
-        """Sets the result_images of this PhotoIdentResult.
-
-
-        :param result_images: The result_images of this PhotoIdentResult.  # noqa: E501
-        :type result_images: RawImageContainerList
-        """
-
-        self._result_images = result_images
-
-    @property
-    def field_types_count(self):
-        """Gets the field_types_count of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The field_types_count of this PhotoIdentResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._field_types_count
-
-    @field_types_count.setter
-    def field_types_count(self, field_types_count):
-        """Sets the field_types_count of this PhotoIdentResult.
-
-
-        :param field_types_count: The field_types_count of this PhotoIdentResult.  # noqa: E501
-        :type field_types_count: int
-        """
-
-        self._field_types_count = field_types_count
-
-    @property
-    def field_types_list(self):
-        """Gets the field_types_list of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The field_types_list of this PhotoIdentResult.  # noqa: E501
-        :rtype: list[int]
-        """
-        return self._field_types_list
-
-    @field_types_list.setter
-    def field_types_list(self, field_types_list):
-        """Sets the field_types_list of this PhotoIdentResult.
-
-
-        :param field_types_list: The field_types_list of this PhotoIdentResult.  # noqa: E501
-        :type field_types_list: list[int]
-        """
-
-        self._field_types_list = field_types_list
-
-    @property
-    def step(self):
-        """Gets the step of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The step of this PhotoIdentResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._step
-
-    @step.setter
-    def step(self, step):
-        """Sets the step of this PhotoIdentResult.
-
-
-        :param step: The step of this PhotoIdentResult.  # noqa: E501
-        :type step: int
-        """
-
-        self._step = step
-
-    @property
-    def angle(self):
-        """Gets the angle of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The angle of this PhotoIdentResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._angle
-
-    @angle.setter
-    def angle(self, angle):
-        """Sets the angle of this PhotoIdentResult.
-
-
-        :param angle: The angle of this PhotoIdentResult.  # noqa: E501
-        :type angle: int
-        """
-
-        self._angle = angle
-
-    @property
-    def reserved3(self):
-        """Gets the reserved3 of this PhotoIdentResult.  # noqa: E501
-
-
-        :return: The reserved3 of this PhotoIdentResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._reserved3
-
-    @reserved3.setter
-    def reserved3(self, reserved3):
-        """Sets the reserved3 of this PhotoIdentResult.
-
-
-        :param reserved3: The reserved3 of this PhotoIdentResult.  # noqa: E501
-        :type reserved3: int
-        """
-
-        self._reserved3 = reserved3
-
-    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, PhotoIdentResult):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    PhotoIdentResult
+    """ # noqa: E501
+    light_index: Light = Field(alias="LightIndex")
+    area: RectangleCoordinates = Field(alias="Area")
+    source_image: ImageData = Field(alias="SourceImage")
+    result_images: RawImageContainerList = Field(alias="ResultImages")
+    field_types_count: Optional[StrictInt] = Field(default=None, alias="FieldTypesCount")
+    field_types_list: Optional[List[StrictInt]] = Field(default=None, alias="FieldTypesList")
+    step: Optional[StrictInt] = Field(default=None, alias="Step")
+    angle: Optional[StrictInt] = Field(default=None, alias="Angle")
+    result: Optional[StrictInt] = Field(default=None, alias="Result")
+    reserved3: Optional[StrictInt] = Field(default=None, alias="Reserved3")
+    __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue", "LightIndex", "Area", "SourceImage", "ResultImages", "FieldTypesCount", "FieldTypesList", "Step", "Angle", "Result", "Reserved3"]
+
+    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 PhotoIdentResult 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 area
+        if self.area:
+            _dict['Area'] = self.area.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of source_image
+        if self.source_image:
+            _dict['SourceImage'] = self.source_image.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of result_images
+        if self.result_images:
+            _dict['ResultImages'] = self.result_images.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PhotoIdentResult 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"),
+            "ElementResult": obj.get("ElementResult"),
+            "ElementDiagnose": obj.get("ElementDiagnose"),
+            "PercentValue": obj.get("PercentValue"),
+            "LightIndex": obj.get("LightIndex"),
+            "Area": RectangleCoordinates.from_dict(obj["Area"]) if obj.get("Area") is not None else None,
+            "SourceImage": ImageData.from_dict(obj["SourceImage"]) if obj.get("SourceImage") is not None else None,
+            "ResultImages": RawImageContainerList.from_dict(obj["ResultImages"]) if obj.get("ResultImages") is not None else None,
+            "FieldTypesCount": obj.get("FieldTypesCount"),
+            "FieldTypesList": obj.get("FieldTypesList"),
+            "Step": obj.get("Step"),
+            "Angle": obj.get("Angle"),
+            "Result": obj.get("Result"),
+            "Reserved3": obj.get("Reserved3")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, PhotoIdentResult):
-            return True
 
-        return self.to_dict() != other.to_dict()