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

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

@@ -4,250 +4,87 @@
     Generated by: https://openapi-generator.tech
 """
 
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
+import json
 
-import six
+from pydantic import ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.gen.models.result import Result
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+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 AuthenticityResult(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class AuthenticityResult(ResultItem):
     """
+    AuthenticityResult
+    """ # noqa: E501
+    authenticity_check_list: AuthenticityCheckList = Field(alias="AuthenticityCheckList")
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "AuthenticityCheckList"]
 
-    """
-    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 = {
-        'authenticity_check_list': 'AuthenticityCheckList',
-        'buf_length': 'int',
-        'light': 'int',
-        'list_idx': 'int',
-        'page_idx': 'int',
-        'result_type': 'int'
-    }
-
-    attribute_map = {
-        'authenticity_check_list': 'AuthenticityCheckList',
-        'buf_length': 'buf_length',
-        'light': 'light',
-        'list_idx': 'list_idx',
-        'page_idx': 'page_idx',
-        'result_type': 'result_type'
-    }
-
-    def __init__(self, authenticity_check_list=None, buf_length=None, light=None, list_idx=None, page_idx=None, result_type=0, local_vars_configuration=None):  # noqa: E501
-        """AuthenticityResult - 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._authenticity_check_list = None
-        self._buf_length = None
-        self._light = None
-        self._list_idx = None
-        self._page_idx = None
-        self._result_type = None
-        self.discriminator = None
-
-        self.authenticity_check_list = authenticity_check_list
-        if buf_length is not None:
-            self.buf_length = buf_length
-        if light is not None:
-            self.light = light
-        if list_idx is not None:
-            self.list_idx = list_idx
-        if page_idx is not None:
-            self.page_idx = page_idx
-        self.result_type = result_type
-
-    @property
-    def authenticity_check_list(self):
-        """Gets the authenticity_check_list of this AuthenticityResult.  # noqa: E501
-
-
-        :return: The authenticity_check_list of this AuthenticityResult.  # noqa: E501
-        :rtype: AuthenticityCheckList
-        """
-        return self._authenticity_check_list
-
-    @authenticity_check_list.setter
-    def authenticity_check_list(self, authenticity_check_list):
-        """Sets the authenticity_check_list of this AuthenticityResult.
-
-
-        :param authenticity_check_list: The authenticity_check_list of this AuthenticityResult.  # noqa: E501
-        :type authenticity_check_list: AuthenticityCheckList
-        """
-        if self.local_vars_configuration.client_side_validation and authenticity_check_list is None:  # noqa: E501
-            raise ValueError("Invalid value for `authenticity_check_list`, must not be `None`")  # noqa: E501
-
-        self._authenticity_check_list = authenticity_check_list
-
-    @property
-    def buf_length(self):
-        """Gets the buf_length of this AuthenticityResult.  # noqa: E501
-
-
-        :return: The buf_length of this AuthenticityResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._buf_length
-
-    @buf_length.setter
-    def buf_length(self, buf_length):
-        """Sets the buf_length of this AuthenticityResult.
-
-
-        :param buf_length: The buf_length of this AuthenticityResult.  # noqa: E501
-        :type buf_length: int
-        """
-
-        self._buf_length = buf_length
-
-    @property
-    def light(self):
-        """Gets the light of this AuthenticityResult.  # noqa: E501
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
-        :return: The light of this AuthenticityResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._light
-
-    @light.setter
-    def light(self, light):
-        """Sets the light of this AuthenticityResult.
-
-
-        :param light: The light of this AuthenticityResult.  # noqa: E501
-        :type light: int
-        """
-
-        self._light = light
-
-    @property
-    def list_idx(self):
-        """Gets the list_idx of this AuthenticityResult.  # noqa: E501
-
-
-        :return: The list_idx of this AuthenticityResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._list_idx
-
-    @list_idx.setter
-    def list_idx(self, list_idx):
-        """Sets the list_idx of this AuthenticityResult.
-
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
 
-        :param list_idx: The list_idx of this AuthenticityResult.  # noqa: E501
-        :type list_idx: int
-        """
-
-        self._list_idx = list_idx
-
-    @property
-    def page_idx(self):
-        """Gets the page_idx of this AuthenticityResult.  # noqa: E501
-
-
-        :return: The page_idx of this AuthenticityResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._page_idx
+    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())
 
-    @page_idx.setter
-    def page_idx(self, page_idx):
-        """Sets the page_idx of this AuthenticityResult.
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AuthenticityResult 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.
 
-        :param page_idx: The page_idx of this AuthenticityResult.  # noqa: E501
-        :type page_idx: int
-        """
-
-        self._page_idx = page_idx
-
-    @property
-    def result_type(self):
-        """Gets the result_type of this AuthenticityResult.  # noqa: E501
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
 
