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

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

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

@@ -4,311 +4,115 @@
     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.rectangle_coordinates import RectangleCoordinates
+from regula.documentreader.webclient.gen.models.string_recognition_result import StringRecognitionResult
+from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
+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 DocVisualExtendedField(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class DocVisualExtendedField(BaseModel):
     """
+    DocVisualExtendedField
+    """ # noqa: E501
+    field_type: StrictInt = Field(alias="FieldType")
+    w_field_type: TextFieldType = Field(alias="wFieldType")
+    field_name: StrictStr = Field(description="Field symbolic name (null-terminated string)", alias="FieldName")
+    strings_count: Union[StrictFloat, StrictInt] = Field(description="Number of StringsResult array elements", alias="StringsCount")
+    strings_result: List[StringRecognitionResult] = Field(description="Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.", alias="StringsResult")
+    buf_length: Union[StrictFloat, StrictInt] = Field(description="Buf_Text text string length", alias="Buf_Length")
+    buf_text: StrictStr = Field(description="Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'", alias="Buf_Text")
+    field_mask: Optional[StrictStr] = Field(default=None, alias="FieldMask")
+    validity: Optional[StrictInt] = Field(default=None, alias="Validity")
+    in_comparison: Optional[StrictInt] = Field(default=None, alias="InComparison")
+    w_lcid: Optional[StrictInt] = Field(default=None, alias="wLCID")
+    reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
+    reserved3: Optional[StrictInt] = Field(default=None, alias="Reserved3")
+    field_rect: RectangleCoordinates = Field(alias="FieldRect")
+    __properties: ClassVar[List[str]] = ["FieldType", "wFieldType", "FieldName", "StringsCount", "StringsResult", "Buf_Length", "Buf_Text", "FieldMask", "Validity", "InComparison", "wLCID", "Reserved2", "Reserved3", "FieldRect"]
+
+    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 DocVisualExtendedField 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 strings_result (list)
+        _items = []
+        if self.strings_result:
+            for _item_strings_result in self.strings_result:
+                if _item_strings_result:
+                    _items.append(_item_strings_result.to_dict())
+            _dict['StringsResult'] = _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()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DocVisualExtendedField from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "FieldType": obj.get("FieldType"),
+            "wFieldType": obj.get("wFieldType"),
+            "FieldName": obj.get("FieldName"),
+            "StringsCount": obj.get("StringsCount"),
+            "StringsResult": [StringRecognitionResult.from_dict(_item) for _item in obj["StringsResult"]] if obj.get("StringsResult") is not None else None,
+            "Buf_Length": obj.get("Buf_Length"),
+            "Buf_Text": obj.get("Buf_Text"),
+            "FieldMask": obj.get("FieldMask"),
+            "Validity": obj.get("Validity"),
+            "InComparison": obj.get("InComparison"),
+            "wLCID": obj.get("wLCID"),
+            "Reserved2": obj.get("Reserved2"),
+            "Reserved3": obj.get("Reserved3"),
+            "FieldRect": RectangleCoordinates.from_dict(obj["FieldRect"]) if obj.get("FieldRect") is not None else None
+        })
+        return _obj
 
