regula-documentreader-webclient 7.6.295rc0__py3-none-any.whl → 7.6.297.dev0__py3-none-any.whl

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

@@ -4,196 +4,77 @@
     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 contains identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/
-"""
-class SecurityFeatureType(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class SecurityFeatureType(int, Enum):
+    """
+    Enumeration contains identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/
     """
-
-    BLANK = int("0")
-
-    FILL = int("1")
-
-    PHOTO = int("2")
-
-    MRZ = int("3")
-
-    FALSE_LUMINESCENCE = int("4")
-
-    HOLO_SIMPLE = int("5")
-
-    HOLO_VERIFY_STATIC = int("6")
-
-    HOLO_VERIFY_MULTI_STATIC = int("7")
-
-    HOLO_VERIFY_DYNAMIC = int("8")
-
-    PATTERN_NOT_INTERRUPTED = int("9")
-
-    PATTERN_NOT_SHIFTED = int("10")
-
-    PATTERN_SAME_COLORS = int("11")
-
-    PATTERN_IR_INVISIBLE = int("12")
-
-    PHOTO_SIZE_CHECK = int("13")
-
-    PORTRAIT_COMPARISON_VS_GHOST = int("14")
-
-    PORTRAIT_COMPARISON_VS_RFID = int("15")
-
-    PORTRAIT_COMPARISON_VS_VISUAL = int("16")
-
-    BARCODE = int("17")
-
-    PATTERN_DIFFERENT_LINES_THICKNESS = int("18")
-
-    PORTRAIT_COMPARISON_VS_CAMERA = int("19")
-
-    PORTRAIT_COMPARISON_RFID_VS_CAMERA = int("20")
-
-    GHOST_PHOTO = int("21")
-
-    CLEAR_GHOST_PHOTO = int("22")
-
-    INVISIBLE_OBJECT = int("23")
-
-    LOW_CONTRAST_OBJECT = int("24")
-
-    PHOTO_COLOR = int("25")
-
-    PHOTO_SHAPE = int("26")
-
-    PHOTO_CORNERS = int("27")
-
-    OCR = int("28")
-
-    PORTRAIT_COMPARISON_EXT_VS_VISUAL = int("29")
-
-    PORTRAIT_COMPARISON_EXT_VS_RFID = int("30")
-
-    PORTRAIT_COMPARISON_EXT_VS_CAMERA = int("31")
-
-    LIVENESS_DEPTH = int("32")
-
-    MICRO_TEXT = int("33")
-
-    FLUORESCENT_OBJECT = int("34")
-
-    LANDMARK_CHECK = int("35")
-
-    FACE_PRESENCE = int("36")
-
-    FACE_ABSENCE = int("38")
-
-    LIVENESS_SCREEN_CAPTURE = int("39")
-
-    LIVENESS_ELECTRONIC_DEVICE = int("40")
-
-    LIVENESS_OVI = int("41")
-
-    BARCODE_SIZE_CHECK = int("42")
-
-    LASINK = int("43")
-
-    LIVENESS_MLI = int("44")
-
-    LIVENESS_BARCODE_BACKGROUND = int("45")
-
-    PORTRAIT_COMPARISON_VS_BARCODE = int("46")
-
-    PORTRAIT_COMPARISON_RFID_VS_BARCODE = int("47")
-
-    PORTRAIT_COMPARISON_EXT_VS_BARCODE = int("48")
-
-    PORTRAIT_COMPARISON_BARCODE_VS_CAMERA = int("49")
-
-    CHECK_DIGITAL_SIGNATURE = int("50")
-
-    CONTACT_CHIP_CLASSIFICATION = int("51")
-
-    HEAD_POSITION_CHECK = int("52")
-
-    LIVENESS_BLACK_AND_WHITE_COPY_CHECK = int("53")
-
-    allowable_values = [BLANK, FILL, PHOTO, MRZ, FALSE_LUMINESCENCE, HOLO_SIMPLE, HOLO_VERIFY_STATIC, HOLO_VERIFY_MULTI_STATIC, HOLO_VERIFY_DYNAMIC, PATTERN_NOT_INTERRUPTED, PATTERN_NOT_SHIFTED, PATTERN_SAME_COLORS, PATTERN_IR_INVISIBLE, PHOTO_SIZE_CHECK, PORTRAIT_COMPARISON_VS_GHOST, PORTRAIT_COMPARISON_VS_RFID, PORTRAIT_COMPARISON_VS_VISUAL, BARCODE, PATTERN_DIFFERENT_LINES_THICKNESS, PORTRAIT_COMPARISON_VS_CAMERA, PORTRAIT_COMPARISON_RFID_VS_CAMERA, GHOST_PHOTO, CLEAR_GHOST_PHOTO, INVISIBLE_OBJECT, LOW_CONTRAST_OBJECT, PHOTO_COLOR, PHOTO_SHAPE, PHOTO_CORNERS, OCR, PORTRAIT_COMPARISON_EXT_VS_VISUAL, PORTRAIT_COMPARISON_EXT_VS_RFID, PORTRAIT_COMPARISON_EXT_VS_CAMERA, LIVENESS_DEPTH, MICRO_TEXT, FLUORESCENT_OBJECT, LANDMARK_CHECK, FACE_PRESENCE, FACE_ABSENCE, LIVENESS_SCREEN_CAPTURE, LIVENESS_ELECTRONIC_DEVICE, LIVENESS_OVI, BARCODE_SIZE_CHECK, LASINK, LIVENESS_MLI, LIVENESS_BARCODE_BACKGROUND, PORTRAIT_COMPARISON_VS_BARCODE, PORTRAIT_COMPARISON_RFID_VS_BARCODE, PORTRAIT_COMPARISON_EXT_VS_BARCODE, PORTRAIT_COMPARISON_BARCODE_VS_CAMERA, CHECK_DIGITAL_SIGNATURE, CONTACT_CHIP_CLASSIFICATION, HEAD_POSITION_CHECK, LIVENESS_BLACK_AND_WHITE_COPY_CHECK]  # 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
-        """SecurityFeatureType - 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, SecurityFeatureType):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    BLANK = 0
+    FILL = 1
+    PHOTO = 2
+    MRZ = 3
+    FALSE_LUMINESCENCE = 4
+    HOLO_SIMPLE = 5
+    HOLO_VERIFY_STATIC = 6
+    HOLO_VERIFY_MULTI_STATIC = 7
+    HOLO_VERIFY_DYNAMIC = 8
+    PATTERN_NOT_INTERRUPTED = 9
+    PATTERN_NOT_SHIFTED = 10
+    PATTERN_SAME_COLORS = 11
+    PATTERN_IR_INVISIBLE = 12
+    PHOTO_SIZE_CHECK = 13
+    PORTRAIT_COMPARISON_VS_GHOST = 14
+    PORTRAIT_COMPARISON_VS_RFID = 15
+    PORTRAIT_COMPARISON_VS_VISUAL = 16
+    BARCODE = 17
+    PATTERN_DIFFERENT_LINES_THICKNESS = 18
+    PORTRAIT_COMPARISON_VS_CAMERA = 19
+    PORTRAIT_COMPARISON_RFID_VS_CAMERA = 20
+    GHOST_PHOTO = 21
+    CLEAR_GHOST_PHOTO = 22
+    INVISIBLE_OBJECT = 23
+    LOW_CONTRAST_OBJECT = 24
+    PHOTO_COLOR = 25
+    PHOTO_SHAPE = 26
+    PHOTO_CORNERS = 27
+    OCR = 28
+    PORTRAIT_COMPARISON_EXT_VS_VISUAL = 29
+    PORTRAIT_COMPARISON_EXT_VS_RFID = 30
+    PORTRAIT_COMPARISON_EXT_VS_CAMERA = 31
+    LIVENESS_DEPTH = 32
+    MICRO_TEXT = 33
+    FLUORESCENT_OBJECT = 34
+    LANDMARK_CHECK = 35
+    FACE_PRESENCE = 36
+    FACE_ABSENCE = 38
+    LIVENESS_SCREEN_CAPTURE = 39
+    LIVENESS_ELECTRONIC_DEVICE = 40
+    LIVENESS_OVI = 41
+    BARCODE_SIZE_CHECK = 42
+    LASINK = 43
+    LIVENESS_MLI = 44
+    LIVENESS_BARCODE_BACKGROUND = 45
+    PORTRAIT_COMPARISON_VS_BARCODE = 46
+    PORTRAIT_COMPARISON_RFID_VS_BARCODE = 47
+    PORTRAIT_COMPARISON_EXT_VS_BARCODE = 48
+    PORTRAIT_COMPARISON_BARCODE_VS_CAMERA = 49
+    CHECK_DIGITAL_SIGNATURE = 50
+    CONTACT_CHIP_CLASSIFICATION = 51
+    HEAD_POSITION_CHECK = 52
+    LIVENESS_BLACK_AND_WHITE_COPY_CHECK = 53
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SecurityFeatureType 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, SecurityFeatureType):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

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

