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

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

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

@@ -1,107 +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.container_list import ContainerList
-from regula.documentreader.webclient.gen.models.processing_status import ProcessingStatus
-from regula.documentreader.webclient.gen.models.rfid_location import RfidLocation
-from regula.documentreader.webclient.gen.models.transaction_info import TransactionInfo
-from typing import Optional, Set
-from typing_extensions import Self
-
-class TransactionProcessResponse(BaseModel):
-    """
-    TransactionProcessResponse
-    """ # noqa: E501
-    chip_page: RfidLocation = Field(alias="ChipPage")
-    core_lib_result_code: StrictInt = Field(alias="CoreLibResultCode")
-    processing_finished: ProcessingStatus = Field(alias="ProcessingFinished")
-    container_list: ContainerList = Field(alias="ContainerList")
-    transaction_info: TransactionInfo = Field(alias="TransactionInfo")
-    log: Optional[StrictStr] = Field(default=None, description="Base64 encoded transaction processing log")
-    pass_back_object: Optional[Dict[str, Any]] = Field(default=None, description="Free-form object provided in request. See passBackObject property of ProcessRequest.", alias="passBackObject")
-    more_pages_available: StrictInt = Field(alias="morePagesAvailable")
-    elapsed_time: StrictInt = Field(description="Time the document processing has taken, ms.", alias="elapsedTime")
-    metadata: Optional[Dict[str, Any]] = None
-    __properties: ClassVar[List[str]] = ["ChipPage", "CoreLibResultCode", "ProcessingFinished", "ContainerList", "TransactionInfo", "log", "passBackObject", "morePagesAvailable", "elapsedTime", "metadata"]
-
-    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 TransactionProcessResponse 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 container_list
-        if self.container_list:
-            _dict['ContainerList'] = self.container_list.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of transaction_info
-        if self.transaction_info:
-            _dict['TransactionInfo'] = self.transaction_info.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of TransactionProcessResponse from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "ChipPage": obj.get("ChipPage"),
-            "CoreLibResultCode": obj.get("CoreLibResultCode"),
-            "ProcessingFinished": obj.get("ProcessingFinished"),
-            "ContainerList": ContainerList.from_dict(obj["ContainerList"]) if obj.get("ContainerList") is not None else None,
-            "TransactionInfo": TransactionInfo.from_dict(obj["TransactionInfo"]) if obj.get("TransactionInfo") is not None else None,
-            "log": obj.get("log"),
-            "passBackObject": obj.get("passBackObject"),
-            "morePagesAvailable": obj.get("morePagesAvailable"),
-            "elapsedTime": obj.get("elapsedTime"),
-            "metadata": obj.get("metadata")
-        })
-        return _obj
-
-

regula/documentreader/webclient/gen/models/transaction_process_response_item.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
-from typing import Optional, Set
-from typing_extensions import Self
-
-class TransactionProcessResponseItem(BaseModel):
-    """
-    TransactionProcessResponseItem
-    """ # noqa: E501
-    core_lib_result_code: StrictInt = Field(alias="CoreLibResultCode")
-    __properties: ClassVar[List[str]] = ["CoreLibResultCode"]
-
-    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 TransactionProcessResponseItem 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 TransactionProcessResponseItem from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "CoreLibResultCode": obj.get("CoreLibResultCode")
-        })
-        return _obj
-
-

regula/documentreader/webclient/gen/models/transaction_process_result.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, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from regula.documentreader.webclient.gen.models.in_data import InData
-from regula.documentreader.webclient.gen.models.out_data import OutData
-from typing import Optional, Set
-from typing_extensions import Self
-
-class TransactionProcessResult(BaseModel):
-    """
-    TransactionProcessResult
-    """ # noqa: E501
-    out_data: Optional[OutData] = Field(default=None, alias="OutData")
-    in_data: Optional[InData] = Field(default=None, alias="InData")
-    tag: Optional[StrictStr] = None
-    transaction_id: Optional[StrictStr] = Field(default=None, alias="transactionId")
-    __properties: ClassVar[List[str]] = ["OutData", "InData", "tag", "transactionId"]
-
-    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 TransactionProcessResult 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 out_data
-        if self.out_data:
-            _dict['OutData'] = self.out_data.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of in_data
-        if self.in_data:
-            _dict['InData'] = self.in_data.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of TransactionProcessResult from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "OutData": OutData.from_dict(obj["OutData"]) if obj.get("OutData") is not None else None,
-            "InData": InData.from_dict(obj["InData"]) if obj.get("InData") is not None else None,
-            "tag": obj.get("tag"),
-            "transactionId": obj.get("transactionId")
-        })
-        return _obj
-
-

