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

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

@@ -4,250 +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 ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.result import Result
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+from regula.documentreader.webclient.gen.models.status import Status
+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 StatusResult(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class StatusResult(ResultItem):
     """
+    StatusResult
+    """ # noqa: E501
+    status: Status = Field(alias="Status")
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "Status"]
 
-    """
-    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 = {
-        'status': 'Status',
-        'buf_length': 'int',
-        'light': 'int',
-        'list_idx': 'int',
-        'page_idx': 'int',
-        'result_type': 'int'
-    }
-
-    attribute_map = {
-        'status': 'Status',
-        'buf_length': 'buf_length',
-        'light': 'light',
-        'list_idx': 'list_idx',
-        'page_idx': 'page_idx',
-        'result_type': 'result_type'
-    }
-
-    def __init__(self, status=None, buf_length=None, light=None, list_idx=None, page_idx=None, result_type=0, local_vars_configuration=None):  # noqa: E501
-        """StatusResult - 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._status = None
-        self._buf_length = None
-        self._light = None
-        self._list_idx = None
-        self._page_idx = None
-        self._result_type = None
-        self.discriminator = None
-
-        self.status = status
-        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 status(self):
-        """Gets the status of this StatusResult.  # noqa: E501
-
-
-        :return: The status of this StatusResult.  # noqa: E501
-        :rtype: Status
-        """
-        return self._status
-
-    @status.setter
-    def status(self, status):
-        """Sets the status of this StatusResult.
-
-
-        :param status: The status of this StatusResult.  # noqa: E501
-        :type status: Status
-        """
-        if self.local_vars_configuration.client_side_validation and status is None:  # noqa: E501
-            raise ValueError("Invalid value for `status`, must not be `None`")  # noqa: E501
-
-        self._status = status
-
-    @property
-    def buf_length(self):
-        """Gets the buf_length of this StatusResult.  # noqa: E501
-
-
-        :return: The buf_length of this StatusResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._buf_length
-
-    @buf_length.setter
-    def buf_length(self, buf_length):
-        """Sets the buf_length of this StatusResult.
-
-
-        :param buf_length: The buf_length of this StatusResult.  # noqa: E501
-        :type buf_length: int
-        """
-
-        self._buf_length = buf_length
-
-    @property
-    def light(self):
-        """Gets the light of this StatusResult.  # noqa: E501
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
-        :return: The light of this StatusResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._light
-
-    @light.setter
-    def light(self, light):
-        """Sets the light of this StatusResult.
-
-
-        :param light: The light of this StatusResult.  # noqa: E501
-        :type light: int
-        """
-
-        self._light = light
-
-    @property
-    def list_idx(self):
-        """Gets the list_idx of this StatusResult.  # noqa: E501
-
-
-        :return: The list_idx of this StatusResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._list_idx
-
-    @list_idx.setter
-    def list_idx(self, list_idx):
-        """Sets the list_idx of this StatusResult.
-
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
 
-        :param list_idx: The list_idx of this StatusResult.  # noqa: E501
-        :type list_idx: int
-        """
-
-        self._list_idx = list_idx
-
-    @property
-    def page_idx(self):
-        """Gets the page_idx of this StatusResult.  # noqa: E501
-
-
-        :return: The page_idx of this StatusResult.  # noqa: E501
-        :rtype: int
-        """
-        return self._page_idx
+    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())
 
-    @page_idx.setter
-    def page_idx(self, page_idx):
-        """Sets the page_idx of this StatusResult.
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of StatusResult 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.
 
-        :param page_idx: The page_idx of this StatusResult.  # noqa: E501
-        :type page_idx: int
-        """
-
-        self._page_idx = page_idx
-
-    @property
-    def result_type(self):
-        """Gets the result_type of this StatusResult.  # noqa: E501
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
 
