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

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

@@ -4,170 +4,85 @@
     Generated by: https://openapi-generator.tech
 """
 
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
+import json
 
-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 ProcessRequestImage(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.image_data import ImageData
+from regula.documentreader.webclient.gen.models.light import Light
+from typing import Optional, Set
+from typing_extensions import Self
 
+class ProcessRequestImage(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 = {
-        'image_data': 'ImageData',
-        'light': 'Light',
-        'page_idx': 'int'
-    }
-
-    attribute_map = {
-        'image_data': 'ImageData',
-        'light': 'light',
-        'page_idx': 'page_idx'
-    }
-
-    def __init__(self, image_data=None, light=None, page_idx=None, local_vars_configuration=None):  # noqa: E501
-        """ProcessRequestImage - 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._image_data = None
-        self._light = None
-        self._page_idx = None
-        self.discriminator = None
-
-        if image_data is not None:
-            self.image_data = image_data
-        if light is not None:
-            self.light = light
-        if page_idx is not None:
-            self.page_idx = page_idx
-
-    @property
-    def image_data(self):
-        """Gets the image_data of this ProcessRequestImage.  # noqa: E501
-
-
-        :return: The image_data of this ProcessRequestImage.  # noqa: E501
-        :rtype: ImageData
-        """
-        return self._image_data
-
-    @image_data.setter
-    def image_data(self, image_data):
-        """Sets the image_data of this ProcessRequestImage.
-
-
-        :param image_data: The image_data of this ProcessRequestImage.  # noqa: E501
-        :type image_data: ImageData
-        """
-
-        self._image_data = image_data
-
-    @property
-    def light(self):
-        """Gets the light of this ProcessRequestImage.  # noqa: E501
-
-
-        :return: The light of this ProcessRequestImage.  # noqa: E501
-        :rtype: Light
-        """
-        return self._light
-
-    @light.setter
-    def light(self, light):
-        """Sets the light of this ProcessRequestImage.
-
-
-        :param light: The light of this ProcessRequestImage.  # noqa: E501
-        :type light: Light
+    ProcessRequestImage
+    """ # noqa: E501
+    image_data: Optional[ImageData] = Field(default=None, alias="ImageData")
+    light: Optional[Light] = None
+    page_idx: Optional[StrictInt] = Field(default=None, description="page/image number")
+    __properties: ClassVar[List[str]] = ["ImageData", "light", "page_idx"]
+
+    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 ProcessRequestImage 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 image_data
+        if self.image_data:
+            _dict['ImageData'] = self.image_data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProcessRequestImage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ImageData": ImageData.from_dict(obj["ImageData"]) if obj.get("ImageData") is not None else None,
+            "light": obj.get("light"),
+            "page_idx": obj.get("page_idx")
+        })
+        return _obj
 
-        self._light = light
-
-    @property
-    def page_idx(self):
-        """Gets the page_idx of this ProcessRequestImage.  # noqa: E501
-
-        page/image number  # noqa: E501
-
-        :return: The page_idx of this ProcessRequestImage.  # noqa: E501
-        :rtype: int
-        """
-        return self._page_idx
-
-    @page_idx.setter
-    def page_idx(self, page_idx):
-        """Sets the page_idx of this ProcessRequestImage.
-
-        page/image number  # noqa: E501
-
-        :param page_idx: The page_idx of this ProcessRequestImage.  # noqa: E501
-        :type page_idx: int
-        """
 
-        self._page_idx = page_idx
-
-    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, ProcessRequestImage):
-            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, ProcessRequestImage):
-            return True
-
-        return self.to_dict() != other.to_dict()

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