-    """
-    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 = {
-        'w_field_type': 'TextFieldType',
-        'field_name': 'str',
-        'w_lcid': 'LCID',
-        'strings_result': 'list[StringRecognitionResult]',
-        'buf_text': 'str',
-        'field_rect': 'RectangleCoordinates',
-        'rfid_origin_dg': 'int',
-        'rfid_origin_tag_entry': 'int'
-    }
-
-    attribute_map = {
-        'w_field_type': 'wFieldType',
-        'field_name': 'FieldName',
-        'w_lcid': 'wLCID',
-        'strings_result': 'StringsResult',
-        'buf_text': 'Buf_Text',
-        'field_rect': 'FieldRect',
-        'rfid_origin_dg': 'RFID_OriginDG',
-        'rfid_origin_tag_entry': 'RFID_OriginTagEntry'
-    }
-
-    def __init__(self, w_field_type=None, field_name=None, w_lcid=None, strings_result=None, buf_text=None, field_rect=None, rfid_origin_dg=None, rfid_origin_tag_entry=None, local_vars_configuration=None):  # noqa: E501
-        """DocVisualExtendedField - 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._w_field_type = None
-        self._field_name = None
-        self._w_lcid = None
-        self._strings_result = None
-        self._buf_text = None
-        self._field_rect = None
-        self._rfid_origin_dg = None
-        self._rfid_origin_tag_entry = None
-        self.discriminator = None
-
-        self.w_field_type = w_field_type
-        self.field_name = field_name
-        self.w_lcid = w_lcid
-        if strings_result is not None:
-            self.strings_result = strings_result
-        if buf_text is not None:
-            self.buf_text = buf_text
-        if field_rect is not None:
-            self.field_rect = field_rect
-        if rfid_origin_dg is not None:
-            self.rfid_origin_dg = rfid_origin_dg
-        if rfid_origin_tag_entry is not None:
-            self.rfid_origin_tag_entry = rfid_origin_tag_entry
-
-    @property
-    def w_field_type(self):
-        """Gets the w_field_type of this DocVisualExtendedField.  # noqa: E501
-
-
-        :return: The w_field_type of this DocVisualExtendedField.  # noqa: E501
-        :rtype: TextFieldType
-        """
-        return self._w_field_type
-
-    @w_field_type.setter
-    def w_field_type(self, w_field_type):
-        """Sets the w_field_type of this DocVisualExtendedField.
-
-
-        :param w_field_type: The w_field_type of this DocVisualExtendedField.  # noqa: E501
-        :type w_field_type: TextFieldType
-        """
-        if self.local_vars_configuration.client_side_validation and w_field_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `w_field_type`, must not be `None`")  # noqa: E501
-
-        self._w_field_type = w_field_type
-
-    @property
-    def field_name(self):
-        """Gets the field_name of this DocVisualExtendedField.  # noqa: E501
-
-        Field name. Only use to search values for fields with fieldType=50(other). In general, use wFieldType for lookup.  # noqa: E501
-
-        :return: The field_name of this DocVisualExtendedField.  # noqa: E501
-        :rtype: str
-        """
-        return self._field_name
-
-    @field_name.setter
-    def field_name(self, field_name):
-        """Sets the field_name of this DocVisualExtendedField.
-
-        Field name. Only use to search values for fields with fieldType=50(other). In general, use wFieldType for lookup.  # noqa: E501
-
-        :param field_name: The field_name of this DocVisualExtendedField.  # noqa: E501
-        :type field_name: str
-        """
-        if self.local_vars_configuration.client_side_validation and field_name is None:  # noqa: E501
-            raise ValueError("Invalid value for `field_name`, must not be `None`")  # noqa: E501
-
-        self._field_name = field_name
-
-    @property
-    def w_lcid(self):
-        """Gets the w_lcid of this DocVisualExtendedField.  # noqa: E501
-
-
-        :return: The w_lcid of this DocVisualExtendedField.  # noqa: E501
-        :rtype: LCID
-        """
-        return self._w_lcid
-
-    @w_lcid.setter
-    def w_lcid(self, w_lcid):
-        """Sets the w_lcid of this DocVisualExtendedField.
-
-
-        :param w_lcid: The w_lcid of this DocVisualExtendedField.  # noqa: E501
-        :type w_lcid: LCID
-        """
-        if self.local_vars_configuration.client_side_validation and w_lcid is None:  # noqa: E501
-            raise ValueError("Invalid value for `w_lcid`, must not be `None`")  # noqa: E501
-
-        self._w_lcid = w_lcid
-
-    @property
-    def strings_result(self):
-        """Gets the strings_result of this DocVisualExtendedField.  # noqa: E501
-
-        Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.  # noqa: E501
-
-        :return: The strings_result of this DocVisualExtendedField.  # noqa: E501
-        :rtype: list[StringRecognitionResult]
-        """
-        return self._strings_result
-
-    @strings_result.setter
-    def strings_result(self, strings_result):
-        """Sets the strings_result of this DocVisualExtendedField.
-
-        Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.  # noqa: E501
-
-        :param strings_result: The strings_result of this DocVisualExtendedField.  # noqa: E501
-        :type strings_result: list[StringRecognitionResult]
-        """
-
-        self._strings_result = strings_result
-
-    @property
-    def buf_text(self):
-        """Gets the buf_text of this DocVisualExtendedField.  # noqa: E501
-
-        Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'  # noqa: E501
-
-        :return: The buf_text of this DocVisualExtendedField.  # noqa: E501
-        :rtype: str
-        """
-        return self._buf_text
-
-    @buf_text.setter
-    def buf_text(self, buf_text):
-        """Sets the buf_text of this DocVisualExtendedField.
-
-        Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'  # noqa: E501
-
-        :param buf_text: The buf_text of this DocVisualExtendedField.  # noqa: E501
-        :type buf_text: str
-        """
-
-        self._buf_text = buf_text
-
-    @property
-    def field_rect(self):
-        """Gets the field_rect of this DocVisualExtendedField.  # noqa: E501
-
-
-        :return: The field_rect of this DocVisualExtendedField.  # noqa: E501
-        :rtype: RectangleCoordinates
-        """
-        return self._field_rect
-
-    @field_rect.setter
-    def field_rect(self, field_rect):
-        """Sets the field_rect of this DocVisualExtendedField.
-
-
-        :param field_rect: The field_rect of this DocVisualExtendedField.  # noqa: E501
-        :type field_rect: RectangleCoordinates
-        """
-
-        self._field_rect = field_rect
-
-    @property
-    def rfid_origin_dg(self):
-        """Gets the rfid_origin_dg of this DocVisualExtendedField.  # noqa: E501
-
-        Origin data group information. Only for Result.RFID_TEXT results.  # noqa: E501
-
-        :return: The rfid_origin_dg of this DocVisualExtendedField.  # noqa: E501
-        :rtype: int
-        """
-        return self._rfid_origin_dg
-
-    @rfid_origin_dg.setter
-    def rfid_origin_dg(self, rfid_origin_dg):
-        """Sets the rfid_origin_dg of this DocVisualExtendedField.
-
-        Origin data group information. Only for Result.RFID_TEXT results.  # noqa: E501
-
-        :param rfid_origin_dg: The rfid_origin_dg of this DocVisualExtendedField.  # noqa: E501
-        :type rfid_origin_dg: int
-        """
-
-        self._rfid_origin_dg = rfid_origin_dg
-
-    @property
-    def rfid_origin_tag_entry(self):
-        """Gets the rfid_origin_tag_entry of this DocVisualExtendedField.  # noqa: E501
-
-        Index of the text field record in origin data group. Only for Result.RFID_TEXT results.  # noqa: E501
-
-        :return: The rfid_origin_tag_entry of this DocVisualExtendedField.  # noqa: E501
-        :rtype: int
-        """
-        return self._rfid_origin_tag_entry
-
-    @rfid_origin_tag_entry.setter
-    def rfid_origin_tag_entry(self, rfid_origin_tag_entry):
-        """Sets the rfid_origin_tag_entry of this DocVisualExtendedField.
-
-        Index of the text field record in origin data group. Only for Result.RFID_TEXT results.  # noqa: E501
-
-        :param rfid_origin_tag_entry: The rfid_origin_tag_entry of this DocVisualExtendedField.  # noqa: E501
-        :type rfid_origin_tag_entry: int
-        """
-
-        self._rfid_origin_tag_entry = rfid_origin_tag_entry
-
-    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, DocVisualExtendedField):
-            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, DocVisualExtendedField):
-            return True
 
-        return self.to_dict() != other.to_dict()

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