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

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

@@ -4,85 +4,220 @@
     Generated by: https://openapi-generator.tech
 """
 
-from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from regula.documentreader.webclient.gen.models.bar_code_module_type import BarCodeModuleType
-from typing import Optional, Set
-from typing_extensions import Self
+import six
 
-class DataModule(BaseModel):
+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 DataModule(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
     """
-    DataModule
-    """ # noqa: E501
-    m_data: StrictStr = Field(alias="mData")
-    m_length: StrictInt = Field(alias="mLength")
-    m_reserved1: Optional[StrictInt] = Field(default=None, alias="mReserved1")
-    m_reserver2: Optional[StrictInt] = Field(default=None, alias="mReserver2")
-    m_type: BarCodeModuleType = Field(alias="mType")
-    __properties: ClassVar[List[str]] = ["mData", "mLength", "mReserved1", "mReserver2", "mType"]
-
-    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 DataModule 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.
+
+    """
+    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 = {
+        'm_data': 'str',
+        'm_length': 'int',
+        'm_reserved1': 'int',
+        'm_reserver2': 'int',
+        'm_type': 'int'
+    }
+
+    attribute_map = {
+        'm_data': 'mData',
+        'm_length': 'mLength',
+        'm_reserved1': 'mReserved1',
+        'm_reserver2': 'mReserver2',
+        'm_type': 'mType'
+    }
+
+    def __init__(self, m_data=None, m_length=None, m_reserved1=None, m_reserver2=None, m_type=None, local_vars_configuration=None):  # noqa: E501
+        """DataModule - 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._m_data = None
+        self._m_length = None
+        self._m_reserved1 = None
+        self._m_reserver2 = None
+        self._m_type = None
+        self.discriminator = None
+
+        if m_data is not None:
+            self.m_data = m_data
+        if m_length is not None:
+            self.m_length = m_length
+        if m_reserved1 is not None:
+            self.m_reserved1 = m_reserved1
+        if m_reserver2 is not None:
+            self.m_reserver2 = m_reserver2
+        if m_type is not None:
+            self.m_type = m_type
+
+    @property
+    def m_data(self):
+        """Gets the m_data of this DataModule.  # noqa: E501
+
+
+        :return: The m_data of this DataModule.  # noqa: E501
+        :rtype: str
+        """
+        return self._m_data
+
+    @m_data.setter
+    def m_data(self, m_data):
+        """Sets the m_data of this DataModule.
+
+
+        :param m_data: The m_data of this DataModule.  # noqa: E501
+        :type m_data: str
+        """
+
+        self._m_data = m_data
+
+    @property
+    def m_length(self):
+        """Gets the m_length of this DataModule.  # noqa: E501
+
+
+        :return: The m_length of this DataModule.  # noqa: E501
+        :rtype: int
+        """
+        return self._m_length
+
+    @m_length.setter
+    def m_length(self, m_length):
+        """Sets the m_length of this DataModule.
+
+
+        :param m_length: The m_length of this DataModule.  # noqa: E501
+        :type m_length: int
+        """
+
+        self._m_length = m_length
+
+    @property
+    def m_reserved1(self):
+        """Gets the m_reserved1 of this DataModule.  # noqa: E501
+
+
+        :return: The m_reserved1 of this DataModule.  # noqa: E501
+        :rtype: int
+        """
+        return self._m_reserved1
+
+    @m_reserved1.setter
+    def m_reserved1(self, m_reserved1):
+        """Sets the m_reserved1 of this DataModule.
+
+
+        :param m_reserved1: The m_reserved1 of this DataModule.  # noqa: E501
+        :type m_reserved1: int
+        """
+
+        self._m_reserved1 = m_reserved1
+
+    @property
+    def m_reserver2(self):
+        """Gets the m_reserver2 of this DataModule.  # noqa: E501
+
+
+        :return: The m_reserver2 of this DataModule.  # noqa: E501
+        :rtype: int
         """
-        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: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DataModule from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "mData": obj.get("mData"),
-            "mLength": obj.get("mLength"),
-            "mReserved1": obj.get("mReserved1"),
-            "mReserver2": obj.get("mReserver2"),
-            "mType": obj.get("mType")
-        })
-        return _obj
+        return self._m_reserver2
 
+    @m_reserver2.setter
+    def m_reserver2(self, m_reserver2):
+        """Sets the m_reserver2 of this DataModule.
+
+
+        :param m_reserver2: The m_reserver2 of this DataModule.  # noqa: E501
+        :type m_reserver2: int
+        """
+
+        self._m_reserver2 = m_reserver2
+
+    @property
+    def m_type(self):
+        """Gets the m_type of this DataModule.  # noqa: E501
+
+
+        :return: The m_type of this DataModule.  # noqa: E501
+        :rtype: int
+        """
+        return self._m_type
+
+    @m_type.setter
+    def m_type(self, m_type):
+        """Sets the m_type of this DataModule.
+
+
+        :param m_type: The m_type of this DataModule.  # noqa: E501
+        :type m_type: int
+        """
 
+        self._m_type = m_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, DataModule):
+            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, DataModule):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -4,93 +4,308 @@
     Generated by: https://openapi-generator.tech
 """
 
