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

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

@@ -4,38 +4,116 @@
     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 DocumentFormat(int, Enum):
-    """
-    Defining the geometric format of documents in accordance with ISO / IEC 7810
+from regula.documentreader.webclient.gen.configuration import Configuration
+# this line was added to enable pycharm type hinting
+from regula.documentreader.webclient.gen.models import *
+
+
+"""
+Defining the geometric format of documents in accordance with ISO / IEC 7810
+"""
+class DocumentFormat(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
     """
 
+    ID1 = int("0")
+
+    ID2 = int("1")
+
+    ID3 = int("2")
+
+    NON = int("3")
+
+    A4 = int("4")
+
+    ID3_X2 = int("5")
+
+    ID1_90 = int("10")
+
+    ID1_180 = int("11")
+
+    ID1_270 = int("12")
+
+    ID2_180 = int("13")
+
+    ID3_180 = int("14")
+
+    CUSTOM = int("1000")
+
+    FLEXIBLE = int("1002")
+
+    allowable_values = [ID1, ID2, ID3, NON, A4, ID3_X2, ID1_90, ID1_180, ID1_270, ID2_180, ID3_180, CUSTOM, FLEXIBLE]  # 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.
     """
-    UNKNOWN = -1
-    ID1 = 0
-    ID2 = 1
-    ID3 = 2
-    NON = 3
-    A4 = 4
-    ID3_X2 = 5
-    ID1_90 = 10
-    ID1_180 = 11
-    ID1_270 = 12
-    ID2_180 = 13
-    ID3_180 = 14
-    CUSTOM = 1000
-    FLEXIBLE = 1002
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Self:
-        """Create an instance of DocumentFormat from a JSON string"""
-        return cls(json.loads(json_str))
+    openapi_types = {
+    }
+
+    attribute_map = {
+    }
+
+    def __init__(self, local_vars_configuration=None):  # noqa: E501
+        """DocumentFormat - 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, DocumentFormat):
+            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, DocumentFormat):
+            return True
 
+        return self.to_dict() != other.to_dict()

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

@@ -4,78 +4,147 @@
     Generated by: https://openapi-generator.tech
 """
 
-from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
-from typing_extensions import Self
+import six
 
-class DocumentImage(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 DocumentImage(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.
     """
-    DocumentImage
-    """ # noqa: E501
-    image: Optional[StrictStr] = Field(default=None, description="Base64 encoded image")
-    format: Optional[StrictStr] = Field(default=None, description="Image format")
-    __properties: ClassVar[List[str]] = ["image", "format"]
-
-    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 DocumentImage 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 = {
+        'image': 'str',
+        'format': 'str'
+    }
+
+    attribute_map = {
+        'image': 'image',
+        'format': 'format'
+    }
+
+    def __init__(self, image=None, format=None, local_vars_configuration=None):  # noqa: E501
+        """DocumentImage - 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._image = None
+        self._format = None
+        self.discriminator = None
+
+        self.image = image
+        if format is not None:
+            self.format = format
+
+    @property
+    def image(self):
+        """Gets the image of this DocumentImage.  # noqa: E501
+
+        Base64 encoded image  # noqa: E501
+
+        :return: The image of this DocumentImage.  # noqa: E501
+        :rtype: str
         """
-        excluded_fields: Set[str] = set([
-        ])
+        return self._image
 
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        return _dict
+    @image.setter
+    def image(self, image):
+        """Sets the image of this DocumentImage.
 
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DocumentImage from a dict"""
-        if obj is None:
-            return None
+        Base64 encoded image  # noqa: E501
 
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
+        :param image: The image of this DocumentImage.  # noqa: E501
+        :type image: str
+        """
+        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 format(self):
+        """Gets the format of this DocumentImage.  # noqa: E501
+
+        Image format  # noqa: E501
 
-        _obj = cls.model_validate({
-            "image": obj.get("image"),
-            "format": obj.get("format")
-        })
-        return _obj
+        :return: The format of this DocumentImage.  # noqa: E501
+        :rtype: str
+        """
+        return self._format
+
+    @format.setter
+    def format(self, format):
+        """Sets the format of this DocumentImage.
 
+        Image format  # noqa: E501
+
+        :param format: The format of this DocumentImage.  # noqa: E501
+        :type format: str
+        """
 
+        self._format = format
+
+    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, DocumentImage):
+            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, DocumentImage):
+            return True
+
+        return self.to_dict() != other.to_dict()

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

@@ -4,87 +4,250 @@
     Generated by: https://openapi-generator.tech
 """
 
-from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import json
 
-from pydantic import ConfigDict, Field
-from typing import Any, ClassVar, Dict, List
-from regula.documentreader.webclient.gen.models.image_data import ImageData
-from regula.documentreader.webclient.gen.models.result import Result
-from regula.documentreader.webclient.gen.models.result_item import ResultItem
-from typing import Optional, Set
-from typing_extensions import Self
+import six
 
