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

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

@@ -4,165 +4,228 @@
     Generated by: https://openapi-generator.tech
 """
 
-from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import json
-
-from importlib import import_module
-from pydantic import BaseModel, ConfigDict, Field, StrictInt
-from typing import Any, ClassVar, Dict, List, Optional, Union
-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 typing import Optional, Set
-from typing_extensions import Self
-
-from typing import TYPE_CHECKING
-if TYPE_CHECKING:
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.photo_ident_result import PhotoIdentResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.fiber_result import FiberResult
-    from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.ident_result import IdentResult
-    from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-    from regula.documentreader.webclient.gen.models.security_feature_result import SecurityFeatureResult
-
-class AuthenticityCheckResultItem(BaseModel):
+
+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 *
+
+
+"""
+Common fields for all authenticity result objects
+"""
+class AuthenticityCheckResultItem(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
     """
-    Common fields for all authenticity result objects
-    """ # noqa: E501
-    type: AuthenticityResultType = Field(alias="Type")
-    element_result: Optional[CheckResult] = Field(default=None, alias="ElementResult")
-    element_diagnose: Optional[CheckDiagnose] = Field(default=None, alias="ElementDiagnose")
-    percent_value: Optional[StrictInt] = Field(default=None, alias="PercentValue")
-    __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    # JSON field name that stores the object type
-    __discriminator_property_name: ClassVar[str] = 'Type'
-
-    # discriminator mappings
-    __discriminator_value_class_map: ClassVar[Dict[str, str]] = {
-        '1': 'SecurityFeatureResult','1024': 'IdentResult','1048576': 'IdentResult','128': 'PhotoIdentResult','131072': 'IdentResult','16': 'FiberResult','16777216': 'OCRSecurityTextResult','2': 'SecurityFeatureResult','2097152': 'IdentResult','262144': 'IdentResult','32': 'IdentResult','32768': 'IdentResult','4': 'IdentResult','4096': 'SecurityFeatureResult','4194304': 'SecurityFeatureResult','512': 'SecurityFeatureResult','524288': 'IdentResult','64': 'OCRSecurityTextResult','65536': 'SecurityFeatureResult','8': 'SecurityFeatureResult','8192': 'SecurityFeatureResult','8388608': 'SecurityFeatureResult'
+    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 = {
+        'type': 'int',
+        'element_result': 'CheckResult',
+        'element_diagnose': 'CheckDiagnose',
+        'percent_value': 'int'
+    }
+
+    attribute_map = {
+        'type': 'Type',
+        'element_result': 'ElementResult',
+        'element_diagnose': 'ElementDiagnose',
+        'percent_value': 'PercentValue'
+    }
+    discriminator_value_class_map = {
+        1 : 'SecurityFeatureResult',
+        1024 : 'IdentResult',
+        1048576 : 'IdentResult',
+        128 : 'PhotoIdentResult',
+        131072 : 'IdentResult',
+        16 : 'FiberResult',
+        16384 : 'FiberResult',
+        2 : 'SecurityFeatureResult',
+        2048 : 'IdentResult',
+        256 : 'PhotoIdentResult',
+        262144 : 'IdentResult',
+        32 : 'IdentResult',
+        32768 : 'IdentResult',
+        4 : 'IdentResult',
+        4096 : 'SecurityFeatureResult',
+        512 : 'SecurityFeatureResult',
+        524288 : 'IdentResult',
+        64 : 'OCRSecurityTextResult',
+        65536 : 'SecurityFeatureResult',
+        8 : 'SecurityFeatureResult',
+        8192 : 'SecurityFeatureResult',
+        8388608 : 'SecurityFeatureResult',
     }
 
-    @classmethod
-    def get_discriminator_value(cls, obj: Dict[str, Any]) -> Optional[str]:
-        """Returns the discriminator value (object type) of the data"""
-        discriminator_value = obj[cls.__discriminator_property_name]
-        if discriminator_value:
-            return cls.__discriminator_value_class_map.get(str(discriminator_value))
-        else:
-            return None
-
-    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[Union[SecurityFeatureResult, IdentResult, IdentResult, PhotoIdentResult, IdentResult, FiberResult, OCRSecurityTextResult, SecurityFeatureResult, IdentResult, IdentResult, IdentResult, IdentResult, IdentResult, SecurityFeatureResult, SecurityFeatureResult, SecurityFeatureResult, IdentResult, OCRSecurityTextResult, SecurityFeatureResult, SecurityFeatureResult, SecurityFeatureResult, SecurityFeatureResult]]:
-        """Create an instance of AuthenticityCheckResultItem 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.
+    def __init__(self, type=0, element_result=None, element_diagnose=None, percent_value=None, local_vars_configuration=None):  # noqa: E501
+        """AuthenticityCheckResultItem - 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.discriminator = 'type'
+
+        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
+
+    @property
+    def type(self):
+        """Gets the type of this AuthenticityCheckResultItem.  # 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 AuthenticityCheckResultItem.  # noqa: E501
+        :rtype: int
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """Sets the type of this AuthenticityCheckResultItem.
+
+        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 AuthenticityCheckResultItem.  # 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 AuthenticityCheckResultItem.  # noqa: E501
+
+
+        :return: The element_result of this AuthenticityCheckResultItem.  # noqa: E501
+        :rtype: CheckResult
         """