regula/documentreader/webclient/gen/models/trf_ft_bytes.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, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing import Optional, Set
-from typing_extensions import Self
-
-class TrfFtBytes(BaseModel):
-    """
-    Structure is used to store an array of binary information that is a part of one of the informational data groups
-    """ # noqa: E501
-    type: StrictInt = Field(description="Logical type of the field", alias="Type")
-    status: Union[StrictFloat, StrictInt] = Field(description="Result of logical analysis of compliance of the contents of the field with the requirements of the specification", alias="Status")
-    length: Union[StrictFloat, StrictInt] = Field(description="Length of Data array", alias="Length")
-    data: Optional[StrictStr] = Field(description="Binary data array. Base64 encoded.", alias="Data")
-    __properties: ClassVar[List[str]] = ["Type", "Status", "Length", "Data"]
-
-    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 TrfFtBytes 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,
-        )
-        # set to None if data (nullable) is None
-        # and model_fields_set contains the field
-        if self.data is None and "data" in self.model_fields_set:
-            _dict['Data'] = None
-
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of TrfFtBytes 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"),
-            "Length": obj.get("Length"),
-            "Data": obj.get("Data")
-        })
-        return _obj
-
-

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

@@ -1,85 +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 typing import Optional, Set
-from typing_extensions import Self
-
-class TrfFtString(BaseModel):
-    """
-    Structure is used to store information about the numeric field (4 bytes) that is a part of one of the informational data groups.
-    """ # noqa: E501
-    type: Optional[StrictInt] = Field(default=None, alias="Type")
-    status: Optional[StrictInt] = Field(default=None, description="Result of logical analysis of compliance of the contents of the field with the requirements of the specification", alias="Status")
-    format: Optional[StrictStr] = Field(default=None, description="Mask of format of text information (for example, «YYMMDD» for date of birth)", alias="Format")
-    data: StrictStr = Field(description="Numeric value.", alias="Data")
-    __properties: ClassVar[List[str]] = ["Type", "Status", "Format", "Data"]
-
-    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 TrfFtString 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 TrfFtString 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"),
-            "Format": obj.get("Format"),
-            "Data": obj.get("Data")
-        })
-        return _obj
-
-

regula/documentreader/webclient/gen/models/visual_extended_field_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, StrictFloat, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from regula.documentreader.webclient.gen.models.string_recognition_result import StringRecognitionResult
-from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
-from typing import Optional, Set
-from typing_extensions import Self
-
-class VisualExtendedFieldItem(BaseModel):
-    """
-    VisualExtendedFieldItem
-    """ # noqa: E501
-    field_type: StrictInt = Field(alias="FieldType")
-    w_field_type: TextFieldType = Field(alias="wFieldType")
-    field_name: StrictStr = Field(description="Field symbolic name (null-terminated string)", alias="FieldName")
-    strings_count: Union[StrictFloat, StrictInt] = Field(description="Number of StringsResult array elements", alias="StringsCount")
-    strings_result: List[StringRecognitionResult] = Field(description="Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.", alias="StringsResult")
-    buf_length: Union[StrictFloat, StrictInt] = Field(description="Buf_Text text string length", alias="Buf_Length")
-    buf_text: StrictStr = Field(description="Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'", alias="Buf_Text")
-    field_mask: Optional[StrictStr] = Field(default=None, alias="FieldMask")
-    validity: Optional[StrictInt] = Field(default=None, alias="Validity")
-    in_comparison: Optional[StrictInt] = Field(default=None, alias="InComparison")
-    w_lcid: Optional[StrictInt] = Field(default=None, alias="wLCID")
-    reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
-    reserved3: Optional[StrictInt] = Field(default=None, alias="Reserved3")
-    __properties: ClassVar[List[str]] = ["FieldType", "wFieldType", "FieldName", "StringsCount", "StringsResult", "Buf_Length", "Buf_Text", "FieldMask", "Validity", "InComparison", "wLCID", "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 VisualExtendedFieldItem 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_result (list)
-        _items = []
-        if self.strings_result:
-            for _item_strings_result in self.strings_result:
-                if _item_strings_result:
-                    _items.append(_item_strings_result.to_dict())
-            _dict['StringsResult'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of VisualExtendedFieldItem from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "FieldType": obj.get("FieldType"),
-            "wFieldType": obj.get("wFieldType"),
-            "FieldName": obj.get("FieldName"),
-            "StringsCount": obj.get("StringsCount"),
-            "StringsResult": [StringRecognitionResult.from_dict(_item) for _item in obj["StringsResult"]] if obj.get("StringsResult") is not None else None,
-            "Buf_Length": obj.get("Buf_Length"),
-            "Buf_Text": obj.get("Buf_Text"),
-            "FieldMask": obj.get("FieldMask"),
-            "Validity": obj.get("Validity"),
-            "InComparison": obj.get("InComparison"),
-            "wLCID": obj.get("wLCID"),
-            "Reserved2": obj.get("Reserved2"),
-            "Reserved3": obj.get("Reserved3")
-        })
-        return _obj
-
-