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

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

@@ -4,350 +4,111 @@
     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 PArrayField(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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.barcode_type import BarcodeType
+from regula.documentreader.webclient.gen.models.bc_pdf417_info import BcPDF417INFO
+from regula.documentreader.webclient.gen.models.bc_roidetect import BcROIDETECT
+from regula.documentreader.webclient.gen.models.data_module import DataModule
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PArrayField(BaseModel):
     """
-    openapi_types = {
-        'bc_angle_detect': 'float',
-        'bc_code_result': 'int',
-        'bc_count_module': 'int',
-        'bc_data_module': 'list[DataModule]',
-        'bc_pdf417_info': 'BcPDF417INFO',
-        'bc_roi_detect': 'BcROIDETECT',
-        'bc_text_decoder_types': 'int',
-        'bc_text_field_type': 'int',
-        'bc_type_decode': 'int',
-        'bc_type_detect': 'int'
-    }
-
-    attribute_map = {
-        'bc_angle_detect': 'bcAngle_DETECT',
-        'bc_code_result': 'bcCodeResult',
-        'bc_count_module': 'bcCountModule',
-        'bc_data_module': 'bcDataModule',
-        'bc_pdf417_info': 'bcPDF417INFO',
-        'bc_roi_detect': 'bcROI_DETECT',
-        'bc_text_decoder_types': 'bcTextDecoderTypes',
-        'bc_text_field_type': 'bcTextFieldType',
-        'bc_type_decode': 'bcType_DECODE',
-        'bc_type_detect': 'bcType_DETECT'
-    }
-
-    def __init__(self, bc_angle_detect=None, bc_code_result=None, bc_count_module=None, bc_data_module=None, bc_pdf417_info=None, bc_roi_detect=None, bc_text_decoder_types=None, bc_text_field_type=None, bc_type_decode=None, bc_type_detect=None, local_vars_configuration=None):  # noqa: E501
-        """PArrayField - 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._bc_angle_detect = None
-        self._bc_code_result = None
-        self._bc_count_module = None
-        self._bc_data_module = None
-        self._bc_pdf417_info = None
-        self._bc_roi_detect = None
-        self._bc_text_decoder_types = None
-        self._bc_text_field_type = None
-        self._bc_type_decode = None
-        self._bc_type_detect = None
-        self.discriminator = None
-
-        if bc_angle_detect is not None:
-            self.bc_angle_detect = bc_angle_detect
-        if bc_code_result is not None:
-            self.bc_code_result = bc_code_result
-        if bc_count_module is not None:
-            self.bc_count_module = bc_count_module
-        if bc_data_module is not None:
-            self.bc_data_module = bc_data_module
-        if bc_pdf417_info is not None:
-            self.bc_pdf417_info = bc_pdf417_info
-        if bc_roi_detect is not None:
-            self.bc_roi_detect = bc_roi_detect
-        if bc_text_decoder_types is not None:
-            self.bc_text_decoder_types = bc_text_decoder_types
-        if bc_text_field_type is not None:
-            self.bc_text_field_type = bc_text_field_type
-        if bc_type_decode is not None:
-            self.bc_type_decode = bc_type_decode
-        if bc_type_detect is not None:
-            self.bc_type_detect = bc_type_detect
-
-    @property
-    def bc_angle_detect(self):
-        """Gets the bc_angle_detect of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_angle_detect of this PArrayField.  # noqa: E501
-        :rtype: float
-        """
-        return self._bc_angle_detect
-
-    @bc_angle_detect.setter
-    def bc_angle_detect(self, bc_angle_detect):
-        """Sets the bc_angle_detect of this PArrayField.
-
-
-        :param bc_angle_detect: The bc_angle_detect of this PArrayField.  # noqa: E501
-        :type bc_angle_detect: float
-        """
-
-        self._bc_angle_detect = bc_angle_detect
-
-    @property
-    def bc_code_result(self):
-        """Gets the bc_code_result of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_code_result of this PArrayField.  # noqa: E501
-        :rtype: int
-        """
-        return self._bc_code_result
-
-    @bc_code_result.setter
-    def bc_code_result(self, bc_code_result):
-        """Sets the bc_code_result of this PArrayField.
-
-
-        :param bc_code_result: The bc_code_result of this PArrayField.  # noqa: E501
-        :type bc_code_result: int
-        """
-
-        self._bc_code_result = bc_code_result
-
-    @property
-    def bc_count_module(self):
-        """Gets the bc_count_module of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_count_module of this PArrayField.  # noqa: E501
-        :rtype: int
-        """
-        return self._bc_count_module
-
-    @bc_count_module.setter
-    def bc_count_module(self, bc_count_module):
-        """Sets the bc_count_module of this PArrayField.
-
-
-        :param bc_count_module: The bc_count_module of this PArrayField.  # noqa: E501
-        :type bc_count_module: int
-        """
-
-        self._bc_count_module = bc_count_module
-
-    @property
-    def bc_data_module(self):
-        """Gets the bc_data_module of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_data_module of this PArrayField.  # noqa: E501
-        :rtype: list[DataModule]
-        """
-        return self._bc_data_module
-
-    @bc_data_module.setter
-    def bc_data_module(self, bc_data_module):
-        """Sets the bc_data_module of this PArrayField.
-
-
-        :param bc_data_module: The bc_data_module of this PArrayField.  # noqa: E501
-        :type bc_data_module: list[DataModule]
-        """
-
-        self._bc_data_module = bc_data_module
-
-    @property
-    def bc_pdf417_info(self):
-        """Gets the bc_pdf417_info of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_pdf417_info of this PArrayField.  # noqa: E501
-        :rtype: BcPDF417INFO
-        """
-        return self._bc_pdf417_info
-
-    @bc_pdf417_info.setter
-    def bc_pdf417_info(self, bc_pdf417_info):
-        """Sets the bc_pdf417_info of this PArrayField.
-
-
-        :param bc_pdf417_info: The bc_pdf417_info of this PArrayField.  # noqa: E501
-        :type bc_pdf417_info: BcPDF417INFO
-        """
-
-        self._bc_pdf417_info = bc_pdf417_info
-
-    @property
-    def bc_roi_detect(self):
-        """Gets the bc_roi_detect of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_roi_detect of this PArrayField.  # noqa: E501
-        :rtype: BcROIDETECT
-        """
-        return self._bc_roi_detect
-
-    @bc_roi_detect.setter
-    def bc_roi_detect(self, bc_roi_detect):
-        """Sets the bc_roi_detect of this PArrayField.
-
-
-        :param bc_roi_detect: The bc_roi_detect of this PArrayField.  # noqa: E501
-        :type bc_roi_detect: BcROIDETECT
-        """
-
-        self._bc_roi_detect = bc_roi_detect
-
-    @property
-    def bc_text_decoder_types(self):
-        """Gets the bc_text_decoder_types of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_text_decoder_types of this PArrayField.  # noqa: E501
-        :rtype: int
-        """
-        return self._bc_text_decoder_types
-
-    @bc_text_decoder_types.setter
-    def bc_text_decoder_types(self, bc_text_decoder_types):
-        """Sets the bc_text_decoder_types of this PArrayField.
-
-
-        :param bc_text_decoder_types: The bc_text_decoder_types of this PArrayField.  # noqa: E501
-        :type bc_text_decoder_types: int
-        """
-
-        self._bc_text_decoder_types = bc_text_decoder_types
-
-    @property
-    def bc_text_field_type(self):
-        """Gets the bc_text_field_type of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_text_field_type of this PArrayField.  # noqa: E501
-        :rtype: int
-        """
-        return self._bc_text_field_type
-
-    @bc_text_field_type.setter
-    def bc_text_field_type(self, bc_text_field_type):
-        """Sets the bc_text_field_type of this PArrayField.
-
-
-        :param bc_text_field_type: The bc_text_field_type of this PArrayField.  # noqa: E501
-        :type bc_text_field_type: int
-        """
-
-        self._bc_text_field_type = bc_text_field_type
-
-    @property
-    def bc_type_decode(self):
-        """Gets the bc_type_decode of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_type_decode of this PArrayField.  # noqa: E501
-        :rtype: int
-        """
-        return self._bc_type_decode
-
-    @bc_type_decode.setter
-    def bc_type_decode(self, bc_type_decode):
-        """Sets the bc_type_decode of this PArrayField.
-
-
-        :param bc_type_decode: The bc_type_decode of this PArrayField.  # noqa: E501
-        :type bc_type_decode: int
-        """
-
-        self._bc_type_decode = bc_type_decode
-
-    @property
-    def bc_type_detect(self):
-        """Gets the bc_type_detect of this PArrayField.  # noqa: E501
-
-
-        :return: The bc_type_detect of this PArrayField.  # noqa: E501
-        :rtype: int
-        """
-        return self._bc_type_detect
-
-    @bc_type_detect.setter
-    def bc_type_detect(self, bc_type_detect):
-        """Sets the bc_type_detect of this PArrayField.
-
-
-        :param bc_type_detect: The bc_type_detect of this PArrayField.  # noqa: E501
-        :type bc_type_detect: int
-        """
-
-        self._bc_type_detect = bc_type_detect
-
-    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, PArrayField):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    PArrayField
+    """ # noqa: E501
+    bc_angle_detect: Union[StrictFloat, StrictInt] = Field(alias="bcAngle_DETECT")
+    bc_code_result: StrictInt = Field(alias="bcCodeResult")
+    bc_count_module: StrictInt = Field(alias="bcCountModule")
+    bc_data_module: List[DataModule] = Field(alias="bcDataModule")
+    bc_pdf417_info: Optional[BcPDF417INFO] = Field(default=None, alias="bcPDF417INFO")
+    bc_roi_detect: BcROIDETECT = Field(alias="bcROI_DETECT")
+    bc_text_decoder_types: Optional[StrictInt] = Field(default=None, alias="bcTextDecoderTypes")
+    bc_text_field_type: Optional[StrictInt] = Field(default=None, alias="bcTextFieldType")
+    bc_type_decode: BarcodeType = Field(alias="bcType_DECODE")
+    bc_type_detect: StrictInt = Field(alias="bcType_DETECT")
+    __properties: ClassVar[List[str]] = ["bcAngle_DETECT", "bcCodeResult", "bcCountModule", "bcDataModule", "bcPDF417INFO", "bcROI_DETECT", "bcTextDecoderTypes", "bcTextFieldType", "bcType_DECODE", "bcType_DETECT"]
+
+    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 PArrayField 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 bc_data_module (list)
+        _items = []
+        if self.bc_data_module:
+            for _item_bc_data_module in self.bc_data_module:
+                if _item_bc_data_module:
+                    _items.append(_item_bc_data_module.to_dict())
+            _dict['bcDataModule'] = _items
+        # override the default output from pydantic by calling `to_dict()` of bc_pdf417_info
+        if self.bc_pdf417_info:
+            _dict['bcPDF417INFO'] = self.bc_pdf417_info.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of bc_roi_detect
+        if self.bc_roi_detect:
+            _dict['bcROI_DETECT'] = self.bc_roi_detect.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PArrayField from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "bcAngle_DETECT": obj.get("bcAngle_DETECT"),
+            "bcCodeResult": obj.get("bcCodeResult"),
+            "bcCountModule": obj.get("bcCountModule"),
+            "bcDataModule": [DataModule.from_dict(_item) for _item in obj["bcDataModule"]] if obj.get("bcDataModule") is not None else None,
+            "bcPDF417INFO": BcPDF417INFO.from_dict(obj["bcPDF417INFO"]) if obj.get("bcPDF417INFO") is not None else None,
+            "bcROI_DETECT": BcROIDETECT.from_dict(obj["bcROI_DETECT"]) if obj.get("bcROI_DETECT") is not None else None,
+            "bcTextDecoderTypes": obj.get("bcTextDecoderTypes"),
+            "bcTextFieldType": obj.get("bcTextFieldType"),
+            "bcType_DECODE": obj.get("bcType_DECODE"),
+            "bcType_DETECT": obj.get("bcType_DETECT")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, PArrayField):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,79 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ParsedData(BaseModel):
+    """
+    ParsedData
+    """ # noqa: E501
+    parsing_notifications: Optional[List[StrictInt]] = Field(default=None, alias="ParsingNotifications")
+    __properties: ClassVar[List[str]] = ["ParsingNotifications"]
+
+    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 ParsedData 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ParsedData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ParsingNotifications": obj.get("ParsingNotifications")
+        })
+        return _obj
+
+