-        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
-
-        :return: The result_type of this AuthenticityResult.  # noqa: E501
-        :rtype: int
+        * `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_type
-
-    @result_type.setter
-    def result_type(self, result_type):
-        """Sets the result_type of this AuthenticityResult.
+        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 authenticity_check_list
+        if self.authenticity_check_list:
+            _dict['AuthenticityCheckList'] = self.authenticity_check_list.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AuthenticityResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "buf_length": obj.get("buf_length"),
+            "light": obj.get("light"),
+            "list_idx": obj.get("list_idx"),
+            "page_idx": obj.get("page_idx"),
+            "result_type": obj.get("result_type"),
+            "AuthenticityCheckList": AuthenticityCheckList.from_dict(obj["AuthenticityCheckList"]) if obj.get("AuthenticityCheckList") is not None else None
+        })
+        return _obj
 
-        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
 
-        :param result_type: The result_type of this AuthenticityResult.  # noqa: E501
-        :type result_type: int
-        """
-        if self.local_vars_configuration.client_side_validation and result_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `result_type`, must not be `None`")  # noqa: E501
-
-        self._result_type = result_type
-
-    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, AuthenticityResult):
-            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, AuthenticityResult):
-            return True
-
-        return self.to_dict() != other.to_dict()

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

@@ -4,134 +4,46 @@
     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 *
-
-
-"""
-Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/.
-"""
-class AuthenticityResultType(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class AuthenticityResultType(int, Enum):
+    """
+    Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/.
     """
-
-    UV_LUMINESCENCE = int("1")
-
-    IR_B900 = int("2")
-
-    IMAGE_PATTERN = int("4")
-
-    AXIAL_PROTECTION = int("8")
-
-    UV_FIBERS = int("16")
-
-    IR_VISIBILITY = int("32")
-
-    OCR_SECURITY_TEXT = int("64")
-
-    IPI = int("128")
-
-    PHOTO_EMBED_TYPE = int("512")
-
-    OVI = int("1024")
-
-    HOLOGRAMS = int("4096")
-
-    PHOTO_AREA = int("8192")
-
-    PORTRAIT_COMPARISON = int("32768")
-
-    BARCODE_FORMAT_CHECK = int("65536")
-
-    KINEGRAM = int("131072")
-
-    LETTER_SCREEN = int("262144")
-
-    HOLOGRAM_DETECTION = int("524288")
-
-    FINGERPRINT_COMPARISON = int("1048576")
-
-    LIVENESS = int("2097152")
-
-    EXTENDED_OCR_CHECK = int("4194304")
-
-    EXTENDED_MRZ_CHECK = int("8388608")
-
-    ENCRYPTED_IPI = int("16777216")
-
-    allowable_values = [UV_LUMINESCENCE, IR_B900, IMAGE_PATTERN, AXIAL_PROTECTION, UV_FIBERS, IR_VISIBILITY, OCR_SECURITY_TEXT, IPI, PHOTO_EMBED_TYPE, OVI, HOLOGRAMS, PHOTO_AREA, PORTRAIT_COMPARISON, BARCODE_FORMAT_CHECK, KINEGRAM, LETTER_SCREEN, HOLOGRAM_DETECTION, FINGERPRINT_COMPARISON, LIVENESS, EXTENDED_OCR_CHECK, EXTENDED_MRZ_CHECK, ENCRYPTED_IPI]  # 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
-        """AuthenticityResultType - 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, AuthenticityResultType):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    UV_LUMINESCENCE = 1
+    IR_B900 = 2
+    IMAGE_PATTERN = 4
+    AXIAL_PROTECTION = 8
+    UV_FIBERS = 16
+    IR_VISIBILITY = 32
+    OCR_SECURITY_TEXT = 64
+    IPI = 128
+    PHOTO_EMBED_TYPE = 512
+    OVI = 1024
+    HOLOGRAMS = 4096
+    PHOTO_AREA = 8192
+    PORTRAIT_COMPARISON = 32768
+    BARCODE_FORMAT_CHECK = 65536
+    KINEGRAM = 131072
+    LETTER_SCREEN = 262144
+    HOLOGRAM_DETECTION = 524288
+    FINGERPRINT_COMPARISON = 1048576
+    LIVENESS = 2097152
+    EXTENDED_OCR_CHECK = 4194304
+    EXTENDED_MRZ_CHECK = 8388608
+    ENCRYPTED_IPI = 16777216
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AuthenticityResultType 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, AuthenticityResultType):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class BarCodeModuleType(int, Enum):
+    """
+    BarCodeModuleType
+    """
+
+    """
+    allowed enum values
+    """
+    TEXT = 0
+    BYTE = 1
+    NUM = 2
+    SHIFT = 3
+    ALL = 4
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BarCodeModuleType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class BarcodeType(int, Enum):
+    """
+    Enumeration contains the types of barcodes that can be processed
+    """
+
+    """
+    allowed enum values
+    """
+    UNKNOWN = 0
+    CODE128 = 1
+    CODE39 = 2
+    EAN8 = 3
+    ITF = 4
+    PDF417 = 5
+    STF = 6
+    MTF = 7
+    IATA = 8
+    CODABAR = 9
+    UPCA = 10
+    CODE93 = 11
+    UPCE = 12
+    EAN13 = 13
+    QRCODE = 14
+    AZTEC = 15
+    DATAMATRIX = 16
+    ALL_1D = 17
+    CODE11 = 18
+    JABCODE = 19
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BarcodeType from a JSON string"""
+        return cls(json.loads(json_str))
+
+