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

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

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.result import Result
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+from regula.documentreader.webclient.gen.models.rfid_doc_visual_extended_info import RFIDDocVisualExtendedInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RFIDTextDataResult(ResultItem):
+    """
+    RFIDTextDataResult
+    """ # noqa: E501
+    doc_visual_extended_info: RFIDDocVisualExtendedInfo = Field(alias="DocVisualExtendedInfo")
+    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "DocVisualExtendedInfo"]
+
+    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 RFIDTextDataResult 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 doc_visual_extended_info
+        if self.doc_visual_extended_info:
+            _dict['DocVisualExtendedInfo'] = self.doc_visual_extended_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RFIDTextDataResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "buf_length": obj.get("buf_length"),
+            "light": obj.get("light"),
+            "list_idx": obj.get("list_idx"),
+            "page_idx": obj.get("page_idx"),
+            "result_type": obj.get("result_type"),
+            "DocVisualExtendedInfo": RFIDDocVisualExtendedInfo.from_dict(obj["DocVisualExtendedInfo"]) if obj.get("DocVisualExtendedInfo") is not None else None
+        })
+        return _obj
+
+

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

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class RfidType(int, Enum):
+    """
+    Enumeration contains a set of constants specifying the type of the RFID-chip by the physical parameters of connection between antennas of the chip and the reader
+    """
+
+    """
+    allowed enum values
+    """
+    UNKNOWN = 0
+    A = 1
+    B = 2
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RfidType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

@@ -0,0 +1,88 @@
+# 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.trf_ft_string import TrfFtString
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RfidValidity(BaseModel):
+    """
+    Structure contains information on a certificate validity.
+    """ # noqa: E501
+    not_before: TrfFtString = Field(alias="NotBefore")
+    not_after: TrfFtString = Field(alias="NotAfter")
+    __properties: ClassVar[List[str]] = ["NotBefore", "NotAfter"]
+
+    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 RfidValidity 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 not_before
+        if self.not_before:
+            _dict['NotBefore'] = self.not_before.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of not_after
+        if self.not_after:
+            _dict['NotAfter'] = self.not_after.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RfidValidity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "NotBefore": TrfFtString.from_dict(obj["NotBefore"]) if obj.get("NotBefore") is not None else None,
+            "NotAfter": TrfFtString.from_dict(obj["NotAfter"]) if obj.get("NotAfter") is not None else None
+        })
+        return _obj
+
+

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

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class RFIDPKDResourceType(int, Enum):
+    """
+    Enumeration contains a set of constants that define the type of certificate
+    """
+
+    """
+    allowed enum values
+    """
+    CERTIFICATE_PA = 0
+    CERTIFICATE_TA = 1
+    LDIF = 2
+    CRL = 3
+    ML = 4
+    DEFL = 5
+    DEVL = 6
+    BL = 7
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RFIDPKDResourceType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

@@ -4,128 +4,44 @@
     Generated by: https://openapi-generator.tech
 """
 
-import pprint
-import re  # noqa: F401
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
 
-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 *
-
-
-"""
-Document processing scenario
-"""
-class Scenario(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class Scenario(str, Enum):
+    """
+    Document processing scenario
     """
-
-    MRZ = "Mrz"
-
-    BARCODE = "Barcode"
-
-    LOCATE = "Locate"
-
-    OCR = "Ocr"
-
-    DOCTYPE = "DocType"
-
-    MRZ_OR_BARCODE = "MrzOrBarcode"
-
-    MRZ_OR_LOCATE = "MrzOrLocate"
-
-    MRZ_AND_LOCATE = "MrzAndLocate"
-
-    BARCODE_AND_LOCATE = "BarcodeAndLocate"
-
-    MRZ_OR_OCR = "MrzOrOcr"
-
-    MRZ_OR_BARCODE_OR_OCR = "MrzOrBarcodeOrOcr"
-
-    LOCATE_VISUAL_AND_MRZ_OR_OCR = "LocateVisual_And_MrzOrOcr"
-
-    FULL_PROCESS = "FullProcess"
-
-    FULL_AUTH = "FullAuth"
-
-    RUS_STAMP = "RusStamp"
-
-    OCR_FREE = "OcrFree"
-
-    CREDIT_CARD = "CreditCard"
-
-    CAPTURE = "Capture"
-
-    DTC = "DTC"
-
-    allowable_values = [MRZ, BARCODE, LOCATE, OCR, DOCTYPE, MRZ_OR_BARCODE, MRZ_OR_LOCATE, MRZ_AND_LOCATE, BARCODE_AND_LOCATE, MRZ_OR_OCR, MRZ_OR_BARCODE_OR_OCR, LOCATE_VISUAL_AND_MRZ_OR_OCR, FULL_PROCESS, FULL_AUTH, RUS_STAMP, OCR_FREE, CREDIT_CARD, CAPTURE, DTC]  # noqa: E501
 
     """
