regula-documentreader-webclient 8.1.302.dev0__py3-none-any.whl → 8.1.340rc0__py3-none-any.whl

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

@@ -1,87 +0,0 @@
-# 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, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
-from typing import Optional, Set
-from typing_extensions import Self
-
-class OneCandidateItem(BaseModel):
-    """
-    OneCandidateItem
-    """ # noqa: E501
-    one_candidate: OneCandidate = Field(alias="OneCandidate")
-    xml_buffer: Optional[StrictStr] = Field(default=None, alias="XML_buffer")
-    __properties: ClassVar[List[str]] = ["OneCandidate", "XML_buffer"]
-
-    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 OneCandidateItem 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.
-        * OpenAPI `readOnly` fields are excluded.
-        """
-        excluded_fields: Set[str] = set([
-            "xml_buffer",
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of one_candidate
-        if self.one_candidate:
-            _dict['OneCandidate'] = self.one_candidate.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of OneCandidateItem from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "OneCandidate": OneCandidate.from_dict(obj["OneCandidate"]) if obj.get("OneCandidate") is not None else None,
-            "XML_buffer": obj.get("XML_buffer")
-        })
-        return _obj
-
-

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

@@ -1,79 +0,0 @@
-# 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 typing import Optional, Set
-from typing_extensions import Self
-
-class ParsedData(BaseModel):
-    """
-    ParsedData
-    """ # noqa: E501
-    parsing_notifications: Optional[List[StrictInt]] = Field(default=None, alias="ParsingNotifications")
-    __properties: ClassVar[List[str]] = ["ParsingNotifications"]
-
-    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 ParsedData 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 ParsedData from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "ParsingNotifications": obj.get("ParsingNotifications")
-        })
-        return _obj
-
-

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

@@ -1,112 +0,0 @@
-# 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")
-    reserved1: Optional[StrictInt] = Field(default=None, alias="Reserved1")
-    reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
-    reserved3: Optional[StrictInt] = Field(default=None, alias="Reserved3")
-    __properties: ClassVar[List[str]] = ["LightIndex", "Area", "SourceImage", "ResultImages", "FieldTypesCount", "FieldTypesList", "Step", "Angle", "Reserved1", "Reserved2", "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"),
-            "Reserved1": obj.get("Reserved1"),
-            "Reserved2": obj.get("Reserved2"),
-            "Reserved3": obj.get("Reserved3")
-        })
-        return _obj
-
-

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

@@ -1,83 +0,0 @@
-# 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.image_data import ImageData
-from typing import Optional, Set
-from typing_extensions import Self
-
-class RawImageContainerItem(BaseModel):
-    """
-    RawImageContainerItem
-    """ # noqa: E501
-    raw_image_container: ImageData = Field(alias="RawImageContainer")
-    __properties: ClassVar[List[str]] = ["RawImageContainer"]
-
-    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 RawImageContainerItem 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 raw_image_container
-        if self.raw_image_container:
-            _dict['RawImageContainer'] = self.raw_image_container.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of RawImageContainerItem from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "RawImageContainer": ImageData.from_dict(obj["RawImageContainer"]) if obj.get("RawImageContainer") is not None else None
-        })
-        return _obj
-
-

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

@@ -1,93 +0,0 @@
-# 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, StrictFloat, StrictInt
-from typing import Any, ClassVar, Dict, List, Union
-from regula.documentreader.webclient.gen.models.mrz_rows_item import MRZRowsItem
-from typing import Optional, Set
-from typing_extensions import Self
-
-class ResultMRZDetector(BaseModel):
-    """
-    ResultMRZDetector
-    """ # noqa: E501
-    mrz_format: StrictInt = Field(alias="MRZFormat")
-    mrz_rows: List[MRZRowsItem] = Field(alias="MRZRows")
-    mrz_rows_num: StrictInt = Field(alias="MRZRowsNum")
-    bounding_quadrangle: List[Union[StrictFloat, StrictInt]] = Field(alias="boundingQuadrangle")
-    __properties: ClassVar[List[str]] = ["MRZFormat", "MRZRows", "MRZRowsNum", "boundingQuadrangle"]
-
-    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 ResultMRZDetector 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 mrz_rows (list)
-        _items = []
-        if self.mrz_rows:
-            for _item_mrz_rows in self.mrz_rows:
-                if _item_mrz_rows:
-                    _items.append(_item_mrz_rows.to_dict())
-            _dict['MRZRows'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ResultMRZDetector from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "MRZFormat": obj.get("MRZFormat"),
-            "MRZRows": [MRZRowsItem.from_dict(_item) for _item in obj["MRZRows"]] if obj.get("MRZRows") is not None else None,
-            "MRZRowsNum": obj.get("MRZRowsNum"),
-            "boundingQuadrangle": obj.get("boundingQuadrangle")
-        })
-        return _obj
-
-

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

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

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

@@ -1,33 +0,0 @@
-# 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 RfidAChip(int, Enum):
-    """
-    Enumeration contains a set of constants specifying the type of the RFIDchip from MIFARE® family (for chips of type A)
-    """
-
-    """
-    allowed enum values
-    """
-    UNKNOWN = 0
-    MIFARE_1K = 1
-    MIFARE_4K = 2
-    MIFARE_ULTRALIGHT = 3
-    MIFARE_DES_FIRE = 4
-    MIFARE_PROX = 5
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Self:
-        """Create an instance of RfidAChip from a JSON string"""
-        return cls(json.loads(json_str))
-
-

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

@@ -1,90 +0,0 @@
-# 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, StrictFloat, StrictInt
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from regula.documentreader.webclient.gen.models.parsing_notification_codes import ParsingNotificationCodes
-from regula.documentreader.webclient.gen.models.rfid_access_control_procedure_type import RfidAccessControlProcedureType
-from regula.documentreader.webclient.gen.models.rfid_error_codes import RFIDErrorCodes
-from typing import Optional, Set
-from typing_extensions import Self
-
-class RfidAccessControlInfo(BaseModel):
-    """
-    Structure is used to describe the results of a single authentication procedure or a procedure of secure data access within the context of the communication session with electronic document
-    """ # noqa: E501
-    type: RfidAccessControlProcedureType = Field(alias="Type")
-    status: RFIDErrorCodes = Field(alias="Status")
-    active_option_idx: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Index of the active variant of the procedure", alias="ActiveOptionIdx")
-    notifications: List[ParsingNotificationCodes] = Field(description="List of remarks arisen during the procedure.", alias="Notifications")
-    access_control_options: Optional[List[Any]] = Field(default=None, description="List of structures with are used to describe the variants of the authentication or secure data access procedure performance within the context of the communication session with electronic document", alias="AccessControlOptions")
-    __properties: ClassVar[List[str]] = ["Type", "Status", "ActiveOptionIdx", "Notifications", "AccessControlOptions"]
-
-    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 RfidAccessControlInfo 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 RfidAccessControlInfo from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "Type": obj.get("Type"),
-            "Status": obj.get("Status"),
-            "ActiveOptionIdx": obj.get("ActiveOptionIdx"),
-            "Notifications": obj.get("Notifications"),
-            "AccessControlOptions": obj.get("AccessControlOptions")
-        })
-        return _obj
-
-