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

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

@@ -4,307 +4,116 @@
     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 TransactionProcessRequest(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, 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.process_params import ProcessParams
+from regula.documentreader.webclient.gen.models.process_request_image import ProcessRequestImage
+from regula.documentreader.webclient.gen.models.process_system_info import ProcessSystemInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TransactionProcessRequest(BaseModel):
     """
-    openapi_types = {
-        'process_param': 'ProcessParams',
-        'list': 'list[ProcessRequestImage]',
-        'live_portrait': 'str',
-        'ext_portrait': 'str',
-        'container_list': 'ContainerList',
-        'system_info': 'ProcessSystemInfo',
-        'pass_back_object': 'dict(str, object)',
-        'dtc': 'str'
-    }
-
-    attribute_map = {
-        'process_param': 'processParam',
-        'list': 'List',
-        'live_portrait': 'livePortrait',
-        'ext_portrait': 'extPortrait',
-        'container_list': 'ContainerList',
-        'system_info': 'systemInfo',
-        'pass_back_object': 'passBackObject',
-        'dtc': 'dtc'
-    }
-
-    def __init__(self, process_param=None, list=None, live_portrait=None, ext_portrait=None, container_list=None, system_info=None, pass_back_object=None, dtc=None, local_vars_configuration=None):  # noqa: E501
-        """TransactionProcessRequest - 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._process_param = None
-        self._list = None
-        self._live_portrait = None
-        self._ext_portrait = None
-        self._container_list = None
-        self._system_info = None
-        self._pass_back_object = None
-        self._dtc = None
-        self.discriminator = None
-
-        self.process_param = process_param
-        if list is not None:
-            self.list = list
-        if live_portrait is not None:
-            self.live_portrait = live_portrait
-        if ext_portrait is not None:
-            self.ext_portrait = ext_portrait
-        if container_list is not None:
-            self.container_list = container_list
-        if system_info is not None:
-            self.system_info = system_info
-        if pass_back_object is not None:
-            self.pass_back_object = pass_back_object
-        if dtc is not None:
-            self.dtc = dtc
-
-    @property
-    def process_param(self):
-        """Gets the process_param of this TransactionProcessRequest.  # noqa: E501
-
-
-        :return: The process_param of this TransactionProcessRequest.  # noqa: E501
-        :rtype: ProcessParams
-        """
-        return self._process_param
-
-    @process_param.setter
-    def process_param(self, process_param):
-        """Sets the process_param of this TransactionProcessRequest.
-
-
-        :param process_param: The process_param of this TransactionProcessRequest.  # noqa: E501
-        :type process_param: ProcessParams
-        """
-        if self.local_vars_configuration.client_side_validation and process_param is None:  # noqa: E501
-            raise ValueError("Invalid value for `process_param`, must not be `None`")  # noqa: E501
-
-        self._process_param = process_param
-
-    @property
-    def list(self):
-        """Gets the list of this TransactionProcessRequest.  # noqa: E501
-
-
-        :return: The list of this TransactionProcessRequest.  # noqa: E501
-        :rtype: list[ProcessRequestImage]
-        """
-        return self._list
-
-    @list.setter
-    def list(self, list):
-        """Sets the list of this TransactionProcessRequest.
-
-
-        :param list: The list of this TransactionProcessRequest.  # noqa: E501
-        :type list: list[ProcessRequestImage]
-        """
-
-        self._list = list
-
-    @property
-    def live_portrait(self):
-        """Gets the live_portrait of this TransactionProcessRequest.  # noqa: E501
-
-        Live portrait photo  # noqa: E501
-
-        :return: The live_portrait of this TransactionProcessRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._live_portrait
-
-    @live_portrait.setter
-    def live_portrait(self, live_portrait):
-        """Sets the live_portrait of this TransactionProcessRequest.
-
-        Live portrait photo  # noqa: E501
-
-        :param live_portrait: The live_portrait of this TransactionProcessRequest.  # noqa: E501
-        :type live_portrait: str
-        """
-
-        self._live_portrait = live_portrait
-
-    @property
-    def ext_portrait(self):
-        """Gets the ext_portrait of this TransactionProcessRequest.  # noqa: E501
-
-        Portrait photo from an external source  # noqa: E501
-
-        :return: The ext_portrait of this TransactionProcessRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._ext_portrait
-
-    @ext_portrait.setter
-    def ext_portrait(self, ext_portrait):
-        """Sets the ext_portrait of this TransactionProcessRequest.
-
-        Portrait photo from an external source  # noqa: E501
-
-        :param ext_portrait: The ext_portrait of this TransactionProcessRequest.  # noqa: E501
-        :type ext_portrait: str
-        """
-
-        self._ext_portrait = ext_portrait
-
-    @property
-    def container_list(self):
-        """Gets the container_list of this TransactionProcessRequest.  # noqa: E501
-
-
-        :return: The container_list of this TransactionProcessRequest.  # noqa: E501
-        :rtype: ContainerList
-        """
-        return self._container_list
-
-    @container_list.setter
-    def container_list(self, container_list):
-        """Sets the container_list of this TransactionProcessRequest.
-
-
-        :param container_list: The container_list of this TransactionProcessRequest.  # noqa: E501
-        :type container_list: ContainerList
-        """
-
-        self._container_list = container_list
-
-    @property
-    def system_info(self):
-        """Gets the system_info of this TransactionProcessRequest.  # noqa: E501
-
-
-        :return: The system_info of this TransactionProcessRequest.  # noqa: E501
-        :rtype: ProcessSystemInfo
-        """
-        return self._system_info
-
-    @system_info.setter
-    def system_info(self, system_info):
-        """Sets the system_info of this TransactionProcessRequest.
-
-
-        :param system_info: The system_info of this TransactionProcessRequest.  # noqa: E501
-        :type system_info: ProcessSystemInfo
-        """
-
-        self._system_info = system_info
-
-    @property
-    def pass_back_object(self):
-        """Gets the pass_back_object of this TransactionProcessRequest.  # noqa: E501
-
-        Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.  # noqa: E501
-
-        :return: The pass_back_object of this TransactionProcessRequest.  # 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 TransactionProcessRequest.
-
-        Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.  # noqa: E501
-
-        :param pass_back_object: The pass_back_object of this TransactionProcessRequest.  # noqa: E501
-        :type pass_back_object: dict(str, object)
-        """
-
-        self._pass_back_object = pass_back_object
-
-    @property
-    def dtc(self):
-        """Gets the dtc of this TransactionProcessRequest.  # noqa: E501
-
-        Digital Travel Credential (DTC-VC) data in base64 format for processing  # noqa: E501
-
-        :return: The dtc of this TransactionProcessRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._dtc
-
-    @dtc.setter
-    def dtc(self, dtc):
-        """Sets the dtc of this TransactionProcessRequest.
-
-        Digital Travel Credential (DTC-VC) data in base64 format for processing  # noqa: E501
-
-        :param dtc: The dtc of this TransactionProcessRequest.  # noqa: E501
-        :type dtc: str
-        """
-
-        self._dtc = dtc
-
-    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, TransactionProcessRequest):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    TransactionProcessRequest
+    """ # noqa: E501
+    process_param: ProcessParams = Field(alias="processParam")
+    list: Optional[List[ProcessRequestImage]] = Field(default=None, alias="List")
+    tag: Optional[StrictStr] = Field(default=None, description="Session ID")
+    tenant: Optional[StrictStr] = Field(default=None, description="Customer name")
+    env: Optional[StrictStr] = Field(default=None, description="Environment type")
+    live_portrait: Optional[StrictStr] = Field(default=None, description="Live portrait photo", alias="livePortrait")
+    ext_portrait: Optional[StrictStr] = Field(default=None, description="Portrait photo from an external source", alias="extPortrait")
+    container_list: Optional[ContainerList] = Field(default=None, alias="ContainerList")
+    system_info: Optional[ProcessSystemInfo] = Field(default=None, alias="systemInfo")
+    pass_back_object: Optional[Dict[str, Any]] = Field(default=None, description="Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.", alias="passBackObject")
+    dtc: Optional[StrictStr] = Field(default=None, description="Digital Travel Credential (DTC-VC) data in base64 format for processing")
+    __properties: ClassVar[List[str]] = ["processParam", "List", "tag", "tenant", "env", "livePortrait", "extPortrait", "ContainerList", "systemInfo", "passBackObject", "dtc"]
+
+    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 TransactionProcessRequest 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 process_param
+        if self.process_param:
+            _dict['processParam'] = self.process_param.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in list (list)
+        _items = []
+        if self.list:
+            for _item_list in self.list:
+                if _item_list:
+                    _items.append(_item_list.to_dict())
+            _dict['List'] = _items
+        # 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 system_info
+        if self.system_info:
+            _dict['systemInfo'] = self.system_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TransactionProcessRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "processParam": ProcessParams.from_dict(obj["processParam"]) if obj.get("processParam") is not None else None,
+            "List": [ProcessRequestImage.from_dict(_item) for _item in obj["List"]] if obj.get("List") is not None else None,
+            "tag": obj.get("tag"),
+            "tenant": obj.get("tenant"),
+            "env": obj.get("env"),
+            "livePortrait": obj.get("livePortrait"),
+            "extPortrait": obj.get("extPortrait"),
+            "ContainerList": ContainerList.from_dict(obj["ContainerList"]) if obj.get("ContainerList") is not None else None,
+            "systemInfo": ProcessSystemInfo.from_dict(obj["systemInfo"]) if obj.get("systemInfo") is not None else None,
+            "passBackObject": obj.get("passBackObject"),
+            "dtc": obj.get("dtc")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, TransactionProcessRequest):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,107 @@
+# 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, 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 TransactionProcessResponse(BaseModel):
+    """
+    TransactionProcessResponse
+    """ # noqa: E501
+    chip_page: RfidLocation = Field(alias="ChipPage")
+    core_lib_result_code: StrictInt = Field(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 TransactionProcessResponse 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 TransactionProcessResponse 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
+
+

regula/documentreader/webclient/gen/models/transaction_process_response_item.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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TransactionProcessResponseItem(BaseModel):
+    """
+    TransactionProcessResponseItem
+    """ # noqa: E501
+    core_lib_result_code: StrictInt = Field(alias="CoreLibResultCode")
+    __properties: ClassVar[List[str]] = ["CoreLibResultCode"]
+
+    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 TransactionProcessResponseItem 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 TransactionProcessResponseItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "CoreLibResultCode": obj.get("CoreLibResultCode")
+        })
+        return _obj
+
+