@@ -4,100 +4,30 @@
     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 *
-
-
-"""
-Document data sources
-"""
-class Source(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class Source(str, Enum):
+    """
+    Document data sources
     """
-
-    MRZ = "MRZ"
-
-    VISUAL = "VISUAL"
-
-    BARCODE = "BARCODE"
-
-    RFID = "RFID"
-
-    MAGNETIC = "MAGNETIC"
-
-    allowable_values = [MRZ, VISUAL, BARCODE, RFID, MAGNETIC]  # 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
-        """Source - 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, Source):
-            return False
+    MRZ = 'MRZ'
+    VISUAL = 'VISUAL'
+    BARCODE = 'BARCODE'
+    RFID = 'RFID'
+    MAGNETIC = 'MAGNETIC'
+    EXTERNAL = 'EXTERNAL'
 
-        return self.to_dict() == other.to_dict()
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Source 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, Source):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,144 +4,80 @@
     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
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
+from regula.documentreader.webclient.gen.models.source import Source
+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 SourceValidity(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class SourceValidity(BaseModel):
     """
-
-    """
-    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 = {
-        'source': 'Source',
-        'status': 'CheckResult'
-    }
-
-    attribute_map = {
-        'source': 'source',
-        'status': 'status'
-    }
-
-    def __init__(self, source=None, status=None, local_vars_configuration=None):  # noqa: E501
-        """SourceValidity - 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._source = None
-        self._status = None
-        self.discriminator = None
-
-        self.source = source
-        self.status = status
-
-    @property
-    def source(self):
-        """Gets the source of this SourceValidity.  # noqa: E501
-
-
-        :return: The source of this SourceValidity.  # noqa: E501
-        :rtype: Source
+    SourceValidity
+    """ # noqa: E501
+    source: Source
+    status: CheckResult
+    __properties: ClassVar[List[str]] = ["source", "status"]
+
+    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 SourceValidity 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._source
-
-    @source.setter
-    def source(self, source):
-        """Sets the source of this SourceValidity.
+        excluded_fields: Set[str] = set([
+        ])
 
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
 
-        :param source: The source of this SourceValidity.  # noqa: E501
-        :type source: Source
-        """
-        if self.local_vars_configuration.client_side_validation and source is None:  # noqa: E501
-            raise ValueError("Invalid value for `source`, must not be `None`")  # noqa: E501
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SourceValidity from a dict"""
+        if obj is None:
+            return None
 
-        self._source = source
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
 
-    @property
-    def status(self):
-        """Gets the status of this SourceValidity.  # noqa: E501
+        _obj = cls.model_validate({
+            "source": obj.get("source"),
+            "status": obj.get("status")
+        })
+        return _obj
 
 
-        :return: The status of this SourceValidity.  # noqa: E501
-        :rtype: CheckResult
-        """
-        return self._status
-
-    @status.setter
-    def status(self, status):
-        """Sets the status of this SourceValidity.
-
-
-        :param status: The status of this SourceValidity.  # noqa: E501
-        :type status: CheckResult
-        """
-        if self.local_vars_configuration.client_side_validation and status is None:  # noqa: E501
-            raise ValueError("Invalid value for `status`, must not be `None`")  # noqa: E501
-
-        self._status = status
-
-    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, SourceValidity):
-            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, SourceValidity):
-            return True
-
-        return self.to_dict() != other.to_dict()