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

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

@@ -4,400 +4,101 @@
     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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
+from regula.documentreader.webclient.gen.models.document_type import DocumentType
+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 *
-
-
-"""
-Extended document type info and Regula's 'Information Reference Systems' links
-"""
-class FDSIDList(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 FDSIDList(BaseModel):
     """
-    openapi_types = {
-        'icao_code': 'str',
-        'list': 'list[int]',
-        'd_type': 'DocumentType',
-        'd_format': 'DocumentFormat',
-        'd_mrz': 'bool',
-        'd_description': 'str',
-        'd_year': 'str',
-        'd_country_name': 'str',
-        'd_state_code': 'str',
-        'd_state_name': 'str',
-        'is_deprecated': 'bool'
-    }
-
-    attribute_map = {
-        'icao_code': 'ICAOCode',
-        'list': 'List',
-        'd_type': 'dType',
-        'd_format': 'dFormat',
-        'd_mrz': 'dMRZ',
-        'd_description': 'dDescription',
-        'd_year': 'dYear',
-        'd_country_name': 'dCountryName',
-        'd_state_code': 'dStateCode',
-        'd_state_name': 'dStateName',
-        'is_deprecated': 'isDeprecated'
-    }
-
-    def __init__(self, icao_code=None, list=None, d_type=None, d_format=None, d_mrz=None, d_description=None, d_year=None, d_country_name=None, d_state_code=None, d_state_name=None, is_deprecated=None, local_vars_configuration=None):  # noqa: E501
-        """FDSIDList - 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._icao_code = None
-        self._list = None
-        self._d_type = None
-        self._d_format = None
-        self._d_mrz = None
-        self._d_description = None
-        self._d_year = None
-        self._d_country_name = None
-        self._d_state_code = None
-        self._d_state_name = None
-        self._is_deprecated = None
-        self.discriminator = None
-
-        if icao_code is not None:
-            self.icao_code = icao_code
-        if list is not None:
-            self.list = list
-        if d_type is not None:
-            self.d_type = d_type
-        if d_format is not None:
-            self.d_format = d_format
-        if d_mrz is not None:
-            self.d_mrz = d_mrz
-        if d_description is not None:
-            self.d_description = d_description
-        if d_year is not None:
-            self.d_year = d_year
-        if d_country_name is not None:
-            self.d_country_name = d_country_name
-        if d_state_code is not None:
-            self.d_state_code = d_state_code
-        if d_state_name is not None:
-            self.d_state_name = d_state_name
-        if is_deprecated is not None:
-            self.is_deprecated = is_deprecated
-
-    @property
-    def icao_code(self):
-        """Gets the icao_code of this FDSIDList.  # noqa: E501
-
-        ICAO code of the issuing country  # noqa: E501
-
-        :return: The icao_code of this FDSIDList.  # noqa: E501
-        :rtype: str
-        """
-        return self._icao_code
-
-    @icao_code.setter
-    def icao_code(self, icao_code):
-        """Sets the icao_code of this FDSIDList.
-
-        ICAO code of the issuing country  # noqa: E501
-
-        :param icao_code: The icao_code of this FDSIDList.  # noqa: E501
-        :type icao_code: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                icao_code is not None and len(icao_code) > 3):
-            raise ValueError("Invalid value for `icao_code`, length must be less than or equal to `3`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                icao_code is not None and len(icao_code) < 3):
-            raise ValueError("Invalid value for `icao_code`, length must be greater than or equal to `3`")  # noqa: E501
-
-        self._icao_code = icao_code
-
-    @property
-    def list(self):
-        """Gets the list of this FDSIDList.  # noqa: E501
-
-        Document identifiers in 'Information Reference Systems'  # noqa: E501
-
-        :return: The list of this FDSIDList.  # noqa: E501
-        :rtype: list[int]
-        """
-        return self._list
-
-    @list.setter
-    def list(self, list):
-        """Sets the list of this FDSIDList.
-
-        Document identifiers in 'Information Reference Systems'  # noqa: E501
-
-        :param list: The list of this FDSIDList.  # noqa: E501
-        :type list: list[int]
-        """
-
-        self._list = list
-
-    @property
-    def d_type(self):
-        """Gets the d_type of this FDSIDList.  # noqa: E501
-
-
-        :return: The d_type of this FDSIDList.  # noqa: E501
-        :rtype: DocumentType
-        """
-        return self._d_type
-
-    @d_type.setter
-    def d_type(self, d_type):
-        """Sets the d_type of this FDSIDList.
-
-
-        :param d_type: The d_type of this FDSIDList.  # noqa: E501
-        :type d_type: DocumentType
-        """
-
-        self._d_type = d_type
-
-    @property
-    def d_format(self):
-        """Gets the d_format of this FDSIDList.  # noqa: E501
-
-
-        :return: The d_format of this FDSIDList.  # noqa: E501
-        :rtype: DocumentFormat
-        """
-        return self._d_format
-
-    @d_format.setter
-    def d_format(self, d_format):
-        """Sets the d_format of this FDSIDList.
-
-
-        :param d_format: The d_format of this FDSIDList.  # noqa: E501
-        :type d_format: DocumentFormat
-        """
-
-        self._d_format = d_format
-
-    @property
-    def d_mrz(self):
-        """Gets the d_mrz of this FDSIDList.  # noqa: E501
-
-        Flag indicating the presence of MRZ on the document  # noqa: E501
-
-        :return: The d_mrz of this FDSIDList.  # noqa: E501
-        :rtype: bool
-        """
-        return self._d_mrz
-
-    @d_mrz.setter
-    def d_mrz(self, d_mrz):
-        """Sets the d_mrz of this FDSIDList.
-
-        Flag indicating the presence of MRZ on the document  # noqa: E501
-
-        :param d_mrz: The d_mrz of this FDSIDList.  # noqa: E501
-        :type d_mrz: bool
-        """
-
-        self._d_mrz = d_mrz
-
-    @property
-    def d_description(self):
-        """Gets the d_description of this FDSIDList.  # noqa: E501
-
-        Document description  # noqa: E501
-
-        :return: The d_description of this FDSIDList.  # noqa: E501
-        :rtype: str
-        """
-        return self._d_description
-
-    @d_description.setter
-    def d_description(self, d_description):
-        """Sets the d_description of this FDSIDList.
-
-        Document description  # noqa: E501
-
-        :param d_description: The d_description of this FDSIDList.  # noqa: E501
-        :type d_description: str
-        """
-
-        self._d_description = d_description
-
-    @property
-    def d_year(self):
-        """Gets the d_year of this FDSIDList.  # noqa: E501
-
-        Year of publication of the document  # noqa: E501
-
-        :return: The d_year of this FDSIDList.  # noqa: E501
-        :rtype: str
-        """
-        return self._d_year
-
-    @d_year.setter
-    def d_year(self, d_year):
-        """Sets the d_year of this FDSIDList.
-
-        Year of publication of the document  # noqa: E501
-
-        :param d_year: The d_year of this FDSIDList.  # noqa: E501
-        :type d_year: str
-        """
-
-        self._d_year = d_year
-
-    @property
-    def d_country_name(self):
-        """Gets the d_country_name of this FDSIDList.  # noqa: E501
-
-        Issuing country name  # noqa: E501
-
-        :return: The d_country_name of this FDSIDList.  # noqa: E501
-        :rtype: str
-        """
-        return self._d_country_name
-
-    @d_country_name.setter
-    def d_country_name(self, d_country_name):
-        """Sets the d_country_name of this FDSIDList.
-
-        Issuing country name  # noqa: E501
-
-        :param d_country_name: The d_country_name of this FDSIDList.  # noqa: E501
-        :type d_country_name: str
-        """
-
-        self._d_country_name = d_country_name
-
-    @property
-    def d_state_code(self):
-        """Gets the d_state_code of this FDSIDList.  # noqa: E501
-
-        Issuing state code  # noqa: E501
-
-        :return: The d_state_code of this FDSIDList.  # noqa: E501
-        :rtype: str
-        """
-        return self._d_state_code
-
-    @d_state_code.setter
-    def d_state_code(self, d_state_code):
-        """Sets the d_state_code of this FDSIDList.
-
-        Issuing state code  # noqa: E501
-
-        :param d_state_code: The d_state_code of this FDSIDList.  # noqa: E501
-        :type d_state_code: str
-        """
-
-        self._d_state_code = d_state_code
-
-    @property
-    def d_state_name(self):
-        """Gets the d_state_name of this FDSIDList.  # noqa: E501
-
-        Issuing state name  # noqa: E501
-
-        :return: The d_state_name of this FDSIDList.  # noqa: E501
-        :rtype: str
-        """
-        return self._d_state_name
-
-    @d_state_name.setter
-    def d_state_name(self, d_state_name):
-        """Sets the d_state_name of this FDSIDList.
-
-        Issuing state name  # noqa: E501
-
-        :param d_state_name: The d_state_name of this FDSIDList.  # noqa: E501
-        :type d_state_name: str
-        """
-
-        self._d_state_name = d_state_name
-
-    @property
-    def is_deprecated(self):
-        """Gets the is_deprecated of this FDSIDList.  # noqa: E501
-
-        Whether the document is deprecated  # noqa: E501
-
-        :return: The is_deprecated of this FDSIDList.  # noqa: E501
-        :rtype: bool
-        """
-        return self._is_deprecated
-
-    @is_deprecated.setter
-    def is_deprecated(self, is_deprecated):
-        """Sets the is_deprecated of this FDSIDList.
-
-        Whether the document is deprecated  # noqa: E501
-
-        :param is_deprecated: The is_deprecated of this FDSIDList.  # noqa: E501
-        :type is_deprecated: bool
-        """
-
-        self._is_deprecated = is_deprecated
-
-    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, FDSIDList):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    Extended document type info and Regula's 'Information Reference Systems' links
+    """ # noqa: E501
+    icao_code: Annotated[str, Field(min_length=3, strict=True, max_length=3)] = Field(description="ICAO code of the issuing country", alias="ICAOCode")
+    count: Union[StrictFloat, StrictInt] = Field(description="Number of elements in the List", alias="Count")
+    list: List[StrictInt] = Field(description="Document identifiers in 'Information Reference Systems'", alias="List")
+    d_type: DocumentType = Field(alias="dType")
+    d_format: DocumentFormat = Field(alias="dFormat")
+    d_mrz: StrictBool = Field(description="Flag indicating the presence of MRZ on the document", alias="dMRZ")
+    d_description: Optional[StrictStr] = Field(default=None, description="Document description", alias="dDescription")
+    d_year: StrictStr = Field(description="Year of publication of the document", alias="dYear")
+    d_country_name: StrictStr = Field(description="Issuing country name", alias="dCountryName")
+    d_state_code: Optional[StrictStr] = Field(default=None, description="Issuing state code", alias="dStateCode")
+    d_state_name: Optional[StrictStr] = Field(default=None, description="Issuing state name", alias="dStateName")
+    is_deprecated: StrictBool = Field(description="Whether the document is deprecated", alias="isDeprecated")
+    __properties: ClassVar[List[str]] = ["ICAOCode", "Count", "List", "dType", "dFormat", "dMRZ", "dDescription", "dYear", "dCountryName", "dStateCode", "dStateName", "isDeprecated"]
+
+    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 FDSIDList 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 FDSIDList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ICAOCode": obj.get("ICAOCode"),
+            "Count": obj.get("Count"),
+            "List": obj.get("List"),
+            "dType": obj.get("dType"),
+            "dFormat": obj.get("dFormat"),
+            "dMRZ": obj.get("dMRZ"),
+            "dDescription": obj.get("dDescription"),
+            "dYear": obj.get("dYear"),
+            "dCountryName": obj.get("dCountryName"),
+            "dStateCode": obj.get("dStateCode"),
+            "dStateName": obj.get("dStateName"),
+            "isDeprecated": obj.get("isDeprecated")
+        })
+        return _obj
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, FDSIDList):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,106 @@
+# 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.light import Light
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FiberItem(BaseModel):
+    """
+    FiberItem
+    """ # noqa: E501
+    rect_count: StrictInt = Field(description="For UV_Fibers authenticity result type", alias="RectCount")
+    expected_count: StrictInt = Field(description="Expected fibers number. For UV_Fibers authentication result type", alias="ExpectedCount")
+    light_value: Optional[Light] = Field(default=None, alias="LightValue")
+    light_disp: Optional[StrictInt] = Field(default=None, description="For UV_Background authentication result type", alias="LightDisp")
+    rect_array: List[RectangleCoordinates] = Field(description="Coordinates of located areas for defined fibers type", alias="RectArray")
+    width: List[StrictInt] = Field(description="Fibers width value for located areas (in pixels)", alias="Width")
+    length: List[StrictInt] = Field(description="Fibers length value for located areas (in pixels)", alias="Length")
+    area: List[StrictInt] = Field(description="Fibers value for areas (in pixels)", alias="Area")
+    color_values: List[StrictInt] = Field(description="Fibers color value", alias="ColorValues")
+    error_code: Optional[StrictInt] = Field(default=None, alias="ErrorCode")
+    __properties: ClassVar[List[str]] = ["RectCount", "ExpectedCount", "LightValue", "LightDisp", "RectArray", "Width", "Length", "Area", "ColorValues", "ErrorCode"]
+
+    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 FiberItem 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 rect_array (list)
+        _items = []
+        if self.rect_array:
+            for _item_rect_array in self.rect_array:
+                if _item_rect_array:
+                    _items.append(_item_rect_array.to_dict())
+            _dict['RectArray'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FiberItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "RectCount": obj.get("RectCount"),
+            "ExpectedCount": obj.get("ExpectedCount"),
+            "LightValue": obj.get("LightValue"),
+            "LightDisp": obj.get("LightDisp"),
+            "RectArray": [RectangleCoordinates.from_dict(_item) for _item in obj["RectArray"]] if obj.get("RectArray") is not None else None,
+            "Width": obj.get("Width"),
+            "Length": obj.get("Length"),
+            "Area": obj.get("Area"),
+            "ColorValues": obj.get("ColorValues"),
+            "ErrorCode": obj.get("ErrorCode")
+        })
+        return _obj
+
+