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

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

@@ -4,96 +4,27 @@
     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 DocumentTypeRecognitionResult(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class DocumentTypeRecognitionResult(int, Enum):
+    """
+    DocumentTypeRecognitionResult
     """
-
-    OK = int("0")
-
-    UNKNOWN = int("15")
-
-    NEED_MORE_IMAGES = int("29")
-
-    allowable_values = [OK, UNKNOWN, NEED_MORE_IMAGES]  # 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
-        """DocumentTypeRecognitionResult - 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, DocumentTypeRecognitionResult):
-            return False
+    OK = 0
+    UNKNOWN = 15
+    NEED_MORE_IMAGES = 29
 
-        return self.to_dict() == other.to_dict()
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DocumentTypeRecognitionResult 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, DocumentTypeRecognitionResult):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -4,142 +4,87 @@
     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
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.document_type_recognition_result import DocumentTypeRecognitionResult
+from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
+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 DocumentTypesCandidates(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class DocumentTypesCandidates(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 = {
-        'rec_result': 'DocumentTypeRecognitionResult',
-        'candidates': 'list[OneCandidate]'
-    }
-
-    attribute_map = {
-        'rec_result': 'RecResult',
-        'candidates': 'Candidates'
-    }
-
-    def __init__(self, rec_result=None, candidates=None, local_vars_configuration=None):  # noqa: E501
-        """DocumentTypesCandidates - 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._rec_result = None
-        self._candidates = None
-        self.discriminator = None
-
-        if rec_result is not None:
-            self.rec_result = rec_result
-        if candidates is not None:
-            self.candidates = candidates
-
-    @property
-    def rec_result(self):
-        """Gets the rec_result of this DocumentTypesCandidates.  # noqa: E501
-
-
-        :return: The rec_result of this DocumentTypesCandidates.  # noqa: E501
-        :rtype: DocumentTypeRecognitionResult
+    DocumentTypesCandidates
+    """ # noqa: E501
+    rec_result: Optional[DocumentTypeRecognitionResult] = Field(default=None, alias="RecResult")
+    candidates: Optional[List[OneCandidate]] = Field(default=None, alias="Candidates")
+    __properties: ClassVar[List[str]] = ["RecResult", "Candidates"]
+
+    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 DocumentTypesCandidates 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._rec_result
-
-    @rec_result.setter
-    def rec_result(self, rec_result):
-        """Sets the rec_result of this DocumentTypesCandidates.
-
+        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 candidates (list)
+        _items = []
+        if self.candidates:
+            for _item_candidates in self.candidates:
+                if _item_candidates:
+                    _items.append(_item_candidates.to_dict())
+            _dict['Candidates'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DocumentTypesCandidates from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "RecResult": obj.get("RecResult"),
+            "Candidates": [OneCandidate.from_dict(_item) for _item in obj["Candidates"]] if obj.get("Candidates") is not None else None
+        })
+        return _obj
 
-        :param rec_result: The rec_result of this DocumentTypesCandidates.  # noqa: E501
-        :type rec_result: DocumentTypeRecognitionResult
-        """
-
-        self._rec_result = rec_result
-
-    @property
-    def candidates(self):
-        """Gets the candidates of this DocumentTypesCandidates.  # noqa: E501
-
-
-        :return: The candidates of this DocumentTypesCandidates.  # noqa: E501
-        :rtype: list[OneCandidate]
-        """
-        return self._candidates
-
-    @candidates.setter
-    def candidates(self, candidates):
-        """Sets the candidates of this DocumentTypesCandidates.
-
-
-        :param candidates: The candidates of this DocumentTypesCandidates.  # noqa: E501
-        :type candidates: list[OneCandidate]
-        """
 
-        self._candidates = candidates
-
-    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, DocumentTypesCandidates):
-            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, DocumentTypesCandidates):
-            return True
-
-        return self.to_dict() != other.to_dict()

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

@@ -4,142 +4,87 @@
     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
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.document_type_recognition_result import DocumentTypeRecognitionResult
+from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
+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 DocumentTypesCandidatesList(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class DocumentTypesCandidatesList(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 = {
-        'rec_result': 'DocumentTypeRecognitionResult',
-        'candidates': 'list[OneCandidate]'
-    }
-
-    attribute_map = {
-        'rec_result': 'RecResult',
-        'candidates': 'Candidates'
-    }
-
-    def __init__(self, rec_result=None, candidates=None, local_vars_configuration=None):  # noqa: E501
-        """DocumentTypesCandidatesList - 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._rec_result = None
-        self._candidates = None
-        self.discriminator = None
-
-        if rec_result is not None:
-            self.rec_result = rec_result
-        if candidates is not None:
-            self.candidates = candidates
-
-    @property
-    def rec_result(self):
-        """Gets the rec_result of this DocumentTypesCandidatesList.  # noqa: E501
-
-
-        :return: The rec_result of this DocumentTypesCandidatesList.  # noqa: E501
-        :rtype: DocumentTypeRecognitionResult
+    DocumentTypesCandidatesList
+    """ # noqa: E501
+    rec_result: Optional[DocumentTypeRecognitionResult] = Field(default=None, alias="RecResult")
+    candidates: Optional[List[OneCandidate]] = Field(default=None, alias="Candidates")
+    __properties: ClassVar[List[str]] = ["RecResult", "Candidates"]
+
+    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 DocumentTypesCandidatesList 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._rec_result
-
-    @rec_result.setter
-    def rec_result(self, rec_result):
-        """Sets the rec_result of this DocumentTypesCandidatesList.
-
+        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 candidates (list)
+        _items = []
+        if self.candidates:
+            for _item_candidates in self.candidates:
+                if _item_candidates:
+                    _items.append(_item_candidates.to_dict())
+            _dict['Candidates'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DocumentTypesCandidatesList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "RecResult": obj.get("RecResult"),
+            "Candidates": [OneCandidate.from_dict(_item) for _item in obj["Candidates"]] if obj.get("Candidates") is not None else None
+        })
+        return _obj
 
-        :param rec_result: The rec_result of this DocumentTypesCandidatesList.  # noqa: E501
-        :type rec_result: DocumentTypeRecognitionResult
-        """
-
-        self._rec_result = rec_result
-
-    @property
-    def candidates(self):
-        """Gets the candidates of this DocumentTypesCandidatesList.  # noqa: E501
-
-
-        :return: The candidates of this DocumentTypesCandidatesList.  # noqa: E501
-        :rtype: list[OneCandidate]
-        """
-        return self._candidates
-
-    @candidates.setter
-    def candidates(self, candidates):
-        """Sets the candidates of this DocumentTypesCandidatesList.
-
-
-        :param candidates: The candidates of this DocumentTypesCandidatesList.  # noqa: E501
-        :type candidates: list[OneCandidate]
-        """
 
-        self._candidates = candidates
-
-    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, DocumentTypesCandidatesList):
-            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, DocumentTypesCandidatesList):
-            return True
-
-        return self.to_dict() != other.to_dict()