-class DocumentImageResult(ResultItem):
+from regula.documentreader.webclient.gen.configuration import Configuration
+# this line was added to enable pycharm type hinting
+from regula.documentreader.webclient.gen.models import *
+
+
+"""
+Contains document image.
+"""
+class DocumentImageResult(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.
     """
-    Contains document image.
-    """ # noqa: E501
-    raw_image_container: ImageData = Field(alias="RawImageContainer")
-    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "RawImageContainer"]
+    openapi_types = {
+        'raw_image_container': 'ImageData',
+        'buf_length': 'int',
+        'light': 'int',
+        'list_idx': 'int',
+        'page_idx': 'int',
+        'result_type': 'int'
+    }
+
+    attribute_map = {
+        'raw_image_container': 'RawImageContainer',
+        'buf_length': 'buf_length',
+        'light': 'light',
+        'list_idx': 'list_idx',
+        'page_idx': 'page_idx',
+        'result_type': 'result_type'
+    }
+
+    def __init__(self, raw_image_container=None, buf_length=None, light=None, list_idx=None, page_idx=None, result_type=0, local_vars_configuration=None):  # noqa: E501
+        """DocumentImageResult - 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._raw_image_container = None
+        self._buf_length = None
+        self._light = None
+        self._list_idx = None
+        self._page_idx = None
+        self._result_type = None
+        self.discriminator = None
+
+        self.raw_image_container = raw_image_container
+        if buf_length is not None:
+            self.buf_length = buf_length
+        if light is not None:
+            self.light = light
+        if list_idx is not None:
+            self.list_idx = list_idx
+        if page_idx is not None:
+            self.page_idx = page_idx
+        self.result_type = result_type
+
+    @property
+    def raw_image_container(self):
+        """Gets the raw_image_container of this DocumentImageResult.  # noqa: E501
+
+
+        :return: The raw_image_container of this DocumentImageResult.  # noqa: E501
+        :rtype: ImageData
+        """
+        return self._raw_image_container
+
+    @raw_image_container.setter
+    def raw_image_container(self, raw_image_container):
+        """Sets the raw_image_container of this DocumentImageResult.
+
+
+        :param raw_image_container: The raw_image_container of this DocumentImageResult.  # noqa: E501
+        :type raw_image_container: ImageData
+        """
+        if self.local_vars_configuration.client_side_validation and raw_image_container is None:  # noqa: E501
+            raise ValueError("Invalid value for `raw_image_container`, must not be `None`")  # noqa: E501
+
+        self._raw_image_container = raw_image_container
+
+    @property
+    def buf_length(self):
+        """Gets the buf_length of this DocumentImageResult.  # noqa: E501
+
+
+        :return: The buf_length of this DocumentImageResult.  # noqa: E501
+        :rtype: int
+        """
+        return self._buf_length
 
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
+    @buf_length.setter
+    def buf_length(self, buf_length):
+        """Sets the buf_length of this DocumentImageResult.
 
 
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
+        :param buf_length: The buf_length of this DocumentImageResult.  # noqa: E501
+        :type buf_length: int
+        """
+
+        self._buf_length = buf_length
+
+    @property
+    def light(self):
+        """Gets the light of this DocumentImageResult.  # noqa: E501
 
-    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 DocumentImageResult from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
+        :return: The light of this DocumentImageResult.  # noqa: E501
+        :rtype: int
+        """
+        return self._light
 
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
+    @light.setter
+    def light(self, light):
+        """Sets the light of this DocumentImageResult.
 
-        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.
+        :param light: The light of this DocumentImageResult.  # noqa: E501
+        :type light: int
         """
-        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 raw_image_container
-        if self.raw_image_container:
-            _dict['RawImageContainer'] = self.raw_image_container.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DocumentImageResult from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "buf_length": obj.get("buf_length"),
-            "light": obj.get("light"),
-            "list_idx": obj.get("list_idx"),
-            "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type"),
-            "RawImageContainer": ImageData.from_dict(obj["RawImageContainer"]) if obj.get("RawImageContainer") is not None else None
-        })
-        return _obj
+
+        self._light = light
+
+    @property
+    def list_idx(self):
+        """Gets the list_idx of this DocumentImageResult.  # noqa: E501
 
 
+        :return: The list_idx of this DocumentImageResult.  # noqa: E501
+        :rtype: int
+        """
+        return self._list_idx
+
+    @list_idx.setter
+    def list_idx(self, list_idx):
+        """Sets the list_idx of this DocumentImageResult.
+
+
+        :param list_idx: The list_idx of this DocumentImageResult.  # noqa: E501
+        :type list_idx: int
+        """
+
+        self._list_idx = list_idx
+
+    @property
+    def page_idx(self):
+        """Gets the page_idx of this DocumentImageResult.  # noqa: E501
+
+
+        :return: The page_idx of this DocumentImageResult.  # noqa: E501
+        :rtype: int
+        """
+        return self._page_idx
+
+    @page_idx.setter
+    def page_idx(self, page_idx):
+        """Sets the page_idx of this DocumentImageResult.
+
+
+        :param page_idx: The page_idx of this DocumentImageResult.  # noqa: E501
+        :type page_idx: int
+        """
+
+        self._page_idx = page_idx
+
+    @property
+    def result_type(self):
+        """Gets the result_type of this DocumentImageResult.  # noqa: E501
+
+        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
+
+        :return: The result_type of this DocumentImageResult.  # noqa: E501
+        :rtype: int
+        """
+        return self._result_type
+
+    @result_type.setter
+    def result_type(self, result_type):
+        """Sets the result_type of this DocumentImageResult.
+
+        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
+
+        :param result_type: The result_type of this DocumentImageResult.  # noqa: E501
+        :type result_type: int
+        """
+        if self.local_vars_configuration.client_side_validation and result_type is None:  # noqa: E501
+            raise ValueError("Invalid value for `result_type`, must not be `None`")  # noqa: E501
+
+        self._result_type = result_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, DocumentImageResult):
+            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, DocumentImageResult):
+            return True
+
+        return self.to_dict() != other.to_dict()