-    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.
+    allowed enum values
     """
-    openapi_types = {
-    }
-
-    attribute_map = {
-    }
-
-    def __init__(self, local_vars_configuration=None):  # noqa: E501
-        """Scenario - 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.discriminator = None
-
-    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, Scenario):
-            return False
-
-        return self.to_dict() == other.to_dict()
+    MRZ = 'Mrz'
+    BARCODE = 'Barcode'
+    LOCATE = 'Locate'
+    OCR = 'Ocr'
+    DOCTYPE = 'DocType'
+    MRZ_OR_BARCODE = 'MrzOrBarcode'
+    MRZ_OR_LOCATE = 'MrzOrLocate'
+    MRZ_AND_LOCATE = 'MrzAndLocate'
+    BARCODE_AND_LOCATE = 'BarcodeAndLocate'
+    MRZ_OR_OCR = 'MrzOrOcr'
+    MRZ_OR_BARCODE_OR_OCR = 'MrzOrBarcodeOrOcr'
+    LOCATE_VISUAL_AND_MRZ_OR_OCR = 'LocateVisual_And_MrzOrOcr'
+    FULL_PROCESS = 'FullProcess'
+    FULL_AUTH = 'FullAuth'
+    RUS_STAMP = 'RusStamp'
+    OCR_FREE = 'OcrFree'
+    CREDIT_CARD = 'CreditCard'
+    CAPTURE = 'Capture'
+    DTC = 'DTC'
+    RFID = 'RFID'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Scenario from a JSON string"""
+        return cls(json.loads(json_str))
 
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, Scenario):
-            return True
 
-        return self.to_dict() != other.to_dict()

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

@@ -0,0 +1,102 @@
+# 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.area_container import AreaContainer
+from regula.documentreader.webclient.gen.models.critical import Critical
+from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
+from regula.documentreader.webclient.gen.models.security_feature_type import SecurityFeatureType
+from regula.documentreader.webclient.gen.models.visibility import Visibility
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SecurityFeatureItem(BaseModel):
+    """
+    SecurityFeatureItem
+    """ # noqa: E501
+    element_type: SecurityFeatureType = Field(alias="ElementType")
+    element_rect: RectangleCoordinates = Field(alias="ElementRect")
+    visibility: Visibility = Field(alias="Visibility")
+    critical_flag: Critical = Field(alias="CriticalFlag")
+    area_list: Optional[AreaContainer] = Field(default=None, alias="AreaList")
+    result: Optional[StrictInt] = Field(default=None, alias="Result")
+    reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
+    __properties: ClassVar[List[str]] = ["ElementType", "ElementRect", "Visibility", "CriticalFlag", "AreaList", "Result", "Reserved2"]
+
+    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 SecurityFeatureItem 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 element_rect
+        if self.element_rect:
+            _dict['ElementRect'] = self.element_rect.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of area_list
+        if self.area_list:
+            _dict['AreaList'] = self.area_list.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SecurityFeatureItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ElementType": obj.get("ElementType"),
+            "ElementRect": RectangleCoordinates.from_dict(obj["ElementRect"]) if obj.get("ElementRect") is not None else None,
+            "Visibility": obj.get("Visibility"),
+            "CriticalFlag": obj.get("CriticalFlag"),
+            "AreaList": AreaContainer.from_dict(obj["AreaList"]) if obj.get("AreaList") is not None else None,
+            "Result": obj.get("Result"),
+            "Reserved2": obj.get("Reserved2")
+        })
+        return _obj
+
+