@@ -4,307 +4,104 @@
     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 ProcessResponse(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 regula.documentreader.webclient.gen.models.container_list import ContainerList
+from regula.documentreader.webclient.gen.models.processing_status import ProcessingStatus
+from regula.documentreader.webclient.gen.models.rfid_location import RfidLocation
+from regula.documentreader.webclient.gen.models.transaction_info import TransactionInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ProcessResponse(BaseModel):
     """
-    openapi_types = {
-        'chip_page': 'RfidLocation',
-        'processing_finished': 'ProcessingStatus',
-        'container_list': 'ContainerList',
-        'transaction_info': 'TransactionInfo',
-        'log': 'str',
-        'pass_back_object': 'dict(str, object)',
-        'more_pages_available': 'int',
-        'elapsed_time': 'int'
-    }
-
-    attribute_map = {
-        'chip_page': 'ChipPage',
-        'processing_finished': 'ProcessingFinished',
-        'container_list': 'ContainerList',
-        'transaction_info': 'TransactionInfo',
-        'log': 'log',
-        'pass_back_object': 'passBackObject',
-        'more_pages_available': 'morePagesAvailable',
-        'elapsed_time': 'elapsedTime'
-    }
-
-    def __init__(self, chip_page=None, processing_finished=None, container_list=None, transaction_info=None, log=None, pass_back_object=None, more_pages_available=None, elapsed_time=None, local_vars_configuration=None):  # noqa: E501
-        """ProcessResponse - 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._chip_page = None
-        self._processing_finished = None
-        self._container_list = None
-        self._transaction_info = None
-        self._log = None
-        self._pass_back_object = None
-        self._more_pages_available = None
-        self._elapsed_time = None
-        self.discriminator = None
-
-        if chip_page is not None:
-            self.chip_page = chip_page
-        self.processing_finished = processing_finished
-        self.container_list = container_list
-        self.transaction_info = transaction_info
-        if log is not None:
-            self.log = log
-        if pass_back_object is not None:
-            self.pass_back_object = pass_back_object
-        if more_pages_available is not None:
-            self.more_pages_available = more_pages_available
-        if elapsed_time is not None:
-            self.elapsed_time = elapsed_time
-
-    @property
-    def chip_page(self):
-        """Gets the chip_page of this ProcessResponse.  # noqa: E501
-
-
-        :return: The chip_page of this ProcessResponse.  # noqa: E501
-        :rtype: RfidLocation
-        """
-        return self._chip_page
-
-    @chip_page.setter
-    def chip_page(self, chip_page):
-        """Sets the chip_page of this ProcessResponse.
-
-
-        :param chip_page: The chip_page of this ProcessResponse.  # noqa: E501
-        :type chip_page: RfidLocation
-        """
-
-        self._chip_page = chip_page
-
-    @property
-    def processing_finished(self):
-        """Gets the processing_finished of this ProcessResponse.  # noqa: E501
-
-
-        :return: The processing_finished of this ProcessResponse.  # noqa: E501
-        :rtype: ProcessingStatus
-        """
-        return self._processing_finished
-
-    @processing_finished.setter
-    def processing_finished(self, processing_finished):
-        """Sets the processing_finished of this ProcessResponse.
-
-
-        :param processing_finished: The processing_finished of this ProcessResponse.  # noqa: E501
-        :type processing_finished: ProcessingStatus
-        """
-        if self.local_vars_configuration.client_side_validation and processing_finished is None:  # noqa: E501
-            raise ValueError("Invalid value for `processing_finished`, must not be `None`")  # noqa: E501
-
-        self._processing_finished = processing_finished
-
-    @property
-    def container_list(self):
-        """Gets the container_list of this ProcessResponse.  # noqa: E501
-
-
-        :return: The container_list of this ProcessResponse.  # noqa: E501
-        :rtype: ContainerList
-        """
-        return self._container_list
-
-    @container_list.setter
-    def container_list(self, container_list):
-        """Sets the container_list of this ProcessResponse.
-
-
-        :param container_list: The container_list of this ProcessResponse.  # noqa: E501
-        :type container_list: ContainerList
-        """
-        if self.local_vars_configuration.client_side_validation and container_list is None:  # noqa: E501
-            raise ValueError("Invalid value for `container_list`, must not be `None`")  # noqa: E501
-
-        self._container_list = container_list
-
-    @property
-    def transaction_info(self):
-        """Gets the transaction_info of this ProcessResponse.  # noqa: E501
-
-
-        :return: The transaction_info of this ProcessResponse.  # noqa: E501
-        :rtype: TransactionInfo
-        """
-        return self._transaction_info
-
-    @transaction_info.setter
-    def transaction_info(self, transaction_info):
-        """Sets the transaction_info of this ProcessResponse.
-
-
-        :param transaction_info: The transaction_info of this ProcessResponse.  # noqa: E501
-        :type transaction_info: TransactionInfo
-        """
-        if self.local_vars_configuration.client_side_validation and transaction_info is None:  # noqa: E501
-            raise ValueError("Invalid value for `transaction_info`, must not be `None`")  # noqa: E501
-
-        self._transaction_info = transaction_info
-
-    @property
-    def log(self):
-        """Gets the log of this ProcessResponse.  # noqa: E501
-
-        Base64 encoded transaction processing log  # noqa: E501
-
-        :return: The log of this ProcessResponse.  # noqa: E501
-        :rtype: str
-        """
-        return self._log
-
-    @log.setter
-    def log(self, log):
-        """Sets the log of this ProcessResponse.
-
-        Base64 encoded transaction processing log  # noqa: E501
-
-        :param log: The log of this ProcessResponse.  # noqa: E501
-        :type log: str
-        """
-
-        self._log = log
-
-    @property
-    def pass_back_object(self):
-        """Gets the pass_back_object of this ProcessResponse.  # noqa: E501
-
-        Free-form object provided in request. See passBackObject property of ProcessRequest.  # noqa: E501
-
-        :return: The pass_back_object of this ProcessResponse.  # noqa: E501
-        :rtype: dict(str, object)
-        """
-        return self._pass_back_object
-
-    @pass_back_object.setter
-    def pass_back_object(self, pass_back_object):
-        """Sets the pass_back_object of this ProcessResponse.
-
-        Free-form object provided in request. See passBackObject property of ProcessRequest.  # noqa: E501
-
-        :param pass_back_object: The pass_back_object of this ProcessResponse.  # noqa: E501
-        :type pass_back_object: dict(str, object)
-        """
-
-        self._pass_back_object = pass_back_object
-
-    @property
-    def more_pages_available(self):
-        """Gets the more_pages_available of this ProcessResponse.  # noqa: E501
-
-
-        :return: The more_pages_available of this ProcessResponse.  # noqa: E501
-        :rtype: int
-        """
-        return self._more_pages_available
-
-    @more_pages_available.setter
-    def more_pages_available(self, more_pages_available):
-        """Sets the more_pages_available of this ProcessResponse.
-
-
-        :param more_pages_available: The more_pages_available of this ProcessResponse.  # noqa: E501
-        :type more_pages_available: int
-        """
-
-        self._more_pages_available = more_pages_available
-
-    @property
-    def elapsed_time(self):
-        """Gets the elapsed_time of this ProcessResponse.  # noqa: E501
-
-        Time the document processing has taken, ms.  # noqa: E501
-
-        :return: The elapsed_time of this ProcessResponse.  # noqa: E501
-        :rtype: int
-        """
-        return self._elapsed_time
-
-    @elapsed_time.setter
-    def elapsed_time(self, elapsed_time):
-        """Sets the elapsed_time of this ProcessResponse.
-
-        Time the document processing has taken, ms.  # noqa: E501
-
-        :param elapsed_time: The elapsed_time of this ProcessResponse.  # noqa: E501
-        :type elapsed_time: int
-        """
-
-        self._elapsed_time = elapsed_time
-
-    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, ProcessResponse):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    ProcessResponse
+    """ # noqa: E501
+    chip_page: RfidLocation = Field(alias="ChipPage")
+    core_lib_result_code: Optional[StrictInt] = Field(default=None, alias="CoreLibResultCode")
+    processing_finished: ProcessingStatus = Field(alias="ProcessingFinished")
+    container_list: ContainerList = Field(alias="ContainerList")
+    transaction_info: TransactionInfo = Field(alias="TransactionInfo")
+    log: Optional[StrictStr] = Field(default=None, description="Base64 encoded transaction processing log")
+    pass_back_object: Optional[Dict[str, Any]] = Field(default=None, description="Free-form object provided in request. See passBackObject property of ProcessRequest.", alias="passBackObject")
+    more_pages_available: StrictInt = Field(alias="morePagesAvailable")
+    elapsed_time: StrictInt = Field(description="Time the document processing has taken, ms.", alias="elapsedTime")
+    metadata: Optional[Dict[str, Any]] = None
+    __properties: ClassVar[List[str]] = ["ChipPage", "CoreLibResultCode", "ProcessingFinished", "ContainerList", "TransactionInfo", "log", "passBackObject", "morePagesAvailable", "elapsedTime", "metadata"]
+
+    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 ProcessResponse 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 container_list
+        if self.container_list:
+            _dict['ContainerList'] = self.container_list.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of transaction_info
+        if self.transaction_info:
+            _dict['TransactionInfo'] = self.transaction_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProcessResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ChipPage": obj.get("ChipPage"),
+            "CoreLibResultCode": obj.get("CoreLibResultCode"),
+            "ProcessingFinished": obj.get("ProcessingFinished"),
+            "ContainerList": ContainerList.from_dict(obj["ContainerList"]) if obj.get("ContainerList") is not None else None,
+            "TransactionInfo": TransactionInfo.from_dict(obj["TransactionInfo"]) if obj.get("TransactionInfo") is not None else None,
+            "log": obj.get("log"),
+            "passBackObject": obj.get("passBackObject"),
+            "morePagesAvailable": obj.get("morePagesAvailable"),
+            "elapsedTime": obj.get("elapsedTime"),
+            "metadata": obj.get("metadata")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, ProcessResponse):
-            return True
 
-        return self.to_dict() != other.to_dict()