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

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

@@ -1,91 +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
-from regula.documentreader.webclient.gen.models.symbol import Symbol
-from typing import Optional, Set
-from typing_extensions import Self
-
-class MRZRowsItem(BaseModel):
-    """
-    MRZRowsItem
-    """ # noqa: E501
-    length: StrictInt
-    max_length: StrictInt = Field(alias="maxLength")
-    symbols: List[Symbol]
-    __properties: ClassVar[List[str]] = ["length", "maxLength", "symbols"]
-
-    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 MRZRowsItem 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 symbols (list)
-        _items = []
-        if self.symbols:
-            for _item_symbols in self.symbols:
-                if _item_symbols:
-                    _items.append(_item_symbols.to_dict())
-            _dict['symbols'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of MRZRowsItem from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "length": obj.get("length"),
-            "maxLength": obj.get("maxLength"),
-            "symbols": [Symbol.from_dict(_item) for _item in obj["symbols"]] if obj.get("symbols") is not None else None
-        })
-        return _obj
-
-

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

@@ -1,105 +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
-from regula.documentreader.webclient.gen.models.string_item import StringItem
-from typing import Optional, Set
-from typing_extensions import Self
-
-class MRZTestQuality(BaseModel):
-    """
-    MRZTestQuality
-    """ # noqa: E501
-    check_sums: StrictInt = Field(alias="CHECK_SUMS")
-    contrast_print: StrictInt = Field(alias="CONTRAST_PRINT")
-    doc_format: StrictInt = Field(alias="DOC_FORMAT")
-    mrz_format: StrictInt = Field(alias="MRZ_FORMAT")
-    print_position: StrictInt = Field(alias="PRINT_POSITION")
-    stain_mrz: StrictInt = Field(alias="STAIN_MRZ")
-    symbols_param: StrictInt = Field(alias="SYMBOLS_PARAM")
-    str_count: StrictInt = Field(alias="StrCount")
-    strings: List[StringItem] = Field(alias="Strings")
-    textual_filling: StrictInt = Field(alias="TEXTUAL_FILLING")
-    __properties: ClassVar[List[str]] = ["CHECK_SUMS", "CONTRAST_PRINT", "DOC_FORMAT", "MRZ_FORMAT", "PRINT_POSITION", "STAIN_MRZ", "SYMBOLS_PARAM", "StrCount", "Strings", "TEXTUAL_FILLING"]
-
-    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 MRZTestQuality 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 strings (list)
-        _items = []
-        if self.strings:
-            for _item_strings in self.strings:
-                if _item_strings:
-                    _items.append(_item_strings.to_dict())
-            _dict['Strings'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of MRZTestQuality from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "CHECK_SUMS": obj.get("CHECK_SUMS"),
-            "CONTRAST_PRINT": obj.get("CONTRAST_PRINT"),
-            "DOC_FORMAT": obj.get("DOC_FORMAT"),
-            "MRZ_FORMAT": obj.get("MRZ_FORMAT"),
-            "PRINT_POSITION": obj.get("PRINT_POSITION"),
-            "STAIN_MRZ": obj.get("STAIN_MRZ"),
-            "SYMBOLS_PARAM": obj.get("SYMBOLS_PARAM"),
-            "StrCount": obj.get("StrCount"),
-            "Strings": [StringItem.from_dict(_item) for _item in obj["Strings"]] if obj.get("Strings") is not None else None,
-            "TEXTUAL_FILLING": obj.get("TEXTUAL_FILLING")
-        })
-        return _obj
-
-

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

regula/documentreader/webclient/gen/models/mrz_test_quality_result.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 ConfigDict, Field
-from typing import Any, ClassVar, Dict, List
-from regula.documentreader.webclient.gen.models.mrz_test_quality import MRZTestQuality
-from regula.documentreader.webclient.gen.models.result import Result
-from regula.documentreader.webclient.gen.models.result_item import ResultItem
-from typing import Optional, Set
-from typing_extensions import Self
-
-class MRZTestQualityResult(ResultItem):
-    """
-    MRZTestQualityResult
-    """ # noqa: E501
-    mrz_test_quality: MRZTestQuality = Field(alias="MRZTestQuality")
-    __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "MRZTestQuality"]
-
-    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 MRZTestQualityResult 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 mrz_test_quality
-        if self.mrz_test_quality:
-            _dict['MRZTestQuality'] = self.mrz_test_quality.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of MRZTestQualityResult 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"),
-            "MRZTestQuality": MRZTestQuality.from_dict(obj["MRZTestQuality"]) if obj.get("MRZTestQuality") is not None else None
-        })
-        return _obj
-
-

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

@@ -1,110 +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, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from regula.documentreader.webclient.gen.models.critical import Critical
-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 OCRSecurityTextItem(BaseModel):
-    """
-    OCRSecurityTextItem
-    """ # noqa: E501
-    critical_flag: Critical = Field(alias="CriticalFlag")
-    light_type: Light = Field(alias="LightType")
-    field_rect: RectangleCoordinates = Field(alias="FieldRect")
-    etalon_result_type: StrictInt = Field(alias="EtalonResultType")
-    etalon_field_type: StrictInt = Field(alias="EtalonFieldType")
-    etalon_light_type: StrictInt = Field(alias="EtalonLightType")
-    etalon_field_rect: RectangleCoordinates = Field(alias="EtalonFieldRect")
-    security_text_result_ocr: StrictStr = Field(alias="SecurityTextResultOCR")
-    etalon_result_ocr: StrictStr = Field(alias="EtalonResultOCR")
-    result_code: Optional[StrictInt] = Field(default=None, alias="ResultCode")
-    reserved1: Optional[StrictInt] = Field(default=None, alias="Reserved1")
-    reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
-    __properties: ClassVar[List[str]] = ["CriticalFlag", "LightType", "FieldRect", "EtalonResultType", "EtalonFieldType", "EtalonLightType", "EtalonFieldRect", "SecurityTextResultOCR", "EtalonResultOCR", "ResultCode", "Reserved1", "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 OCRSecurityTextItem 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 field_rect
-        if self.field_rect:
-            _dict['FieldRect'] = self.field_rect.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of etalon_field_rect
-        if self.etalon_field_rect:
-            _dict['EtalonFieldRect'] = self.etalon_field_rect.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of OCRSecurityTextItem from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "CriticalFlag": obj.get("CriticalFlag"),
-            "LightType": obj.get("LightType"),
-            "FieldRect": RectangleCoordinates.from_dict(obj["FieldRect"]) if obj.get("FieldRect") is not None else None,
-            "EtalonResultType": obj.get("EtalonResultType"),
-            "EtalonFieldType": obj.get("EtalonFieldType"),
-            "EtalonLightType": obj.get("EtalonLightType"),
-            "EtalonFieldRect": RectangleCoordinates.from_dict(obj["EtalonFieldRect"]) if obj.get("EtalonFieldRect") is not None else None,
-            "SecurityTextResultOCR": obj.get("SecurityTextResultOCR"),
-            "EtalonResultOCR": obj.get("EtalonResultOCR"),
-            "ResultCode": obj.get("ResultCode"),
-            "Reserved1": obj.get("Reserved1"),
-            "Reserved2": obj.get("Reserved2")
-        })
-        return _obj
-
-

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
-
-