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

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

@@ -4,94 +4,282 @@
     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 typing_extensions import Annotated
-from regula.documentreader.webclient.gen.models.lcid import LCID
-from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
-from regula.documentreader.webclient.gen.models.verification_result import VerificationResult
-from typing import Optional, Set
-from typing_extensions import Self
-
-class VerifiedFieldMap(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 *
+
+
+"""
+
+"""
+class VerifiedFieldMap(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.
     """
-    VerifiedFieldMap
-    """ # noqa: E501
-    w_field_type: TextFieldType = Field(alias="wFieldType")
-    w_lcid: LCID = Field(alias="wLCID")
-    field_mrz: Optional[StrictStr] = Field(default=None, description="Field data extracted from mrz(machine readable zone)", alias="Field_MRZ")
-    field_visual: Optional[StrictStr] = Field(default=None, description="Field data extracted from visual zone", alias="Field_Visual")
-    field_barcode: Optional[StrictStr] = Field(default=None, description="Field data extracted from barcode", alias="Field_Barcode")
-    field_rfid: Optional[StrictStr] = Field(default=None, description="Field data extracted from rfid chip", alias="Field_RFID")
-    matrix: Annotated[List[VerificationResult], Field(min_length=10, max_length=10)] = Field(description="results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.", alias="Matrix")
-    field_type: Optional[StrictInt] = Field(default=None, alias="FieldType")
-    __properties: ClassVar[List[str]] = ["wFieldType", "wLCID", "Field_MRZ", "Field_Visual", "Field_Barcode", "Field_RFID", "Matrix", "FieldType"]
-
-    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 VerifiedFieldMap 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.
+    openapi_types = {
+        'w_field_type': 'TextFieldType',
+        'w_lcid': 'LCID',
+        'field_mrz': 'str',
+        'field_visual': 'str',
+        'field_barcode': 'str',
+        'field_rfid': 'str',
+        'matrix': 'list[VerificationResult]'
+    }
+
+    attribute_map = {
+        'w_field_type': 'wFieldType',
+        'w_lcid': 'wLCID',
+        'field_mrz': 'Field_MRZ',
+        'field_visual': 'Field_Visual',
+        'field_barcode': 'Field_Barcode',
+        'field_rfid': 'Field_RFID',
+        'matrix': 'Matrix'
+    }
+
+    def __init__(self, w_field_type=None, w_lcid=None, field_mrz=None, field_visual=None, field_barcode=None, field_rfid=None, matrix=None, local_vars_configuration=None):  # noqa: E501
+        """VerifiedFieldMap - 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._w_field_type = None
+        self._w_lcid = None
+        self._field_mrz = None
+        self._field_visual = None
+        self._field_barcode = None
+        self._field_rfid = None
+        self._matrix = None
+        self.discriminator = None
+
+        if w_field_type is not None:
+            self.w_field_type = w_field_type
+        if w_lcid is not None:
+            self.w_lcid = w_lcid
+        if field_mrz is not None:
+            self.field_mrz = field_mrz
+        if field_visual is not None:
+            self.field_visual = field_visual
+        if field_barcode is not None:
+            self.field_barcode = field_barcode
+        if field_rfid is not None:
+            self.field_rfid = field_rfid
+        if matrix is not None:
+            self.matrix = matrix
+
+    @property
+    def w_field_type(self):
+        """Gets the w_field_type of this VerifiedFieldMap.  # noqa: E501
+
+
+        :return: The w_field_type of this VerifiedFieldMap.  # noqa: E501
+        :rtype: TextFieldType
+        """
+        return self._w_field_type
+
+    @w_field_type.setter
+    def w_field_type(self, w_field_type):
+        """Sets the w_field_type of this VerifiedFieldMap.
+
+
+        :param w_field_type: The w_field_type of this VerifiedFieldMap.  # noqa: E501
+        :type w_field_type: TextFieldType
+        """
+
+        self._w_field_type = w_field_type
+
+    @property
+    def w_lcid(self):
+        """Gets the w_lcid of this VerifiedFieldMap.  # noqa: E501
+
+
+        :return: The w_lcid of this VerifiedFieldMap.  # noqa: E501
+        :rtype: LCID
+        """
+        return self._w_lcid
+
+    @w_lcid.setter
+    def w_lcid(self, w_lcid):
+        """Sets the w_lcid of this VerifiedFieldMap.
+
+
+        :param w_lcid: The w_lcid of this VerifiedFieldMap.  # noqa: E501
+        :type w_lcid: LCID
+        """
+
+        self._w_lcid = w_lcid
+
+    @property
+    def field_mrz(self):
+        """Gets the field_mrz of this VerifiedFieldMap.  # noqa: E501
+
+        Field data extracted from mrz(machine readable zone)  # noqa: E501
+
+        :return: The field_mrz of this VerifiedFieldMap.  # noqa: E501
+        :rtype: str
+        """
+        return self._field_mrz
+
+    @field_mrz.setter
+    def field_mrz(self, field_mrz):
+        """Sets the field_mrz of this VerifiedFieldMap.
+
+        Field data extracted from mrz(machine readable zone)  # noqa: E501
+
+        :param field_mrz: The field_mrz of this VerifiedFieldMap.  # noqa: E501
+        :type field_mrz: str
+        """
+
+        self._field_mrz = field_mrz
+
+    @property
+    def field_visual(self):
+        """Gets the field_visual of this VerifiedFieldMap.  # noqa: E501
+
+        Field data extracted from visual zone  # noqa: E501
+
+        :return: The field_visual of this VerifiedFieldMap.  # noqa: E501
+        :rtype: str
+        """
+        return self._field_visual
+
+    @field_visual.setter
+    def field_visual(self, field_visual):
+        """Sets the field_visual of this VerifiedFieldMap.
+
+        Field data extracted from visual zone  # noqa: E501
+
+        :param field_visual: The field_visual of this VerifiedFieldMap.  # noqa: E501
+        :type field_visual: str
+        """
+
+        self._field_visual = field_visual
+
+    @property
+    def field_barcode(self):
+        """Gets the field_barcode of this VerifiedFieldMap.  # noqa: E501
+
+        Field data extracted from barcode  # noqa: E501
+
+        :return: The field_barcode of this VerifiedFieldMap.  # noqa: E501
+        :rtype: str
+        """
+        return self._field_barcode
+
+    @field_barcode.setter
+    def field_barcode(self, field_barcode):
+        """Sets the field_barcode of this VerifiedFieldMap.
+
+        Field data extracted from barcode  # noqa: E501
+
+        :param field_barcode: The field_barcode of this VerifiedFieldMap.  # noqa: E501
+        :type field_barcode: str
+        """
+
+        self._field_barcode = field_barcode
+
+    @property
+    def field_rfid(self):
+        """Gets the field_rfid of this VerifiedFieldMap.  # noqa: E501
+
+        Field data extracted from rfid chip  # noqa: E501
+
+        :return: The field_rfid of this VerifiedFieldMap.  # noqa: E501
+        :rtype: str
         """
-        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 VerifiedFieldMap from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "wFieldType": obj.get("wFieldType"),
-            "wLCID": obj.get("wLCID"),
-            "Field_MRZ": obj.get("Field_MRZ"),
-            "Field_Visual": obj.get("Field_Visual"),
-            "Field_Barcode": obj.get("Field_Barcode"),
-            "Field_RFID": obj.get("Field_RFID"),
-            "Matrix": obj.get("Matrix"),
-            "FieldType": obj.get("FieldType")
-        })
-        return _obj
+        return self._field_rfid
+
+    @field_rfid.setter
+    def field_rfid(self, field_rfid):
+        """Sets the field_rfid of this VerifiedFieldMap.
+
+        Field data extracted from rfid chip  # noqa: E501
+
+        :param field_rfid: The field_rfid of this VerifiedFieldMap.  # noqa: E501
+        :type field_rfid: str
+        """
+
+        self._field_rfid = field_rfid
+
+    @property
+    def matrix(self):
+        """Gets the matrix of this VerifiedFieldMap.  # noqa: E501
+
+        results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.  # noqa: E501
+
+        :return: The matrix of this VerifiedFieldMap.  # noqa: E501
+        :rtype: list[VerificationResult]
+        """
+        return self._matrix
+
+    @matrix.setter
+    def matrix(self, matrix):
+        """Sets the matrix of this VerifiedFieldMap.
+
+        results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.  # noqa: E501
+
+        :param matrix: The matrix of this VerifiedFieldMap.  # noqa: E501
+        :type matrix: list[VerificationResult]
+        """
+
+        self._matrix = matrix
+
+    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, VerifiedFieldMap):
+            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, VerifiedFieldMap):
+            return True
 
+        return self.to_dict() != other.to_dict()

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

@@ -4,29 +4,100 @@
     Generated by: https://openapi-generator.tech
 """
 
-from __future__ import annotations
-import json
-from enum import Enum
-from typing_extensions import Self
+import pprint
+import re  # noqa: F401
 
+import six
 
-class Visibility(int, Enum):
-    """
-    Enumeration contains visibility status of the security element
+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 visibility status of the security element
+"""
+class Visibility(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
     """
 
+    INVISIBLE = int("0")
+
+    VISIBLE = int("1")
+
+    COLORED = int("2")
+
+    GRAYSCALE = int("4")
+
+    WHITE_IR_MATCHING = int("8")
+
+    allowable_values = [INVISIBLE, VISIBLE, COLORED, GRAYSCALE, WHITE_IR_MATCHING]  # noqa: E501
+
     """
-    allowed enum values
+    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.
     """
-    INVISIBLE = 0
-    VISIBLE = 1
-    COLORED = 2
-    GRAYSCALE = 4
-    WHITE_IR_MATCHING = 8
+    openapi_types = {
+    }
+
+    attribute_map = {
+    }
+
+    def __init__(self, local_vars_configuration=None):  # noqa: E501
+        """Visibility - 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, Visibility):
+            return False
 
-    @classmethod
-    def from_json(cls, json_str: str) -> Self:
-        """Create an instance of Visibility from a JSON string"""
-        return cls(json.loads(json_str))
+        return self.to_dict() == other.to_dict()
 
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, Visibility):
+            return True
 
+        return self.to_dict() != other.to_dict()