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

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

@@ -4,117 +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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from regula.documentreader.webclient.gen.models.doc_visual_extended_field import DocVisualExtendedField
+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 *
-
-
-"""
-Container for extracted text fields. Fields are identified by type and language
-"""
-class DocVisualExtendedInfo(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class DocVisualExtendedInfo(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 = {
-        'p_array_fields': 'list[DocVisualExtendedField]'
-    }
-
-    attribute_map = {
-        'p_array_fields': 'pArrayFields'
-    }
-
-    def __init__(self, p_array_fields=None, local_vars_configuration=None):  # noqa: E501
-        """DocVisualExtendedInfo - 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._p_array_fields = None
-        self.discriminator = None
-
-        self.p_array_fields = p_array_fields
-
-    @property
-    def p_array_fields(self):
-        """Gets the p_array_fields of this DocVisualExtendedInfo.  # noqa: E501
-
-
-        :return: The p_array_fields of this DocVisualExtendedInfo.  # noqa: E501
-        :rtype: list[DocVisualExtendedField]
+    Container for extracted text fields. Fields are identified by type and language
+    """ # noqa: E501
+    n_fields: Union[StrictFloat, StrictInt] = Field(description="Number of pArrayFields array elements", alias="nFields")
+    p_array_fields: List[DocVisualExtendedField] = Field(alias="pArrayFields")
+    __properties: ClassVar[List[str]] = ["nFields", "pArrayFields"]
+
+    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 DocVisualExtendedInfo 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._p_array_fields
+        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 p_array_fields (list)
+        _items = []
+        if self.p_array_fields:
+            for _item_p_array_fields in self.p_array_fields:
+                if _item_p_array_fields:
+                    _items.append(_item_p_array_fields.to_dict())
+            _dict['pArrayFields'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DocVisualExtendedInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "nFields": obj.get("nFields"),
+            "pArrayFields": [DocVisualExtendedField.from_dict(_item) for _item in obj["pArrayFields"]] if obj.get("pArrayFields") is not None else None
+        })
+        return _obj
 
-    @p_array_fields.setter
-    def p_array_fields(self, p_array_fields):
-        """Sets the p_array_fields of this DocVisualExtendedInfo.
 
-
-        :param p_array_fields: The p_array_fields of this DocVisualExtendedInfo.  # noqa: E501
-        :type p_array_fields: list[DocVisualExtendedField]
-        """
-        if self.local_vars_configuration.client_side_validation and p_array_fields is None:  # noqa: E501
-            raise ValueError("Invalid value for `p_array_fields`, must not be `None`")  # noqa: E501
-
-        self._p_array_fields = p_array_fields
-
-    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, DocVisualExtendedInfo):
-            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, DocVisualExtendedInfo):
-            return True
-
-        return self.to_dict() != other.to_dict()

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

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

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    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.result import Result
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+from regula.documentreader.webclient.gen.models.t_doc_binary_info import TDocBinaryInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DocumentBinaryInfoResult(ResultItem):
+    """
+    Structure is used to store the data reading results from the RFID-chip in a form of a list of the logically separated data groups.
+    """ # noqa: E501
+    t_doc_binary_info: TDocBinaryInfo = Field(alias="TDocBinaryInfo")
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "TDocBinaryInfo"]
+
+    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 DocumentBinaryInfoResult 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 t_doc_binary_info
+        if self.t_doc_binary_info:
+            _dict['TDocBinaryInfo'] = self.t_doc_binary_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DocumentBinaryInfoResult 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"),
+            "TDocBinaryInfo": TDocBinaryInfo.from_dict(obj["TDocBinaryInfo"]) if obj.get("TDocBinaryInfo") is not None else None
+        })
+        return _obj
+
+

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

@@ -4,116 +4,38 @@
     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 *
-
-
-"""
-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.
+class DocumentFormat(int, Enum):
+    """
+    Defining the geometric format of documents in accordance with ISO / IEC 7810
     """
-
-    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
 
     """
-    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
-        """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()
+    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))
 
-    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()