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

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

@@ -4,282 +4,91 @@
     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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType
+from regula.documentreader.webclient.gen.models.image_data import ImageData
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+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 GraphicField(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class GraphicField(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 = {
-        'field_type': 'GraphicFieldType',
-        'image': 'ImageData',
-        'field_rect': 'RectangleCoordinates',
-        'rfid_origin_dg': 'int',
-        'rfid_origin_dg_tag': 'int',
-        'rfid_origin_tag_entry': 'int',
-        'rfid_origin_entry_view': 'int'
-    }
-
-    attribute_map = {
-        'field_type': 'FieldType',
-        'image': 'image',
-        'field_rect': 'FieldRect',
-        'rfid_origin_dg': 'RFID_OriginDG',
-        'rfid_origin_dg_tag': 'RFID_OriginDGTag',
-        'rfid_origin_tag_entry': 'RFID_OriginTagEntry',
-        'rfid_origin_entry_view': 'RFID_OriginEntryView'
-    }
-
-    def __init__(self, field_type=None, image=None, field_rect=None, rfid_origin_dg=None, rfid_origin_dg_tag=None, rfid_origin_tag_entry=None, rfid_origin_entry_view=None, local_vars_configuration=None):  # noqa: E501
-        """GraphicField - 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._field_type = None
-        self._image = None
-        self._field_rect = None
-        self._rfid_origin_dg = None
-        self._rfid_origin_dg_tag = None
-        self._rfid_origin_tag_entry = None
-        self._rfid_origin_entry_view = None
-        self.discriminator = None
-
-        self.field_type = field_type
-        self.image = image
-        if field_rect is not None:
-            self.field_rect = field_rect
-        if rfid_origin_dg is not None:
-            self.rfid_origin_dg = rfid_origin_dg
-        if rfid_origin_dg_tag is not None:
-            self.rfid_origin_dg_tag = rfid_origin_dg_tag
-        if rfid_origin_tag_entry is not None:
-            self.rfid_origin_tag_entry = rfid_origin_tag_entry
-        if rfid_origin_entry_view is not None:
-            self.rfid_origin_entry_view = rfid_origin_entry_view
-
-    @property
-    def field_type(self):
-        """Gets the field_type of this GraphicField.  # noqa: E501
-
-
-        :return: The field_type of this GraphicField.  # noqa: E501
-        :rtype: GraphicFieldType
-        """
-        return self._field_type
-
-    @field_type.setter
-    def field_type(self, field_type):
-        """Sets the field_type of this GraphicField.
-
-
-        :param field_type: The field_type of this GraphicField.  # noqa: E501
-        :type field_type: GraphicFieldType
-        """
-        if self.local_vars_configuration.client_side_validation and field_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `field_type`, must not be `None`")  # noqa: E501
-
-        self._field_type = field_type
-
-    @property
-    def image(self):
-        """Gets the image of this GraphicField.  # noqa: E501
-
-
-        :return: The image of this GraphicField.  # noqa: E501
-        :rtype: ImageData
-        """
-        return self._image
-
-    @image.setter
-    def image(self, image):
-        """Sets the image of this GraphicField.
-
-
-        :param image: The image of this GraphicField.  # noqa: E501
-        :type image: ImageData
-        """
-        if self.local_vars_configuration.client_side_validation and image is None:  # noqa: E501
-            raise ValueError("Invalid value for `image`, must not be `None`")  # noqa: E501
-
-        self._image = image
-
-    @property
-    def field_rect(self):
-        """Gets the field_rect of this GraphicField.  # noqa: E501
-
-
-        :return: The field_rect of this GraphicField.  # noqa: E501
-        :rtype: RectangleCoordinates
-        """
-        return self._field_rect
-
-    @field_rect.setter
-    def field_rect(self, field_rect):
-        """Sets the field_rect of this GraphicField.
-
-
-        :param field_rect: The field_rect of this GraphicField.  # noqa: E501
-        :type field_rect: RectangleCoordinates
-        """
-
-        self._field_rect = field_rect
-
-    @property
-    def rfid_origin_dg(self):
-        """Gets the rfid_origin_dg of this GraphicField.  # noqa: E501
-
-        Source data group file. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :return: The rfid_origin_dg of this GraphicField.  # noqa: E501
-        :rtype: int
-        """
-        return self._rfid_origin_dg
-
-    @rfid_origin_dg.setter
-    def rfid_origin_dg(self, rfid_origin_dg):
-        """Sets the rfid_origin_dg of this GraphicField.
-
-        Source data group file. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :param rfid_origin_dg: The rfid_origin_dg of this GraphicField.  # noqa: E501
-        :type rfid_origin_dg: int
-        """
-
-        self._rfid_origin_dg = rfid_origin_dg
-
-    @property
-    def rfid_origin_dg_tag(self):
-        """Gets the rfid_origin_dg_tag of this GraphicField.  # noqa: E501
-
-        Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :return: The rfid_origin_dg_tag of this GraphicField.  # noqa: E501
-        :rtype: int
+    Information about one graphic field - abstract class
+    """ # noqa: E501
+    field_rect: RectangleCoordinates = Field(alias="FieldRect")
+    field_type: GraphicFieldType = Field(alias="FieldType")
+    field_name: StrictStr = Field(description="Graphic field symbolic name", alias="FieldName")
+    image: ImageData
+    __properties: ClassVar[List[str]] = ["FieldRect", "FieldType", "FieldName", "image"]
+
+    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 GraphicField 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._rfid_origin_dg_tag
-
-    @rfid_origin_dg_tag.setter
-    def rfid_origin_dg_tag(self, rfid_origin_dg_tag):
-        """Sets the rfid_origin_dg_tag of this GraphicField.
-
-        Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :param rfid_origin_dg_tag: The rfid_origin_dg_tag of this GraphicField.  # noqa: E501
-        :type rfid_origin_dg_tag: int
-        """
-
-        self._rfid_origin_dg_tag = rfid_origin_dg_tag
-
-    @property
-    def rfid_origin_tag_entry(self):
-        """Gets the rfid_origin_tag_entry of this GraphicField.  # noqa: E501
-
-        Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :return: The rfid_origin_tag_entry of this GraphicField.  # noqa: E501
-        :rtype: int
-        """
-        return self._rfid_origin_tag_entry
-
-    @rfid_origin_tag_entry.setter
-    def rfid_origin_tag_entry(self, rfid_origin_tag_entry):
-        """Sets the rfid_origin_tag_entry of this GraphicField.
-
-        Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :param rfid_origin_tag_entry: The rfid_origin_tag_entry of this GraphicField.  # noqa: E501
-        :type rfid_origin_tag_entry: int
-        """
-
-        self._rfid_origin_tag_entry = rfid_origin_tag_entry
-
-    @property
-    def rfid_origin_entry_view(self):
-        """Gets the rfid_origin_entry_view of this GraphicField.  # noqa: E501
-
-        Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :return: The rfid_origin_entry_view of this GraphicField.  # noqa: E501
-        :rtype: int
-        """
-        return self._rfid_origin_entry_view
-
-    @rfid_origin_entry_view.setter
-    def rfid_origin_entry_view(self, rfid_origin_entry_view):
-        """Sets the rfid_origin_entry_view of this GraphicField.
-
-        Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result.  # noqa: E501
-
-        :param rfid_origin_entry_view: The rfid_origin_entry_view of this GraphicField.  # noqa: E501
-        :type rfid_origin_entry_view: int
-        """
-
-        self._rfid_origin_entry_view = rfid_origin_entry_view
-
-    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, GraphicField):
-            return False
-
-        return self.to_dict() == other.to_dict()
+        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 field_rect
+        if self.field_rect:
+            _dict['FieldRect'] = self.field_rect.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of image
+        if self.image:
+            _dict['image'] = self.image.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GraphicField from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "FieldRect": RectangleCoordinates.from_dict(obj["FieldRect"]) if obj.get("FieldRect") is not None else None,
+            "FieldType": obj.get("FieldType"),
+            "FieldName": obj.get("FieldName"),
+            "image": ImageData.from_dict(obj["image"]) if obj.get("image") is not None else None
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, GraphicField):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,142 +4,51 @@
     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 *
-
-
-"""
-
-"""
-class GraphicFieldType(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class GraphicFieldType(int, Enum):
+    """
+    GraphicFieldType
     """
-
-    PORTRAIT = int("201")
-
-    FINGERPRINT = int("202")
-
-    EYE = int("203")
-
-    SIGNATURE = int("204")
-
-    BAR_CODE = int("205")
-
-    PROOF_OF_CITIZENSHIP = int("206")
-
-    DOCUMENT_FRONT = int("207")
-
-    DOCUMENT_REAR = int("208")
-
-    COLOR_DYNAMIC = int("209")
-
-    GHOST_PORTRAIT = int("210")
-
-    STAMP = int("211")
-
-    CONTACT_CHIP = int("213")
-
-    OTHER = int("250")
-
-    FINGER_LEFT_THUMB = int("300")
-
-    FINGER_LEFT_INDEX = int("301")
-
-    FINGER_LEFT_MIDDLE = int("302")
-
-    FINGER_LEFT_RING = int("303")
-
-    FINGER_LEFT_LITTLE = int("304")
-
-    FINGER_RIGHT_THUMB = int("305")
-
-    FINGER_RIGHT_INDEX = int("306")
-
-    FINGER_RIGHT_MIDDLE = int("307")
-
-    FINGER_RIGHT_RING = int("308")
-
-    FINGER_RIGHT_LITTLE = int("309")
-
-    FINGER_RIGHT_FOUR_FINGERS = int("313")
-
-    FINGER_LEFT_FOUR_FINGERS = int("314")
-
-    FINGER_TWO_THUMBS = int("315")
-
-    allowable_values = [PORTRAIT, FINGERPRINT, EYE, SIGNATURE, BAR_CODE, PROOF_OF_CITIZENSHIP, DOCUMENT_FRONT, DOCUMENT_REAR, COLOR_DYNAMIC, GHOST_PORTRAIT, STAMP, CONTACT_CHIP, OTHER, FINGER_LEFT_THUMB, FINGER_LEFT_INDEX, FINGER_LEFT_MIDDLE, FINGER_LEFT_RING, FINGER_LEFT_LITTLE, FINGER_RIGHT_THUMB, FINGER_RIGHT_INDEX, FINGER_RIGHT_MIDDLE, FINGER_RIGHT_RING, FINGER_RIGHT_LITTLE, FINGER_RIGHT_FOUR_FINGERS, FINGER_LEFT_FOUR_FINGERS, FINGER_TWO_THUMBS]  # 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
-        """GraphicFieldType - 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, GraphicFieldType):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    PORTRAIT = 201
+    FINGERPRINT = 202
+    EYE = 203
+    SIGNATURE = 204
+    BAR_CODE = 205
+    PROOF_OF_CITIZENSHIP = 206
+    DOCUMENT_FRONT = 207
+    DOCUMENT_REAR = 208
+    COLOR_DYNAMIC = 209
+    GHOST_PORTRAIT = 210
+    STAMP = 211
+    PORTRAIT_OF_CHILD = 212
+    CONTACT_CHIP = 213
+    OTHER = 250
+    FINGER_LEFT_THUMB = 300
+    FINGER_LEFT_INDEX = 301
+    FINGER_LEFT_MIDDLE = 302
+    FINGER_LEFT_RING = 303
+    FINGER_LEFT_LITTLE = 304
+    FINGER_RIGHT_THUMB = 305
+    FINGER_RIGHT_INDEX = 306
+    FINGER_RIGHT_MIDDLE = 307
+    FINGER_RIGHT_RING = 308
+    FINGER_RIGHT_LITTLE = 309
+    FINGER_RIGHT_FOUR_FINGERS = 313
+    FINGER_LEFT_FOUR_FINGERS = 314
+    FINGER_TWO_THUMBS = 315
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of GraphicFieldType 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, GraphicFieldType):
-            return True
 
-        return self.to_dict() != other.to_dict()