regula-documentreader-webclient 8.1.349rc0__py3-none-any.whl → 8.1.351.dev0__py3-none-any.whl

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

@@ -4,339 +4,102 @@
     Generated by: https://openapi-generator.tech
 """
 
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
-
-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 ImagesFieldValue(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.light import Light
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+from regula.documentreader.webclient.gen.models.rfid_origin import RfidOrigin
+from regula.documentreader.webclient.gen.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ImagesFieldValue(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',
-        'value': 'str',
-        'original_value': 'str',
-        'original_page_index': 'int',
-        'page_index': 'int',
-        'light_index': 'Light',
-        'container_type': 'int',
-        'field_rect': 'RectangleCoordinates',
-        'rfid_origin': 'RfidOrigin'
-    }
-
-    attribute_map = {
-        'source': 'source',
-        'value': 'value',
-        'original_value': 'originalValue',
-        'original_page_index': 'originalPageIndex',
-        'page_index': 'pageIndex',
-        'light_index': 'lightIndex',
-        'container_type': 'containerType',
-        'field_rect': 'fieldRect',
-        'rfid_origin': 'rfidOrigin'
-    }
-
-    def __init__(self, source=None, value=None, original_value=None, original_page_index=None, page_index=None, light_index=None, container_type=0, field_rect=None, rfid_origin=None, local_vars_configuration=None):  # noqa: E501
-        """ImagesFieldValue - 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._value = None
-        self._original_value = None
-        self._original_page_index = None
-        self._page_index = None
-        self._light_index = None
-        self._container_type = None
-        self._field_rect = None
-        self._rfid_origin = None
-        self.discriminator = None
-
-        self.source = source
-        self.value = value
-        if original_value is not None:
-            self.original_value = original_value
-        if original_page_index is not None:
-            self.original_page_index = original_page_index
-        self.page_index = page_index
-        self.light_index = light_index
-        self.container_type = container_type
-        if field_rect is not None:
-            self.field_rect = field_rect
-        if rfid_origin is not None:
-            self.rfid_origin = rfid_origin
-
-    @property
-    def source(self):
-        """Gets the source of this ImagesFieldValue.  # noqa: E501
-
-
-        :return: The source of this ImagesFieldValue.  # noqa: E501
-        :rtype: Source
-        """
-        return self._source
-
-    @source.setter
-    def source(self, source):
-        """Sets the source of this ImagesFieldValue.
-
-
-        :param source: The source of this ImagesFieldValue.  # 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
-
-        self._source = source
-
-    @property
-    def value(self):
-        """Gets the value of this ImagesFieldValue.  # noqa: E501
-
-        Base64 encoded image  # noqa: E501
-
-        :return: The value of this ImagesFieldValue.  # noqa: E501
-        :rtype: str
-        """
-        return self._value
-
-    @value.setter
-    def value(self, value):
-        """Sets the value of this ImagesFieldValue.
-
-        Base64 encoded image  # noqa: E501
-
-        :param value: The value of this ImagesFieldValue.  # noqa: E501
-        :type value: str
-        """
-        if self.local_vars_configuration.client_side_validation and value is None:  # noqa: E501
-            raise ValueError("Invalid value for `value`, must not be `None`")  # noqa: E501
-
-        self._value = value
-
-    @property
-    def original_value(self):
-        """Gets the original_value of this ImagesFieldValue.  # noqa: E501
-
-        Base64 encoded image  # noqa: E501
-
-        :return: The original_value of this ImagesFieldValue.  # noqa: E501
-        :rtype: str
-        """
-        return self._original_value
-
-    @original_value.setter
-    def original_value(self, original_value):
-        """Sets the original_value of this ImagesFieldValue.
-
-        Base64 encoded image  # noqa: E501
-
-        :param original_value: The original_value of this ImagesFieldValue.  # noqa: E501
-        :type original_value: str
-        """
-
-        self._original_value = original_value
-
-    @property
-    def original_page_index(self):
-        """Gets the original_page_index of this ImagesFieldValue.  # noqa: E501
-
-        Original page index  # noqa: E501
-
-        :return: The original_page_index of this ImagesFieldValue.  # noqa: E501
-        :rtype: int
-        """
-        return self._original_page_index
-
-    @original_page_index.setter
-    def original_page_index(self, original_page_index):
-        """Sets the original_page_index of this ImagesFieldValue.
-
-        Original page index  # noqa: E501
-
-        :param original_page_index: The original_page_index of this ImagesFieldValue.  # noqa: E501
-        :type original_page_index: int
-        """
-
-        self._original_page_index = original_page_index
-
-    @property
-    def page_index(self):
-        """Gets the page_index of this ImagesFieldValue.  # noqa: E501
-
-        Page index of the image from input list  # noqa: E501
-
-        :return: The page_index of this ImagesFieldValue.  # noqa: E501
-        :rtype: int
-        """
-        return self._page_index
-
-    @page_index.setter
-    def page_index(self, page_index):
-        """Sets the page_index of this ImagesFieldValue.
-
-        Page index of the image from input list  # noqa: E501
-
-        :param page_index: The page_index of this ImagesFieldValue.  # noqa: E501
-        :type page_index: int
-        """
-        if self.local_vars_configuration.client_side_validation and page_index is None:  # noqa: E501
-            raise ValueError("Invalid value for `page_index`, must not be `None`")  # noqa: E501
-
-        self._page_index = page_index
-
-    @property
-    def light_index(self):
-        """Gets the light_index of this ImagesFieldValue.  # noqa: E501
-
-
-        :return: The light_index of this ImagesFieldValue.  # noqa: E501
-        :rtype: Light
-        """
-        return self._light_index
-
-    @light_index.setter
-    def light_index(self, light_index):
-        """Sets the light_index of this ImagesFieldValue.
-
-
-        :param light_index: The light_index of this ImagesFieldValue.  # noqa: E501
-        :type light_index: Light
-        """
-        if self.local_vars_configuration.client_side_validation and light_index is None:  # noqa: E501
-            raise ValueError("Invalid value for `light_index`, must not be `None`")  # noqa: E501
-
-        self._light_index = light_index
-
-    @property
-    def container_type(self):
-        """Gets the container_type of this ImagesFieldValue.  # noqa: E501
-
-        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
-
-        :return: The container_type of this ImagesFieldValue.  # noqa: E501
-        :rtype: int
-        """
-        return self._container_type
-
-    @container_type.setter
-    def container_type(self, container_type):
-        """Sets the container_type of this ImagesFieldValue.
-
-        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
-
-        :param container_type: The container_type of this ImagesFieldValue.  # noqa: E501
-        :type container_type: int
-        """
-        if self.local_vars_configuration.client_side_validation and container_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `container_type`, must not be `None`")  # noqa: E501
-
-        self._container_type = container_type
-
-    @property
-    def field_rect(self):
-        """Gets the field_rect of this ImagesFieldValue.  # noqa: E501
-
-
-        :return: The field_rect of this ImagesFieldValue.  # noqa: E501
-        :rtype: RectangleCoordinates
-        """
-        return self._field_rect
-
-    @field_rect.setter
-    def field_rect(self, field_rect):
-        """Sets the field_rect of this ImagesFieldValue.
-
-
-        :param field_rect: The field_rect of this ImagesFieldValue.  # noqa: E501
-        :type field_rect: RectangleCoordinates
-        """
-
-        self._field_rect = field_rect
-
-    @property
-    def rfid_origin(self):
-        """Gets the rfid_origin of this ImagesFieldValue.  # noqa: E501
-
-
-        :return: The rfid_origin of this ImagesFieldValue.  # noqa: E501
-        :rtype: RfidOrigin
-        """
-        return self._rfid_origin
-
-    @rfid_origin.setter
-    def rfid_origin(self, rfid_origin):
-        """Sets the rfid_origin of this ImagesFieldValue.
-
-
-        :param rfid_origin: The rfid_origin of this ImagesFieldValue.  # noqa: E501
-        :type rfid_origin: RfidOrigin
-        """
-
-        self._rfid_origin = rfid_origin
-
-    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, ImagesFieldValue):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    ImagesFieldValue
+    """ # noqa: E501
+    source: Source
+    value: Optional[StrictStr] = Field(default=None, description="Base64 encoded image")
+    original_value: Optional[StrictStr] = Field(default=None, description="Base64 encoded image", alias="originalValue")
+    original_page_index: Optional[StrictInt] = Field(default=None, description="Original page index", alias="originalPageIndex")
+    page_index: StrictInt = Field(description="Page index of the image from input list", alias="pageIndex")
+    light_index: Light = Field(alias="lightIndex")
+    container_type: StrictInt = Field(description="Same as Result type, but used for safe parsing of not-described values. See Result type.", alias="containerType")
+    field_rect: Optional[RectangleCoordinates] = Field(default=None, alias="fieldRect")
+    rfid_origin: Optional[RfidOrigin] = Field(default=None, alias="rfidOrigin")
+    __properties: ClassVar[List[str]] = ["source", "value", "originalValue", "originalPageIndex", "pageIndex", "lightIndex", "containerType", "fieldRect", "rfidOrigin"]
+
+    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 ImagesFieldValue 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 field_rect
+        if self.field_rect:
+            _dict['fieldRect'] = self.field_rect.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rfid_origin
+        if self.rfid_origin:
+            _dict['rfidOrigin'] = self.rfid_origin.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ImagesFieldValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "source": obj.get("source"),
+            "value": obj.get("value"),
+            "originalValue": obj.get("originalValue"),
+            "originalPageIndex": obj.get("originalPageIndex"),
+            "pageIndex": obj.get("pageIndex"),
+            "lightIndex": obj.get("lightIndex"),
+            "containerType": obj.get("containerType") if obj.get("containerType") is not None else 0,
+            "fieldRect": RectangleCoordinates.from_dict(obj["fieldRect"]) if obj.get("fieldRect") is not None else None,
+            "rfidOrigin": RfidOrigin.from_dict(obj["rfidOrigin"]) if obj.get("rfidOrigin") is not None else None
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, ImagesFieldValue):
-            return True
 
-        return self.to_dict() != other.to_dict()

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