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

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

@@ -4,146 +4,78 @@
     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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+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 PerDocumentConfig(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.
+class PerDocumentConfig(BaseModel):
     """
-    openapi_types = {
-        'doc_id': 'list[int]',
-        'exclude_auth_checks': 'int'
-    }
-
-    attribute_map = {
-        'doc_id': 'docID',
-        'exclude_auth_checks': 'excludeAuthChecks'
-    }
-
-    def __init__(self, doc_id=None, exclude_auth_checks=None, local_vars_configuration=None):  # noqa: E501
-        """PerDocumentConfig - 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._doc_id = None
-        self._exclude_auth_checks = None
-        self.discriminator = None
-
-        if doc_id is not None:
-            self.doc_id = doc_id
-        if exclude_auth_checks is not None:
-            self.exclude_auth_checks = exclude_auth_checks
-
-    @property
-    def doc_id(self):
-        """Gets the doc_id of this PerDocumentConfig.  # noqa: E501
-
-        Specific template IDs, for which apply current custom configuration  # noqa: E501
-
-        :return: The doc_id of this PerDocumentConfig.  # noqa: E501
-        :rtype: list[int]
+    PerDocumentConfig
+    """ # noqa: E501
+    doc_id: Optional[List[StrictInt]] = Field(default=None, description="Specific template IDs, for which apply current custom configuration", alias="docID")
+    exclude_auth_checks: Optional[StrictInt] = Field(default=None, description="Contains items from AuthenticityResultType as sum via OR operation", alias="excludeAuthChecks")
+    __properties: ClassVar[List[str]] = ["docID", "excludeAuthChecks"]
+
+    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 PerDocumentConfig 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._doc_id
+        excluded_fields: Set[str] = set([
+        ])
 
-    @doc_id.setter
-    def doc_id(self, doc_id):
-        """Sets the doc_id of this PerDocumentConfig.
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
 
-        Specific template IDs, for which apply current custom configuration  # noqa: E501
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PerDocumentConfig from a dict"""
+        if obj is None:
+            return None
 
-        :param doc_id: The doc_id of this PerDocumentConfig.  # noqa: E501
-        :type doc_id: list[int]
-        """
-
-        self._doc_id = doc_id
-
-    @property
-    def exclude_auth_checks(self):
-        """Gets the exclude_auth_checks of this PerDocumentConfig.  # noqa: E501
-
-        Contains items from AuthenticityResultType as sum via OR operation  # noqa: E501
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
 
-        :return: The exclude_auth_checks of this PerDocumentConfig.  # noqa: E501
-        :rtype: int
-        """
-        return self._exclude_auth_checks
-
-    @exclude_auth_checks.setter
-    def exclude_auth_checks(self, exclude_auth_checks):
-        """Sets the exclude_auth_checks of this PerDocumentConfig.
+        _obj = cls.model_validate({
+            "docID": obj.get("docID"),
+            "excludeAuthChecks": obj.get("excludeAuthChecks")
+        })
+        return _obj
 
-        Contains items from AuthenticityResultType as sum via OR operation  # noqa: E501
-
-        :param exclude_auth_checks: The exclude_auth_checks of this PerDocumentConfig.  # noqa: E501
-        :type exclude_auth_checks: int
-        """
 
-        self._exclude_auth_checks = exclude_auth_checks
-
-    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, PerDocumentConfig):
-            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, PerDocumentConfig):
-            return True
-
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,110 @@
+# 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 regula.documentreader.webclient.gen.models.image_data import ImageData
+from regula.documentreader.webclient.gen.models.light import Light
+from regula.documentreader.webclient.gen.models.raw_image_container_list import RawImageContainerList
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PhotoIdentItem(BaseModel):
+    """
+    PhotoIdentItem
+    """ # noqa: E501
+    light_index: Light = Field(alias="LightIndex")
+    area: RectangleCoordinates = Field(alias="Area")
+    source_image: ImageData = Field(alias="SourceImage")
+    result_images: RawImageContainerList = Field(alias="ResultImages")
+    field_types_count: Optional[StrictInt] = Field(default=None, alias="FieldTypesCount")
+    field_types_list: Optional[List[StrictInt]] = Field(default=None, alias="FieldTypesList")
+    step: Optional[StrictInt] = Field(default=None, alias="Step")
+    angle: Optional[StrictInt] = Field(default=None, alias="Angle")
+    result: Optional[StrictInt] = Field(default=None, alias="Result")
+    reserved3: Optional[StrictInt] = Field(default=None, alias="Reserved3")
+    __properties: ClassVar[List[str]] = ["LightIndex", "Area", "SourceImage", "ResultImages", "FieldTypesCount", "FieldTypesList", "Step", "Angle", "Result", "Reserved3"]
+
+    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 PhotoIdentItem 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 area
+        if self.area:
+            _dict['Area'] = self.area.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of source_image
+        if self.source_image:
+            _dict['SourceImage'] = self.source_image.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of result_images
+        if self.result_images:
+            _dict['ResultImages'] = self.result_images.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PhotoIdentItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "LightIndex": obj.get("LightIndex"),
+            "Area": RectangleCoordinates.from_dict(obj["Area"]) if obj.get("Area") is not None else None,
+            "SourceImage": ImageData.from_dict(obj["SourceImage"]) if obj.get("SourceImage") is not None else None,
+            "ResultImages": RawImageContainerList.from_dict(obj["ResultImages"]) if obj.get("ResultImages") is not None else None,
+            "FieldTypesCount": obj.get("FieldTypesCount"),
+            "FieldTypesList": obj.get("FieldTypesList"),
+            "Step": obj.get("Step"),
+            "Angle": obj.get("Angle"),
+            "Result": obj.get("Result"),
+            "Reserved3": obj.get("Reserved3")
+        })
+        return _obj
+
+