-from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt
-from typing import Any, ClassVar, Dict, List, Optional
-from regula.documentreader.webclient.gen.models.check_result import CheckResult
-from typing import Optional, Set
-from typing_extensions import Self
+import six
 
-class DetailsOptical(BaseModel):
+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 DetailsOptical(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
     """
-    Details on performed optical checks
-    """ # noqa: E501
-    overall_status: CheckResult = Field(alias="overallStatus")
-    doc_type: CheckResult = Field(alias="docType")
-    expiry: CheckResult
-    image_qa: CheckResult = Field(alias="imageQA")
-    mrz: CheckResult
-    pages_count: StrictInt = Field(description="Number of processed pages in the document", alias="pagesCount")
-    security: CheckResult
-    text: CheckResult
-    vds: Optional[StrictInt] = None
-    __properties: ClassVar[List[str]] = ["overallStatus", "docType", "expiry", "imageQA", "mrz", "pagesCount", "security", "text", "vds"]
-
-    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 DetailsOptical 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,
-        )
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DetailsOptical from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "overallStatus": obj.get("overallStatus"),
-            "docType": obj.get("docType"),
-            "expiry": obj.get("expiry"),
-            "imageQA": obj.get("imageQA"),
-            "mrz": obj.get("mrz"),
-            "pagesCount": obj.get("pagesCount"),
-            "security": obj.get("security"),
-            "text": obj.get("text"),
-            "vds": obj.get("vds")
-        })
-        return _obj
 
