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

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

@@ -4,350 +4,121 @@
     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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
+from regula.documentreader.webclient.gen.models.point import Point
+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 DocumentPosition(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.
+class DocumentPosition(BaseModel):
     """
-    openapi_types = {
-        'doc_format': 'DocumentFormat',
-        'angle': 'float',
-        'width': 'int',
-        'height': 'int',
-        'center': 'Point',
-        'left_bottom': 'Point',
-        'left_top': 'Point',
-        'right_bottom': 'Point',
-        'right_top': 'Point',
-        'dpi': 'int'
-    }
-
-    attribute_map = {
-        'doc_format': 'docFormat',
-        'angle': 'Angle',
-        'width': 'Width',
-        'height': 'Height',
-        'center': 'Center',
-        'left_bottom': 'LeftBottom',
-        'left_top': 'LeftTop',
-        'right_bottom': 'RightBottom',
-        'right_top': 'RightTop',
-        'dpi': 'Dpi'
-    }
-
-    def __init__(self, doc_format=None, angle=None, width=None, height=None, center=None, left_bottom=None, left_top=None, right_bottom=None, right_top=None, dpi=None, local_vars_configuration=None):  # noqa: E501
-        """DocumentPosition - 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._doc_format = None
-        self._angle = None
-        self._width = None
-        self._height = None
-        self._center = None
-        self._left_bottom = None
-        self._left_top = None
-        self._right_bottom = None
-        self._right_top = None
-        self._dpi = None
-        self.discriminator = None
-
-        if doc_format is not None:
-            self.doc_format = doc_format
-        if angle is not None:
-            self.angle = angle
-        if width is not None:
-            self.width = width
-        if height is not None:
-            self.height = height
-        if center is not None:
-            self.center = center
-        if left_bottom is not None:
-            self.left_bottom = left_bottom
-        if left_top is not None:
-            self.left_top = left_top
-        if right_bottom is not None:
-            self.right_bottom = right_bottom
-        if right_top is not None:
-            self.right_top = right_top
-        if dpi is not None:
-            self.dpi = dpi
-
-    @property
-    def doc_format(self):
-        """Gets the doc_format of this DocumentPosition.  # noqa: E501
-
-
-        :return: The doc_format of this DocumentPosition.  # noqa: E501
-        :rtype: DocumentFormat
-        """
-        return self._doc_format
-
-    @doc_format.setter
-    def doc_format(self, doc_format):
-        """Sets the doc_format of this DocumentPosition.
-
-
-        :param doc_format: The doc_format of this DocumentPosition.  # noqa: E501
-        :type doc_format: DocumentFormat
-        """
-
-        self._doc_format = doc_format
-
-    @property
-    def angle(self):
-        """Gets the angle of this DocumentPosition.  # noqa: E501
-
-
-        :return: The angle of this DocumentPosition.  # noqa: E501
-        :rtype: float
-        """
-        return self._angle
-
-    @angle.setter
-    def angle(self, angle):
-        """Sets the angle of this DocumentPosition.
-
-
-        :param angle: The angle of this DocumentPosition.  # noqa: E501
-        :type angle: float
-        """
-
-        self._angle = angle
-
-    @property
-    def width(self):
-        """Gets the width of this DocumentPosition.  # noqa: E501
-
-
-        :return: The width of this DocumentPosition.  # noqa: E501
-        :rtype: int
-        """
-        return self._width
-
-    @width.setter
-    def width(self, width):
-        """Sets the width of this DocumentPosition.
-
-
-        :param width: The width of this DocumentPosition.  # noqa: E501
-        :type width: int
-        """
-
-        self._width = width
-
-    @property
-    def height(self):
-        """Gets the height of this DocumentPosition.  # noqa: E501
-
-
-        :return: The height of this DocumentPosition.  # noqa: E501
-        :rtype: int
-        """
-        return self._height
-
-    @height.setter
-    def height(self, height):
-        """Sets the height of this DocumentPosition.
-
-
-        :param height: The height of this DocumentPosition.  # noqa: E501
-        :type height: int
-        """
-
-        self._height = height
-
-    @property
-    def center(self):
-        """Gets the center of this DocumentPosition.  # noqa: E501
-
-
-        :return: The center of this DocumentPosition.  # noqa: E501
-        :rtype: Point
-        """
-        return self._center
-
-    @center.setter
-    def center(self, center):
-        """Sets the center of this DocumentPosition.
-
-
-        :param center: The center of this DocumentPosition.  # noqa: E501
-        :type center: Point
-        """
-
-        self._center = center
-
-    @property
-    def left_bottom(self):
-        """Gets the left_bottom of this DocumentPosition.  # noqa: E501
-
-
-        :return: The left_bottom of this DocumentPosition.  # noqa: E501
-        :rtype: Point
-        """
-        return self._left_bottom
-
-    @left_bottom.setter
-    def left_bottom(self, left_bottom):
-        """Sets the left_bottom of this DocumentPosition.
-
-
-        :param left_bottom: The left_bottom of this DocumentPosition.  # noqa: E501
-        :type left_bottom: Point
-        """
-
-        self._left_bottom = left_bottom
-
-    @property
-    def left_top(self):
-        """Gets the left_top of this DocumentPosition.  # noqa: E501
-
-
-        :return: The left_top of this DocumentPosition.  # noqa: E501
-        :rtype: Point
-        """
-        return self._left_top
-
-    @left_top.setter
-    def left_top(self, left_top):
-        """Sets the left_top of this DocumentPosition.
-
-
-        :param left_top: The left_top of this DocumentPosition.  # noqa: E501
-        :type left_top: Point
-        """
-
-        self._left_top = left_top
-
-    @property
-    def right_bottom(self):
-        """Gets the right_bottom of this DocumentPosition.  # noqa: E501
-
-
-        :return: The right_bottom of this DocumentPosition.  # noqa: E501
-        :rtype: Point
-        """
-        return self._right_bottom
-
-    @right_bottom.setter
-    def right_bottom(self, right_bottom):
-        """Sets the right_bottom of this DocumentPosition.
-
-
-        :param right_bottom: The right_bottom of this DocumentPosition.  # noqa: E501
-        :type right_bottom: Point
-        """
-
-        self._right_bottom = right_bottom
-
-    @property
-    def right_top(self):
-        """Gets the right_top of this DocumentPosition.  # noqa: E501
-
-
-        :return: The right_top of this DocumentPosition.  # noqa: E501
-        :rtype: Point
-        """
-        return self._right_top
-
-    @right_top.setter
-    def right_top(self, right_top):
-        """Sets the right_top of this DocumentPosition.
-
-
-        :param right_top: The right_top of this DocumentPosition.  # noqa: E501
-        :type right_top: Point
-        """
-
-        self._right_top = right_top
-
-    @property
-    def dpi(self):
-        """Gets the dpi of this DocumentPosition.  # noqa: E501
-
-
-        :return: The dpi of this DocumentPosition.  # noqa: E501
-        :rtype: int
-        """
-        return self._dpi
-
-    @dpi.setter
-    def dpi(self, dpi):
-        """Sets the dpi of this DocumentPosition.
-
-
-        :param dpi: The dpi of this DocumentPosition.  # noqa: E501
-        :type dpi: int
-        """
-
-        self._dpi = dpi
-
-    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, DocumentPosition):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    DocumentPosition
+    """ # noqa: E501
+    doc_format: DocumentFormat = Field(alias="docFormat")
+    angle: Union[StrictFloat, StrictInt] = Field(description="Document rotation angle", alias="Angle")
+    width: StrictInt = Field(description="Document width", alias="Width")
+    height: StrictInt = Field(description="Document height", alias="Height")
+    center: Point = Field(alias="Center")
+    left_bottom: Point = Field(alias="LeftBottom")
+    left_top: Point = Field(alias="LeftTop")
+    right_bottom: Point = Field(alias="RightBottom")
+    right_top: Point = Field(alias="RightTop")
+    dpi: StrictInt = Field(alias="Dpi")
+    inverse: Optional[StrictInt] = Field(default=None, alias="Inverse")
+    obj_area: Optional[StrictInt] = Field(default=None, alias="ObjArea")
+    obj_int_angle_dev: Optional[StrictInt] = Field(default=None, alias="ObjIntAngleDev")
+    perspective_tr: Optional[StrictInt] = Field(default=None, alias="PerspectiveTr")
+    result_status: Optional[StrictInt] = Field(default=None, alias="ResultStatus")
+    __properties: ClassVar[List[str]] = ["docFormat", "Angle", "Width", "Height", "Center", "LeftBottom", "LeftTop", "RightBottom", "RightTop", "Dpi", "Inverse", "ObjArea", "ObjIntAngleDev", "PerspectiveTr", "ResultStatus"]
+
+    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 DocumentPosition 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 center
+        if self.center:
+            _dict['Center'] = self.center.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of left_bottom
+        if self.left_bottom:
+            _dict['LeftBottom'] = self.left_bottom.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of left_top
+        if self.left_top:
+            _dict['LeftTop'] = self.left_top.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of right_bottom
+        if self.right_bottom:
+            _dict['RightBottom'] = self.right_bottom.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of right_top
+        if self.right_top:
+            _dict['RightTop'] = self.right_top.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DocumentPosition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "docFormat": obj.get("docFormat"),
+            "Angle": obj.get("Angle"),
+            "Width": obj.get("Width"),
+            "Height": obj.get("Height"),
+            "Center": Point.from_dict(obj["Center"]) if obj.get("Center") is not None else None,
+            "LeftBottom": Point.from_dict(obj["LeftBottom"]) if obj.get("LeftBottom") is not None else None,
+            "LeftTop": Point.from_dict(obj["LeftTop"]) if obj.get("LeftTop") is not None else None,
+            "RightBottom": Point.from_dict(obj["RightBottom"]) if obj.get("RightBottom") is not None else None,
+            "RightTop": Point.from_dict(obj["RightTop"]) if obj.get("RightTop") is not None else None,
+            "Dpi": obj.get("Dpi"),
+            "Inverse": obj.get("Inverse"),
+            "ObjArea": obj.get("ObjArea"),
+            "ObjIntAngleDev": obj.get("ObjIntAngleDev"),
+            "PerspectiveTr": obj.get("PerspectiveTr"),
+            "ResultStatus": obj.get("ResultStatus")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, DocumentPosition):
-            return True
 
-        return self.to_dict() != other.to_dict()

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