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

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

@@ -4,275 +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 ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
+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
 
-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 information about the type of document that was determined based on the analysis of the provided image
-"""
-class ChosenDocumentTypeResult(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class ChosenDocumentTypeResult(ResultItem):
     """
-
-    """
-    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 = {
-        'one_candidate': 'OneCandidate',
-        'xml_buffer': 'str',
-        'buf_length': 'int',
-        'light': 'int',
-        'list_idx': 'int',
-        'page_idx': 'int',
-        'result_type': 'int'
-    }
-
-    attribute_map = {
-        'one_candidate': 'OneCandidate',
-        'xml_buffer': 'XML_buffer',
-        'buf_length': 'buf_length',
-        'light': 'light',
-        'list_idx': 'list_idx',
-        'page_idx': 'page_idx',
-        'result_type': 'result_type'
-    }
-
-    def __init__(self, one_candidate=None, xml_buffer=None, buf_length=None, light=None, list_idx=None, page_idx=None, result_type=0, local_vars_configuration=None):  # noqa: E501
-        """ChosenDocumentTypeResult - 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._one_candidate = None
-        self._xml_buffer = None
-        self._buf_length = None
-        self._light = None
-        self._list_idx = None
-        self._page_idx = None
-        self._result_type = None
-        self.discriminator = None
-
-        if one_candidate is not None:
-            self.one_candidate = one_candidate
-        if xml_buffer is not None:
-            self.xml_buffer = xml_buffer
-        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 one_candidate(self):
-        """Gets the one_candidate of this ChosenDocumentTypeResult.  # noqa: E501
-
-
-        :return: The one_candidate of this ChosenDocumentTypeResult.  # noqa: E501
-        :rtype: OneCandidate
-        """
-        return self._one_candidate
-
-    @one_candidate.setter
-    def one_candidate(self, one_candidate):
-        """Sets the one_candidate of this ChosenDocumentTypeResult.
-
-
-        :param one_candidate: The one_candidate of this ChosenDocumentTypeResult.  # noqa: E501
-        :type one_candidate: OneCandidate
+    Contains information about the type of document that was determined based on the analysis of the provided image
+    """ # noqa: E501
+    one_candidate: OneCandidate = Field(alias="OneCandidate")
+    xml_buffer: Optional[StrictStr] = Field(default=None, alias="XML_buffer")
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "OneCandidate", "XML_buffer"]
+
+    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 ChosenDocumentTypeResult 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 `readOnly` fields are excluded.
         """
+        excluded_fields: Set[str] = set([
+            "xml_buffer",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of one_candidate
+        if self.one_candidate:
+            _dict['OneCandidate'] = self.one_candidate.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChosenDocumentTypeResult 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"),
+            "OneCandidate": OneCandidate.from_dict(obj["OneCandidate"]) if obj.get("OneCandidate") is not None else None,
+            "XML_buffer": obj.get("XML_buffer")
+        })
+        return _obj
 
-        self._one_candidate = one_candidate
-
-    @property
-    def xml_buffer(self):
-        """Gets the xml_buffer of this ChosenDocumentTypeResult.  # noqa: E501
-
-
-        :return: The xml_buffer of this ChosenDocumentTypeResult.  # noqa: E501
-        :rtype: str
-        """
-        return self._xml_buffer
-
-    @xml_buffer.setter
-    def xml_buffer(self, xml_buffer):
-        """Sets the xml_buffer of this ChosenDocumentTypeResult.
-
-
-        :param xml_buffer: The xml_buffer of this ChosenDocumentTypeResult.  # noqa: E501
-        :type xml_buffer: str
-        """
-
-        self._xml_buffer = xml_buffer
-
-    @property
-    def buf_length(self):
-        """Gets the buf_length of this ChosenDocumentTypeResult.  # noqa: E501
-
-
-        :return: The buf_length of this ChosenDocumentTypeResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._buf_length
-
-    @buf_length.setter
-    def buf_length(self, buf_length):
-        """Sets the buf_length of this ChosenDocumentTypeResult.
-
-
-        :param buf_length: The buf_length of this ChosenDocumentTypeResult.  # noqa: E501
-        :type buf_length: int
-        """
-
-        self._buf_length = buf_length
-
-    @property
-    def light(self):
-        """Gets the light of this ChosenDocumentTypeResult.  # noqa: E501
-
-
-        :return: The light of this ChosenDocumentTypeResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._light
-
-    @light.setter
-    def light(self, light):
-        """Sets the light of this ChosenDocumentTypeResult.
-
-
-        :param light: The light of this ChosenDocumentTypeResult.  # noqa: E501
-        :type light: int
-        """
-
-        self._light = light
-
-    @property
-    def list_idx(self):
-        """Gets the list_idx of this ChosenDocumentTypeResult.  # noqa: E501
-
-
-        :return: The list_idx of this ChosenDocumentTypeResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._list_idx
-
-    @list_idx.setter
-    def list_idx(self, list_idx):
-        """Sets the list_idx of this ChosenDocumentTypeResult.
-
-
-        :param list_idx: The list_idx of this ChosenDocumentTypeResult.  # noqa: E501
-        :type list_idx: int
-        """
-
-        self._list_idx = list_idx
-
-    @property
-    def page_idx(self):
-        """Gets the page_idx of this ChosenDocumentTypeResult.  # noqa: E501
-
-
-        :return: The page_idx of this ChosenDocumentTypeResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._page_idx
-
-    @page_idx.setter
-    def page_idx(self, page_idx):
-        """Sets the page_idx of this ChosenDocumentTypeResult.
-
-
-        :param page_idx: The page_idx of this ChosenDocumentTypeResult.  # noqa: E501
-        :type page_idx: int
-        """
-
-        self._page_idx = page_idx
-
-    @property
-    def result_type(self):
-        """Gets the result_type of this ChosenDocumentTypeResult.  # 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 ChosenDocumentTypeResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._result_type
-
-    @result_type.setter
-    def result_type(self, result_type):
-        """Sets the result_type of this ChosenDocumentTypeResult.
-
-        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 ChosenDocumentTypeResult.  # 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, ChosenDocumentTypeResult):
-            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, ChosenDocumentTypeResult):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,145 +4,86 @@
     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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+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 *
-
-
-"""
-List with various objects, containing processing results
-"""
-class ContainerList(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class ContainerList(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 = {
-        'count': 'int',
-        'list': 'list[ResultItem]'
-    }
-
-    attribute_map = {
-        'count': 'Count',
-        'list': 'List'
-    }
-
-    def __init__(self, count=None, list=None, local_vars_configuration=None):  # noqa: E501
-        """ContainerList - 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._count = None
-        self._list = None
-        self.discriminator = None
-
-        if count is not None:
-            self.count = count
-        self.list = list
-
-    @property
-    def count(self):
-        """Gets the count of this ContainerList.  # noqa: E501
-
-        Length of list (Count for items)  # noqa: E501
-
-        :return: The count of this ContainerList.  # noqa: E501
-        :rtype: int
+    List with various objects, containing processing results
+    """ # noqa: E501
+    count: Optional[StrictInt] = Field(default=None, description="Length of list (Count for items)", alias="Count")
+    list: List[ResultItem] = Field(alias="List")
+    __properties: ClassVar[List[str]] = ["Count", "List"]
+
+    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 ContainerList 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._count
+        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 each item in list (list)
+        _items = []
+        if self.list:
+            for _item_list in self.list:
+                if _item_list:
+                    _items.append(_item_list.to_dict())
+            _dict['List'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ContainerList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "Count": obj.get("Count"),
+            "List": [ResultItem.from_dict(_item) for _item in obj["List"]] if obj.get("List") is not None else None
+        })
+        return _obj
 
-    @count.setter
-    def count(self, count):
-        """Sets the count of this ContainerList.
 
-        Length of list (Count for items)  # noqa: E501
-
-        :param count: The count of this ContainerList.  # noqa: E501
-        :type count: int
-        """
-
-        self._count = count
-
-    @property
-    def list(self):
-        """Gets the list of this ContainerList.  # noqa: E501
-
-
-        :return: The list of this ContainerList.  # noqa: E501
-        :rtype: list[ResultItem]
-        """
-        return self._list
-
-    @list.setter
-    def list(self, list):
-        """Sets the list of this ContainerList.
-
-
-        :param list: The list of this ContainerList.  # noqa: E501
-        :type list: list[ResultItem]
-        """
-        if self.local_vars_configuration.client_side_validation and list is None:  # noqa: E501
-            raise ValueError("Invalid value for `list`, must not be `None`")  # noqa: E501
-
-        self._list = list
-
-    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, ContainerList):
-            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, ContainerList):
-            return True
-
-        return self.to_dict() != other.to_dict()