+    """
+    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 = {
+        'overall_status': 'CheckResult',
+        'doc_type': 'CheckResult',
+        'expiry': 'CheckResult',
+        'image_qa': 'CheckResult',
+        'mrz': 'CheckResult',
+        'pages_count': 'int',
+        'security': 'CheckResult',
+        'text': 'CheckResult'
+    }
+
+    attribute_map = {
+        'overall_status': 'overallStatus',
+        'doc_type': 'docType',
+        'expiry': 'expiry',
+        'image_qa': 'imageQA',
+        'mrz': 'mrz',
+        'pages_count': 'pagesCount',
+        'security': 'security',
+        'text': 'text'
+    }
+
+    def __init__(self, overall_status=None, doc_type=None, expiry=None, image_qa=None, mrz=None, pages_count=None, security=None, text=None, local_vars_configuration=None):  # noqa: E501
+        """DetailsOptical - 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._overall_status = None
+        self._doc_type = None
+        self._expiry = None
+        self._image_qa = None
+        self._mrz = None
+        self._pages_count = None
+        self._security = None
+        self._text = None
+        self.discriminator = None
+
+        self.overall_status = overall_status
+        self.doc_type = doc_type
+        self.expiry = expiry
+        self.image_qa = image_qa
+        self.mrz = mrz
+        self.pages_count = pages_count
+        self.security = security
+        self.text = text
+
+    @property
+    def overall_status(self):
+        """Gets the overall_status of this DetailsOptical.  # noqa: E501
+
+
+        :return: The overall_status of this DetailsOptical.  # noqa: E501
+        :rtype: CheckResult
+        """
+        return self._overall_status
+
+    @overall_status.setter
+    def overall_status(self, overall_status):
+        """Sets the overall_status of this DetailsOptical.
+
+
+        :param overall_status: The overall_status of this DetailsOptical.  # noqa: E501
+        :type overall_status: CheckResult
+        """
+        if self.local_vars_configuration.client_side_validation and overall_status is None:  # noqa: E501
+            raise ValueError("Invalid value for `overall_status`, must not be `None`")  # noqa: E501
+
+        self._overall_status = overall_status
+
+    @property
+    def doc_type(self):
+        """Gets the doc_type of this DetailsOptical.  # noqa: E501
+
+
+        :return: The doc_type of this DetailsOptical.  # noqa: E501
+        :rtype: CheckResult
+        """
+        return self._doc_type
+
+    @doc_type.setter
+    def doc_type(self, doc_type):
+        """Sets the doc_type of this DetailsOptical.
+
+
+        :param doc_type: The doc_type of this DetailsOptical.  # noqa: E501
+        :type doc_type: CheckResult
+        """
+        if self.local_vars_configuration.client_side_validation and doc_type is None:  # noqa: E501
+            raise ValueError("Invalid value for `doc_type`, must not be `None`")  # noqa: E501
+
+        self._doc_type = doc_type
+
+    @property
+    def expiry(self):
+        """Gets the expiry of this DetailsOptical.  # noqa: E501
+
+
+        :return: The expiry of this DetailsOptical.  # noqa: E501
+        :rtype: CheckResult
+        """
+        return self._expiry
+
+    @expiry.setter
+    def expiry(self, expiry):
+        """Sets the expiry of this DetailsOptical.
+
+
+        :param expiry: The expiry of this DetailsOptical.  # noqa: E501
+        :type expiry: CheckResult
+        """
+        if self.local_vars_configuration.client_side_validation and expiry is None:  # noqa: E501
+            raise ValueError("Invalid value for `expiry`, must not be `None`")  # noqa: E501
+
+        self._expiry = expiry
+
+    @property
+    def image_qa(self):
+        """Gets the image_qa of this DetailsOptical.  # noqa: E501
+
+
+        :return: The image_qa of this DetailsOptical.  # noqa: E501
+        :rtype: CheckResult
+        """
+        return self._image_qa
+
+    @image_qa.setter
+    def image_qa(self, image_qa):
+        """Sets the image_qa of this DetailsOptical.
+
+
+        :param image_qa: The image_qa of this DetailsOptical.  # noqa: E501
+        :type image_qa: CheckResult
+        """
+        if self.local_vars_configuration.client_side_validation and image_qa is None:  # noqa: E501
+            raise ValueError("Invalid value for `image_qa`, must not be `None`")  # noqa: E501
+
+        self._image_qa = image_qa
+
+    @property
+    def mrz(self):
+        """Gets the mrz of this DetailsOptical.  # noqa: E501
+
+
+        :return: The mrz of this DetailsOptical.  # noqa: E501
+        :rtype: CheckResult
+        """
+        return self._mrz
+
+    @mrz.setter
+    def mrz(self, mrz):
+        """Sets the mrz of this DetailsOptical.
+
+
+        :param mrz: The mrz of this DetailsOptical.  # noqa: E501
+        :type mrz: CheckResult
+        """
+        if self.local_vars_configuration.client_side_validation and mrz is None:  # noqa: E501
+            raise ValueError("Invalid value for `mrz`, must not be `None`")  # noqa: E501
+
+        self._mrz = mrz
+
+    @property
+    def pages_count(self):
+        """Gets the pages_count of this DetailsOptical.  # noqa: E501
+
+        Number of processed pages in the document  # noqa: E501
+
+        :return: The pages_count of this DetailsOptical.  # noqa: E501
+        :rtype: int
+        """
+        return self._pages_count
+
+    @pages_count.setter
+    def pages_count(self, pages_count):
+        """Sets the pages_count of this DetailsOptical.
+
+        Number of processed pages in the document  # noqa: E501
+
+        :param pages_count: The pages_count of this DetailsOptical.  # noqa: E501
+        :type pages_count: int
+        """
+        if self.local_vars_configuration.client_side_validation and pages_count is None:  # noqa: E501
+            raise ValueError("Invalid value for `pages_count`, must not be `None`")  # noqa: E501
+
+        self._pages_count = pages_count
+
+    @property
+    def security(self):
+        """Gets the security of this DetailsOptical.  # noqa: E501
+
+
+        :return: The security of this DetailsOptical.  # noqa: E501
+        :rtype: CheckResult
+        """
+        return self._security
+
+    @security.setter
+    def security(self, security):
+        """Sets the security of this DetailsOptical.
+
+
+        :param security: The security of this DetailsOptical.  # noqa: E501
+        :type security: CheckResult
+        """
+        if self.local_vars_configuration.client_side_validation and security is None:  # noqa: E501
+            raise ValueError("Invalid value for `security`, must not be `None`")  # noqa: E501
+
+        self._security = security
+
+    @property
+    def text(self):
+        """Gets the text of this DetailsOptical.  # noqa: E501
+
+
+        :return: The text of this DetailsOptical.  # noqa: E501
+        :rtype: CheckResult
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """Sets the text of this DetailsOptical.
+
+
+        :param text: The text of this DetailsOptical.  # noqa: E501
+        :type text: CheckResult
+        """
+        if self.local_vars_configuration.client_side_validation and text is None:  # noqa: E501
+            raise ValueError("Invalid value for `text`, must not be `None`")  # noqa: E501
+
+        self._text = text
+
+    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, DetailsOptical):
+            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, DetailsOptical):
+            return True
 
+        return self.to_dict() != other.to_dict()