regula-documentreader-webclient 8.1.349rc0__py3-none-any.whl → 8.1.351.dev0__py3-none-any.whl

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

@@ -4,315 +4,113 @@
     Generated by: https://openapi-generator.tech
 """
 
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
-
-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 TextFieldValue(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.
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
+from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+from regula.documentreader.webclient.gen.models.rfid_origin import RfidOrigin
+from regula.documentreader.webclient.gen.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TextFieldValue(BaseModel):
     """
-    openapi_types = {
-        'source': 'Source',
-        'value': 'str',
-        'original_value': 'str',
-        'original_symbols': 'list[OriginalSymbol]',
-        'page_index': 'int',
-        'probability': 'int',
-        'field_rect': 'RectangleCoordinates',
-        'rfid_origin': 'RfidOrigin'
-    }
-
-    attribute_map = {
-        'source': 'source',
-        'value': 'value',
-        'original_value': 'originalValue',
-        'original_symbols': 'originalSymbols',
-        'page_index': 'pageIndex',
-        'probability': 'probability',
-        'field_rect': 'fieldRect',
-        'rfid_origin': 'rfidOrigin'
-    }
-
-    def __init__(self, source=None, value=None, original_value=None, original_symbols=None, page_index=None, probability=None, field_rect=None, rfid_origin=None, local_vars_configuration=None):  # noqa: E501
-        """TextFieldValue - 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._source = None
-        self._value = None
-        self._original_value = None
-        self._original_symbols = None
-        self._page_index = None
-        self._probability = None
-        self._field_rect = None
-        self._rfid_origin = None
-        self.discriminator = None
-
-        self.source = source
-        self.value = value
-        if original_value is not None:
-            self.original_value = original_value
-        if original_symbols is not None:
-            self.original_symbols = original_symbols
-        self.page_index = page_index
-        if probability is not None:
-            self.probability = probability
-        if field_rect is not None:
-            self.field_rect = field_rect
-        if rfid_origin is not None:
-            self.rfid_origin = rfid_origin
-
-    @property
-    def source(self):
-        """Gets the source of this TextFieldValue.  # noqa: E501
-
-
-        :return: The source of this TextFieldValue.  # noqa: E501
-        :rtype: Source
-        """
-        return self._source
-
-    @source.setter
-    def source(self, source):
-        """Sets the source of this TextFieldValue.
-
-
-        :param source: The source of this TextFieldValue.  # noqa: E501
-        :type source: Source
-        """
-        if self.local_vars_configuration.client_side_validation and source is None:  # noqa: E501
-            raise ValueError("Invalid value for `source`, must not be `None`")  # noqa: E501
-
-        self._source = source
-
-    @property
-    def value(self):
-        """Gets the value of this TextFieldValue.  # noqa: E501
-
-        Parsed/processed value. Date format converted for output, delimiters removed  # noqa: E501
-
-        :return: The value of this TextFieldValue.  # noqa: E501
-        :rtype: str
-        """
-        return self._value
-
-    @value.setter
-    def value(self, value):
-        """Sets the value of this TextFieldValue.
-
-        Parsed/processed value. Date format converted for output, delimiters removed  # noqa: E501
-
-        :param value: The value of this TextFieldValue.  # noqa: E501
-        :type value: str
-        """
-        if self.local_vars_configuration.client_side_validation and value is None:  # noqa: E501
-            raise ValueError("Invalid value for `value`, must not be `None`")  # noqa: E501
-
-        self._value = value
-
-    @property
-    def original_value(self):
-        """Gets the original_value of this TextFieldValue.  # noqa: E501
-
-        Original value as seen in the document  # noqa: E501
-
-        :return: The original_value of this TextFieldValue.  # noqa: E501
-        :rtype: str
-        """
-        return self._original_value
-
-    @original_value.setter
-    def original_value(self, original_value):
-        """Sets the original_value of this TextFieldValue.
-
-        Original value as seen in the document  # noqa: E501
-
-        :param original_value: The original_value of this TextFieldValue.  # noqa: E501
-        :type original_value: str
-        """
-
-        self._original_value = original_value
-
-    @property
-    def original_symbols(self):
-        """Gets the original_symbols of this TextFieldValue.  # noqa: E501
-
-
-        :return: The original_symbols of this TextFieldValue.  # noqa: E501
-        :rtype: list[OriginalSymbol]
-        """
-        return self._original_symbols
-
-    @original_symbols.setter
-    def original_symbols(self, original_symbols):
-        """Sets the original_symbols of this TextFieldValue.
-
-
-        :param original_symbols: The original_symbols of this TextFieldValue.  # noqa: E501
-        :type original_symbols: list[OriginalSymbol]
-        """
-
-        self._original_symbols = original_symbols
-
-    @property
-    def page_index(self):
-        """Gets the page_index of this TextFieldValue.  # noqa: E501
-
-        Page index of the image from input list  # noqa: E501
-
-        :return: The page_index of this TextFieldValue.  # noqa: E501
-        :rtype: int
-        """
-        return self._page_index
-
-    @page_index.setter
-    def page_index(self, page_index):
-        """Sets the page_index of this TextFieldValue.
-
-        Page index of the image from input list  # noqa: E501
-
-        :param page_index: The page_index of this TextFieldValue.  # noqa: E501
-        :type page_index: int
-        """
-        if self.local_vars_configuration.client_side_validation and page_index is None:  # noqa: E501
-            raise ValueError("Invalid value for `page_index`, must not be `None`")  # noqa: E501
-
-        self._page_index = page_index
-
-    @property
-    def probability(self):
-        """Gets the probability of this TextFieldValue.  # noqa: E501
-
-        Min recognition probability. Combined minimum probability from single characters probabilities  # noqa: E501
-
-        :return: The probability of this TextFieldValue.  # noqa: E501
-        :rtype: int
-        """
-        return self._probability
-
-    @probability.setter
-    def probability(self, probability):
-        """Sets the probability of this TextFieldValue.
-
-        Min recognition probability. Combined minimum probability from single characters probabilities  # noqa: E501
-
-        :param probability: The probability of this TextFieldValue.  # noqa: E501
-        :type probability: int
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                probability is not None and probability > 100):  # noqa: E501
-            raise ValueError("Invalid value for `probability`, must be a value less than or equal to `100`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                probability is not None and probability < 0):  # noqa: E501
-            raise ValueError("Invalid value for `probability`, must be a value greater than or equal to `0`")  # noqa: E501
-
-        self._probability = probability
-
-    @property
-    def field_rect(self):
-        """Gets the field_rect of this TextFieldValue.  # noqa: E501
-
-
-        :return: The field_rect of this TextFieldValue.  # noqa: E501
-        :rtype: RectangleCoordinates
-        """
-        return self._field_rect
-
-    @field_rect.setter
-    def field_rect(self, field_rect):
-        """Sets the field_rect of this TextFieldValue.
-
-
-        :param field_rect: The field_rect of this TextFieldValue.  # noqa: E501
-        :type field_rect: RectangleCoordinates
-        """
-
-        self._field_rect = field_rect
-
-    @property
-    def rfid_origin(self):
-        """Gets the rfid_origin of this TextFieldValue.  # noqa: E501
-
-
-        :return: The rfid_origin of this TextFieldValue.  # noqa: E501
-        :rtype: RfidOrigin
-        """
-        return self._rfid_origin
-
-    @rfid_origin.setter
-    def rfid_origin(self, rfid_origin):
-        """Sets the rfid_origin of this TextFieldValue.
-
-
-        :param rfid_origin: The rfid_origin of this TextFieldValue.  # noqa: E501
-        :type rfid_origin: RfidOrigin
-        """
-
-        self._rfid_origin = rfid_origin
-
-    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, TextFieldValue):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    TextFieldValue
+    """ # noqa: E501
+    source: Source
+    value: StrictStr = Field(description="Parsed/processed value. Date format converted for output, delimiters removed")
+    original_value: Optional[StrictStr] = Field(default=None, description="Original value as seen in the document", alias="originalValue")
+    original_validity: CheckResult = Field(alias="originalValidity")
+    original_symbols: Optional[List[OriginalSymbol]] = Field(default=None, alias="originalSymbols")
+    page_index: StrictInt = Field(description="Page index of the image from input list", alias="pageIndex")
+    probability: Annotated[int, Field(le=100, strict=True, ge=0)] = Field(description="Min recognition probability. Combined minimum probability from single characters probabilities")
+    field_rect: Optional[RectangleCoordinates] = Field(default=None, alias="fieldRect")
+    rfid_origin: Optional[RfidOrigin] = Field(default=None, alias="rfidOrigin")
+    container_type: Optional[StrictInt] = Field(default=0, description="Same as Result type, but used for safe parsing of not-described values. See Result type.", alias="containerType")
+    __properties: ClassVar[List[str]] = ["source", "value", "originalValue", "originalValidity", "originalSymbols", "pageIndex", "probability", "fieldRect", "rfidOrigin", "containerType"]
+
+    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 TextFieldValue 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 each item in original_symbols (list)
+        _items = []
+        if self.original_symbols:
+            for _item_original_symbols in self.original_symbols:
+                if _item_original_symbols:
+                    _items.append(_item_original_symbols.to_dict())
+            _dict['originalSymbols'] = _items
+        # override the default output from pydantic by calling `to_dict()` of field_rect
+        if self.field_rect:
+            _dict['fieldRect'] = self.field_rect.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rfid_origin
+        if self.rfid_origin:
+            _dict['rfidOrigin'] = self.rfid_origin.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TextFieldValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "source": obj.get("source"),
+            "value": obj.get("value"),
+            "originalValue": obj.get("originalValue"),
+            "originalValidity": obj.get("originalValidity"),
+            "originalSymbols": [OriginalSymbol.from_dict(_item) for _item in obj["originalSymbols"]] if obj.get("originalSymbols") is not None else None,
+            "pageIndex": obj.get("pageIndex"),
+            "probability": obj.get("probability"),
+            "fieldRect": RectangleCoordinates.from_dict(obj["fieldRect"]) if obj.get("fieldRect") is not None else None,
+            "rfidOrigin": RfidOrigin.from_dict(obj["rfidOrigin"]) if obj.get("rfidOrigin") is not None else None,
+            "containerType": obj.get("containerType") if obj.get("containerType") is not None else 0
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, TextFieldValue):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

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

@@ -4,98 +4,28 @@
     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 TextPostProcessing(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class TextPostProcessing(int, Enum):
+    """
+    TextPostProcessing
     """
-
-    NO_CHANGE = int("0")
-
-    UPPERCASE = int("1")
-
-    LOWERCASE = int("2")
-
-    CAPITAL = int("3")
-
-    allowable_values = [NO_CHANGE, UPPERCASE, LOWERCASE, CAPITAL]  # 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
-        """TextPostProcessing - 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, TextPostProcessing):
-            return False
+    NO_CHANGE = 0
+    UPPERCASE = 1
+    LOWERCASE = 2
+    CAPITAL = 3
 
-        return self.to_dict() == other.to_dict()
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TextPostProcessing 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, TextPostProcessing):
-            return True
 
-        return self.to_dict() != other.to_dict()