-        Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
-
-        :return: The result_type of this StatusResult.  # noqa: E501
-        :rtype: int
+        * `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._result_type
-
-    @result_type.setter
-    def result_type(self, result_type):
-        """Sets the result_type of this StatusResult.
+        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 status
+        if self.status:
+            _dict['Status'] = self.status.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StatusResult 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"),
+            "Status": Status.from_dict(obj["Status"]) if obj.get("Status") is not None else None
+        })
+        return _obj
 
-        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 StatusResult.  # 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, StatusResult):
-            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, StatusResult):
-            return True
-
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,135 @@
+# 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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from regula.documentreader.webclient.gen.models.error_coordinates import ErrorCoordinates
+from regula.documentreader.webclient.gen.models.field_item import FieldItem
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+from regula.documentreader.webclient.gen.models.symbol_estimation_item import SymbolEstimationItem
+from typing import Optional, Set
+from typing_extensions import Self
+
+class StringItem(BaseModel):
+    """
+    StringItem
+    """ # noqa: E501
+    alignment_symbols_in_string: StrictInt = Field(alias="ALIGNMENT_SYMBOLS_IN_STRING")
+    check_sums: StrictInt = Field(alias="CHECK_SUMS")
+    error_position: ErrorCoordinates = Field(alias="ErrorPOSITION")
+    field_count: StrictInt = Field(alias="FieldCount")
+    fields: List[FieldItem] = Field(alias="Fields")
+    strings_distance: StrictInt = Field(alias="STRINGS_DISTANCE")
+    strings_interval: StrictInt = Field(alias="STRINGS_INTERVAL")
+    string_filling: StrictInt = Field(alias="STRING_FILLING")
+    string_position: StrictInt = Field(alias="STRING_POSITION")
+    symbols_param: StrictInt = Field(alias="SYMBOLS_PARAM")
+    size_error_alignment: Union[StrictFloat, StrictInt] = Field(alias="SizeError_ALIGNMENT")
+    size_error_distance: Union[StrictFloat, StrictInt] = Field(alias="SizeError_DISTANCE")
+    size_error_interval: Union[StrictFloat, StrictInt] = Field(alias="SizeError_INTERVAL")
+    string_angle: Union[StrictFloat, StrictInt] = Field(alias="StringAngle")
+    string_borders: RectangleCoordinates = Field(alias="StringBorders")
+    symbols_count: StrictInt = Field(alias="SymbolsCount")
+    symbols_estimations: List[SymbolEstimationItem] = Field(alias="SymbolsEstimations")
+    __properties: ClassVar[List[str]] = ["ALIGNMENT_SYMBOLS_IN_STRING", "CHECK_SUMS", "ErrorPOSITION", "FieldCount", "Fields", "STRINGS_DISTANCE", "STRINGS_INTERVAL", "STRING_FILLING", "STRING_POSITION", "SYMBOLS_PARAM", "SizeError_ALIGNMENT", "SizeError_DISTANCE", "SizeError_INTERVAL", "StringAngle", "StringBorders", "SymbolsCount", "SymbolsEstimations"]
+
+    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 StringItem 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 error_position
+        if self.error_position:
+            _dict['ErrorPOSITION'] = self.error_position.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in fields (list)
+        _items = []
+        if self.fields:
+            for _item_fields in self.fields:
+                if _item_fields:
+                    _items.append(_item_fields.to_dict())
+            _dict['Fields'] = _items
+        # override the default output from pydantic by calling `to_dict()` of string_borders
+        if self.string_borders:
+            _dict['StringBorders'] = self.string_borders.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in symbols_estimations (list)
+        _items = []
+        if self.symbols_estimations:
+            for _item_symbols_estimations in self.symbols_estimations:
+                if _item_symbols_estimations:
+                    _items.append(_item_symbols_estimations.to_dict())
+            _dict['SymbolsEstimations'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StringItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ALIGNMENT_SYMBOLS_IN_STRING": obj.get("ALIGNMENT_SYMBOLS_IN_STRING"),
+            "CHECK_SUMS": obj.get("CHECK_SUMS"),
+            "ErrorPOSITION": ErrorCoordinates.from_dict(obj["ErrorPOSITION"]) if obj.get("ErrorPOSITION") is not None else None,
+            "FieldCount": obj.get("FieldCount"),
+            "Fields": [FieldItem.from_dict(_item) for _item in obj["Fields"]] if obj.get("Fields") is not None else None,
+            "STRINGS_DISTANCE": obj.get("STRINGS_DISTANCE"),
+            "STRINGS_INTERVAL": obj.get("STRINGS_INTERVAL"),
+            "STRING_FILLING": obj.get("STRING_FILLING"),
+            "STRING_POSITION": obj.get("STRING_POSITION"),
+            "SYMBOLS_PARAM": obj.get("SYMBOLS_PARAM"),
+            "SizeError_ALIGNMENT": obj.get("SizeError_ALIGNMENT"),
+            "SizeError_DISTANCE": obj.get("SizeError_DISTANCE"),
+            "SizeError_INTERVAL": obj.get("SizeError_INTERVAL"),
+            "StringAngle": obj.get("StringAngle"),
+            "StringBorders": RectangleCoordinates.from_dict(obj["StringBorders"]) if obj.get("StringBorders") is not None else None,
+            "SymbolsCount": obj.get("SymbolsCount"),
+            "SymbolsEstimations": [SymbolEstimationItem.from_dict(_item) for _item in obj["SymbolsEstimations"]] if obj.get("SymbolsEstimations") is not None else None
+        })
+        return _obj
+
+

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

@@ -4,119 +4,92 @@
     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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.symbol_recognition_result import SymbolRecognitionResult
+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 *
-
-
-"""
-Describes single row recognition results in multi-line text field of a document
-"""
-class StringRecognitionResult(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class StringRecognitionResult(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 = {
-        'string_result': 'list[SymbolRecognitionResult]'
-    }
-
-    attribute_map = {
-        'string_result': 'StringResult'
-    }
-
-    def __init__(self, string_result=None, local_vars_configuration=None):  # noqa: E501
-        """StringRecognitionResult - 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._string_result = None
-        self.discriminator = None
-
-        self.string_result = string_result
-
-    @property
-    def string_result(self):
-        """Gets the string_result of this StringRecognitionResult.  # noqa: E501
-
-        Array of recognition results for individual characters of a string  # noqa: E501
-
-        :return: The string_result of this StringRecognitionResult.  # noqa: E501
-        :rtype: list[SymbolRecognitionResult]
+    Describes single row recognition results in multi-line text field of a document
+    """ # noqa: E501
+    symbols_count: Union[StrictFloat, StrictInt] = Field(description="Number of StringResult array elements", alias="SymbolsCount")
+    string_result: List[SymbolRecognitionResult] = Field(description="Array of recognition results for individual characters of a string", alias="StringResult")
+    buf_length: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Buf_Text text string length", alias="Buf_Length")
+    buf_text: Optional[StrictStr] = Field(default=None, description="Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'", alias="Buf_Text")
+    reserved: Optional[StrictInt] = Field(default=None, alias="Reserved")
+    __properties: ClassVar[List[str]] = ["SymbolsCount", "StringResult", "Buf_Length", "Buf_Text", "Reserved"]
+
+    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 StringRecognitionResult 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._string_result
+        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 string_result (list)
+        _items = []
+        if self.string_result:
+            for _item_string_result in self.string_result:
+                if _item_string_result:
+                    _items.append(_item_string_result.to_dict())
+            _dict['StringResult'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StringRecognitionResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "SymbolsCount": obj.get("SymbolsCount"),
+            "StringResult": [SymbolRecognitionResult.from_dict(_item) for _item in obj["StringResult"]] if obj.get("StringResult") is not None else None,
+            "Buf_Length": obj.get("Buf_Length"),
+            "Buf_Text": obj.get("Buf_Text"),
+            "Reserved": obj.get("Reserved")
+        })
+        return _obj
 
-    @string_result.setter
-    def string_result(self, string_result):
-        """Sets the string_result of this StringRecognitionResult.
 
-        Array of recognition results for individual characters of a string  # noqa: E501
-
-        :param string_result: The string_result of this StringRecognitionResult.  # noqa: E501
-        :type string_result: list[SymbolRecognitionResult]
-        """
-        if self.local_vars_configuration.client_side_validation and string_result is None:  # noqa: E501
-            raise ValueError("Invalid value for `string_result`, must not be `None`")  # noqa: E501
-
-        self._string_result = string_result
-
-    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, StringRecognitionResult):
-            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, StringRecognitionResult):
-            return True
-
-        return self.to_dict() != other.to_dict()