-        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: Dict[str, Any]) -> Optional[Union[SecurityFeatureResult, IdentResult, IdentResult, PhotoIdentResult, IdentResult, FiberResult, OCRSecurityTextResult, SecurityFeatureResult, IdentResult, IdentResult, IdentResult, IdentResult, IdentResult, SecurityFeatureResult, SecurityFeatureResult, SecurityFeatureResult, IdentResult, OCRSecurityTextResult, SecurityFeatureResult, SecurityFeatureResult, SecurityFeatureResult, SecurityFeatureResult]]:
-        """Create an instance of AuthenticityCheckResultItem from a dict"""
-        # look up the object type based on discriminator mapping
-        object_type = cls.get_discriminator_value(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'PhotoIdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.photo_ident_result").PhotoIdentResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'FiberResult':
-            return import_module("regula.documentreader.webclient.gen.models.fiber_result").FiberResult.from_dict(obj)
-        if object_type ==  'OCRSecurityTextResult':
-            return import_module("regula.documentreader.webclient.gen.models.ocr_security_text_result").OCRSecurityTextResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'IdentResult':
-            return import_module("regula.documentreader.webclient.gen.models.ident_result").IdentResult.from_dict(obj)
-        if object_type ==  'OCRSecurityTextResult':
-            return import_module("regula.documentreader.webclient.gen.models.ocr_security_text_result").OCRSecurityTextResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-        if object_type ==  'SecurityFeatureResult':
-            return import_module("regula.documentreader.webclient.gen.models.security_feature_result").SecurityFeatureResult.from_dict(obj)
-
-        raise ValueError("AuthenticityCheckResultItem failed to lookup discriminator value from " +
-                            json.dumps(obj) + ". Discriminator property name: " + cls.__discriminator_property_name +
-                            ", mapping: " + json.dumps(cls.__discriminator_value_class_map))
+        return self._element_result
 
+    @element_result.setter
+    def element_result(self, element_result):
+        """Sets the element_result of this AuthenticityCheckResultItem.
+
+
+        :param element_result: The element_result of this AuthenticityCheckResultItem.  # noqa: E501
+        :type element_result: CheckResult
+        """
+
+        self._element_result = element_result
+
+    @property
+    def element_diagnose(self):
+        """Gets the element_diagnose of this AuthenticityCheckResultItem.  # noqa: E501
+
+
+        :return: The element_diagnose of this AuthenticityCheckResultItem.  # noqa: E501
+        :rtype: CheckDiagnose
+        """
+        return self._element_diagnose
+
+    @element_diagnose.setter
+    def element_diagnose(self, element_diagnose):
+        """Sets the element_diagnose of this AuthenticityCheckResultItem.
+
+
+        :param element_diagnose: The element_diagnose of this AuthenticityCheckResultItem.  # noqa: E501
+        :type element_diagnose: CheckDiagnose
+        """
+
+        self._element_diagnose = element_diagnose
+
+    @property
+    def percent_value(self):
+        """Gets the percent_value of this AuthenticityCheckResultItem.  # noqa: E501
+
+
+        :return: The percent_value of this AuthenticityCheckResultItem.  # noqa: E501
+        :rtype: int
+        """
+        return self._percent_value
+
+    @percent_value.setter
+    def percent_value(self, percent_value):
+        """Sets the percent_value of this AuthenticityCheckResultItem.
+
+
+        :param percent_value: The percent_value of this AuthenticityCheckResultItem.  # noqa: E501
+        :type percent_value: int
+        """
 
+        self._percent_value = percent_value
+
+    def get_real_child_model(self, data):
+        """Returns the real base class specified by the discriminator"""
+        discriminator_key = self.attribute_map[self.discriminator]
+        discriminator_value = data[discriminator_key]
+        from regula.documentreader.webclient.ext.models import RawAuthenticityCheckResultItem
+        return self.discriminator_value_class_map.get(discriminator_value, RawAuthenticityCheckResultItem.__name__)
+
+    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, AuthenticityCheckResultItem):
+            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, AuthenticityCheckResultItem):
+            return True
+
+        return self.to_dict() != other.to_dict()