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

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

@@ -4,275 +4,97 @@
     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
+from typing import Any, ClassVar, Dict, List, Optional
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
+from regula.documentreader.webclient.gen.models.details_optical import DetailsOptical
+from regula.documentreader.webclient.gen.models.details_rfid import DetailsRFID
+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 Status(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class Status(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 = {
-        'overall_status': 'CheckResult',
-        'optical': 'CheckResult',
-        'portrait': 'CheckResult',
-        'rfid': 'CheckResult',
-        'stop_list': 'CheckResult',
-        'details_rfid': 'DetailsRFID',
-        'details_optical': 'DetailsOptical'
-    }
-
-    attribute_map = {
-        'overall_status': 'overallStatus',
-        'optical': 'optical',
-        'portrait': 'portrait',
-        'rfid': 'rfid',
-        'stop_list': 'stopList',
-        'details_rfid': 'detailsRFID',
-        'details_optical': 'detailsOptical'
-    }
-
-    def __init__(self, overall_status=None, optical=None, portrait=None, rfid=None, stop_list=None, details_rfid=None, details_optical=None, local_vars_configuration=None):  # noqa: E501
-        """Status - 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._overall_status = None
-        self._optical = None
-        self._portrait = None
-        self._rfid = None
-        self._stop_list = None
-        self._details_rfid = None
-        self._details_optical = None
-        self.discriminator = None
-
-        self.overall_status = overall_status
-        self.optical = optical
-        if portrait is not None:
-            self.portrait = portrait
-        if rfid is not None:
-            self.rfid = rfid
-        if stop_list is not None:
-            self.stop_list = stop_list
-        if details_rfid is not None:
-            self.details_rfid = details_rfid
-        self.details_optical = details_optical
-
-    @property
-    def overall_status(self):
-        """Gets the overall_status of this Status.  # noqa: E501
-
-
-        :return: The overall_status of this Status.  # noqa: E501
-        :rtype: CheckResult
-        """
-        return self._overall_status
-
-    @overall_status.setter
-    def overall_status(self, overall_status):
-        """Sets the overall_status of this Status.
-
-
-        :param overall_status: The overall_status of this Status.  # noqa: E501
-        :type overall_status: CheckResult
-        """
-        if self.local_vars_configuration.client_side_validation and overall_status is None:  # noqa: E501
-            raise ValueError("Invalid value for `overall_status`, must not be `None`")  # noqa: E501
-
-        self._overall_status = overall_status
-
-    @property
-    def optical(self):
-        """Gets the optical of this Status.  # noqa: E501
-
-
-        :return: The optical of this Status.  # noqa: E501
-        :rtype: CheckResult
-        """
-        return self._optical
-
-    @optical.setter
-    def optical(self, optical):
-        """Sets the optical of this Status.
-
-
-        :param optical: The optical of this Status.  # noqa: E501
-        :type optical: CheckResult
-        """
-        if self.local_vars_configuration.client_side_validation and optical is None:  # noqa: E501
-            raise ValueError("Invalid value for `optical`, must not be `None`")  # noqa: E501
-
-        self._optical = optical
-
-    @property
-    def portrait(self):
-        """Gets the portrait of this Status.  # noqa: E501
-
-
-        :return: The portrait of this Status.  # noqa: E501
-        :rtype: CheckResult
-        """
-        return self._portrait
-
-    @portrait.setter
-    def portrait(self, portrait):
-        """Sets the portrait of this Status.
-
-
-        :param portrait: The portrait of this Status.  # noqa: E501
-        :type portrait: CheckResult
-        """
-
-        self._portrait = portrait
-
-    @property
-    def rfid(self):
-        """Gets the rfid of this Status.  # noqa: E501
-
-
-        :return: The rfid of this Status.  # noqa: E501
-        :rtype: CheckResult
-        """
-        return self._rfid
-
-    @rfid.setter
-    def rfid(self, rfid):
-        """Sets the rfid of this Status.
-
-
-        :param rfid: The rfid of this Status.  # noqa: E501
-        :type rfid: CheckResult
-        """
-
-        self._rfid = rfid
-
-    @property
-    def stop_list(self):
-        """Gets the stop_list of this Status.  # noqa: E501
-
-
-        :return: The stop_list of this Status.  # noqa: E501
-        :rtype: CheckResult
+    Status
+    """ # noqa: E501
+    overall_status: CheckResult = Field(alias="overallStatus")
+    optical: CheckResult
+    portrait: CheckResult
+    rfid: CheckResult
+    stop_list: CheckResult = Field(alias="stopList")
+    details_rfid: Optional[DetailsRFID] = Field(default=None, alias="detailsRFID")
+    details_optical: DetailsOptical = Field(alias="detailsOptical")
+    __properties: ClassVar[List[str]] = ["overallStatus", "optical", "portrait", "rfid", "stopList", "detailsRFID", "detailsOptical"]
+
+    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 Status 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._stop_list
-
-    @stop_list.setter
-    def stop_list(self, stop_list):
-        """Sets the stop_list of this Status.
-
-
-        :param stop_list: The stop_list of this Status.  # noqa: E501
-        :type stop_list: CheckResult
-        """
-
-        self._stop_list = stop_list
-
-    @property
-    def details_rfid(self):
-        """Gets the details_rfid of this Status.  # noqa: E501
-
-
-        :return: The details_rfid of this Status.  # noqa: E501
-        :rtype: DetailsRFID
-        """
-        return self._details_rfid
-
-    @details_rfid.setter
-    def details_rfid(self, details_rfid):
-        """Sets the details_rfid of this Status.
-
-
-        :param details_rfid: The details_rfid of this Status.  # noqa: E501
-        :type details_rfid: DetailsRFID
-        """
-
-        self._details_rfid = details_rfid
-
-    @property
-    def details_optical(self):
-        """Gets the details_optical of this Status.  # noqa: E501
-
-
-        :return: The details_optical of this Status.  # noqa: E501
-        :rtype: DetailsOptical
-        """
-        return self._details_optical
-
-    @details_optical.setter
-    def details_optical(self, details_optical):
-        """Sets the details_optical of this Status.
-
-
-        :param details_optical: The details_optical of this Status.  # noqa: E501
-        :type details_optical: DetailsOptical
-        """
-        if self.local_vars_configuration.client_side_validation and details_optical is None:  # noqa: E501
-            raise ValueError("Invalid value for `details_optical`, must not be `None`")  # noqa: E501
-
-        self._details_optical = details_optical
-
-    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, Status):
-            return False
-
-        return self.to_dict() == other.to_dict()
+        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 details_rfid
+        if self.details_rfid:
+            _dict['detailsRFID'] = self.details_rfid.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of details_optical
+        if self.details_optical:
+            _dict['detailsOptical'] = self.details_optical.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Status from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "overallStatus": obj.get("overallStatus"),
+            "optical": obj.get("optical"),
+            "portrait": obj.get("portrait"),
+            "rfid": obj.get("rfid"),
+            "stopList": obj.get("stopList"),
+            "detailsRFID": DetailsRFID.from_dict(obj["detailsRFID"]) if obj.get("detailsRFID") is not None else None,
+            "detailsOptical": DetailsOptical.from_dict(obj["detailsOptical"]) if obj.get("detailsOptical") is not None else None
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, Status):
-            return True
 
-        return self.to_dict() != other.to_dict()

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