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

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

@@ -0,0 +1,111 @@
+# 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, Union
+from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
+from regula.documentreader.webclient.gen.models.rfid_data_group_type_tag import RfidDataGroupTypeTag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RfidDG1(BaseModel):
+    """
+    Structure used to store the contents of EF.DG1 informational data group of ePassport application – document MRZ data
+    """ # noqa: E501
+    type: RfidDataGroupTypeTag = Field(alias="Type")
+    document_id: DocumentFormat = Field(alias="DocumentID")
+    document_type: StrictStr = Field(description="Symbolic code of document type", alias="DocumentType")
+    state: StrictStr = Field(description="Symbolic code of document issuing state", alias="State")
+    holder: StrictStr = Field(description="DO’s name and surname", alias="Holder")
+    document_number: StrictStr = Field(description="Document number", alias="DocumentNumber")
+    check_digit_document_number: Union[StrictFloat, StrictInt] = Field(description="Check digit of document number", alias="CheckDigitDocumentNumber")
+    nationality: StrictStr = Field(description="Symbolic code of DO’s nationality", alias="Nationality")
+    birthday: StrictStr = Field(description="DO’s date of birth", alias="Birthday")
+    check_digit_birthday: Union[StrictFloat, StrictInt] = Field(description="Check digit of DO’s date of birth", alias="CheckDigitBirthday")
+    sex: StrictStr = Field(description="DO’s sex", alias="Sex")
+    expiry_date: StrictStr = Field(description="Term of validity of the document", alias="ExpiryDate")
+    check_digit_expiry_date: Union[StrictFloat, StrictInt] = Field(description="Check digit of term of validity of the document", alias="CheckDigitExpiryDate")
+    optional_data: StrictStr = Field(description="DO’s personal number or other additional data", alias="OptionalData")
+    check_digit_optional_data: Union[StrictFloat, StrictInt] = Field(description="Check digit of additional data", alias="CheckDigitOptionalData")
+    check_digit_composite: Union[StrictFloat, StrictInt] = Field(description="General check digit", alias="CheckDigitComposite")
+    __properties: ClassVar[List[str]] = ["Type", "DocumentID", "DocumentType", "State", "Holder", "DocumentNumber", "CheckDigitDocumentNumber", "Nationality", "Birthday", "CheckDigitBirthday", "Sex", "ExpiryDate", "CheckDigitExpiryDate", "OptionalData", "CheckDigitOptionalData", "CheckDigitComposite"]
+
+    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 RfidDG1 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 RfidDG1 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"),
+            "DocumentID": obj.get("DocumentID"),
+            "DocumentType": obj.get("DocumentType"),
+            "State": obj.get("State"),
+            "Holder": obj.get("Holder"),
+            "DocumentNumber": obj.get("DocumentNumber"),
+            "CheckDigitDocumentNumber": obj.get("CheckDigitDocumentNumber"),
+            "Nationality": obj.get("Nationality"),
+            "Birthday": obj.get("Birthday"),
+            "CheckDigitBirthday": obj.get("CheckDigitBirthday"),
+            "Sex": obj.get("Sex"),
+            "ExpiryDate": obj.get("ExpiryDate"),
+            "CheckDigitExpiryDate": obj.get("CheckDigitExpiryDate"),
+            "OptionalData": obj.get("OptionalData"),
+            "CheckDigitOptionalData": obj.get("CheckDigitOptionalData"),
+            "CheckDigitComposite": obj.get("CheckDigitComposite")
+        })
+        return _obj
+
+

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

@@ -0,0 +1,95 @@
+# 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
+from regula.documentreader.webclient.gen.models.rfid_attribute_name import RfidAttributeName
+from regula.documentreader.webclient.gen.models.trf_ft_string import TrfFtString
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RfidDistinguishedName(BaseModel):
+    """
+    Contents of the identifier in binary form. Base64 encoded.
+    """ # noqa: E501
+    data: StrictStr = Field(description="Contents of the identifier in binary form. Base64 encoded.", alias="Data")
+    friendly_name: TrfFtString = Field(alias="FriendlyName")
+    attributes: List[RfidAttributeName] = Field(description="List of individual attributes contained in the identifier", alias="Attributes")
+    __properties: ClassVar[List[str]] = ["Data", "FriendlyName", "Attributes"]
+
+    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 RfidDistinguishedName 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 friendly_name
+        if self.friendly_name:
+            _dict['FriendlyName'] = self.friendly_name.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in attributes (list)
+        _items = []
+        if self.attributes:
+            for _item_attributes in self.attributes:
+                if _item_attributes:
+                    _items.append(_item_attributes.to_dict())
+            _dict['Attributes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RfidDistinguishedName from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "Data": obj.get("Data"),
+            "FriendlyName": TrfFtString.from_dict(obj["FriendlyName"]) if obj.get("FriendlyName") is not None else None,
+            "Attributes": [RfidAttributeName.from_dict(_item) for _item in obj["Attributes"]] if obj.get("Attributes") is not None else None
+        })
+        return _obj
+
+

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

@@ -0,0 +1,120 @@
+# 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 RFIDDocVisualExtendedField(BaseModel):
+    """
+    RFIDDocVisualExtendedField
+    """ # 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")
+    origin_dg: StrictInt = Field(alias="OriginDG")
+    origin_dg_tag: Optional[StrictInt] = Field(default=None, alias="OriginDGTag")
+    origin_tag_entry: Union[StrictFloat, StrictInt] = Field(description="Record index of the text field source in the data group", alias="OriginTagEntry")
+    origin_entry_view: Optional[StrictInt] = Field(default=None, alias="OriginEntryView")
+    __properties: ClassVar[List[str]] = ["FieldType", "wFieldType", "FieldName", "StringsCount", "StringsResult", "Buf_Length", "Buf_Text", "FieldMask", "Validity", "InComparison", "wLCID", "Reserved2", "Reserved3", "OriginDG", "OriginDGTag", "OriginTagEntry", "OriginEntryView"]
+
+    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 RFIDDocVisualExtendedField 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 RFIDDocVisualExtendedField 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"),
+            "OriginDG": obj.get("OriginDG"),
+            "OriginDGTag": obj.get("OriginDGTag"),
+            "OriginTagEntry": obj.get("OriginTagEntry"),
+            "OriginEntryView": obj.get("OriginEntryView")
+        })
+        return _obj
+
+

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

@@ -0,0 +1,85 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class RFIDDocVisualExtendedFieldItem(BaseModel):
+    """
+    RFIDDocVisualExtendedFieldItem
+    """ # noqa: E501
+    origin_dg: StrictInt = Field(alias="OriginDG")
+    origin_dg_tag: Optional[StrictInt] = Field(default=None, alias="OriginDGTag")
+    origin_tag_entry: Union[StrictFloat, StrictInt] = Field(description="Record index of the text field source in the data group", alias="OriginTagEntry")
+    origin_entry_view: Optional[StrictInt] = Field(default=None, alias="OriginEntryView")
+    __properties: ClassVar[List[str]] = ["OriginDG", "OriginDGTag", "OriginTagEntry", "OriginEntryView"]
+
+    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 RFIDDocVisualExtendedFieldItem 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 RFIDDocVisualExtendedFieldItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "OriginDG": obj.get("OriginDG"),
+            "OriginDGTag": obj.get("OriginDGTag"),
+            "OriginTagEntry": obj.get("OriginTagEntry"),
+            "OriginEntryView": obj.get("OriginEntryView")
+        })
+        return _obj
+
+

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

@@ -0,0 +1,89 @@
+# 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.rfid_doc_visual_extended_field import RFIDDocVisualExtendedField
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RFIDDocVisualExtendedInfo(BaseModel):
+    """
+    Container for extracted text fields. Fields are identified by type and language
+    """ # noqa: E501
+    n_fields: Union[StrictFloat, StrictInt] = Field(description="Number of pArrayFields array elements", alias="nFields")
+    p_array_fields: List[RFIDDocVisualExtendedField] = Field(alias="pArrayFields")
+    __properties: ClassVar[List[str]] = ["nFields", "pArrayFields"]
+
+    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 RFIDDocVisualExtendedInfo 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 p_array_fields (list)
+        _items = []
+        if self.p_array_fields:
+            for _item_p_array_fields in self.p_array_fields:
+                if _item_p_array_fields:
+                    _items.append(_item_p_array_fields.to_dict())
+            _dict['pArrayFields'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RFIDDocVisualExtendedInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "nFields": obj.get("nFields"),
+            "pArrayFields": [RFIDDocVisualExtendedField.from_dict(_item) for _item in obj["pArrayFields"]] if obj.get("pArrayFields") is not None else None
+        })
+        return _obj
+
+

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

@@ -0,0 +1,83 @@
+# 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.rfid_doc_visual_extended_info import RFIDDocVisualExtendedInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RFIDDocVisualExtendedInfoItem(BaseModel):
+    """
+    RFIDDocVisualExtendedInfoItem
+    """ # noqa: E501
+    doc_visual_extended_info: RFIDDocVisualExtendedInfo = Field(alias="DocVisualExtendedInfo")
+    __properties: ClassVar[List[str]] = ["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 RFIDDocVisualExtendedInfoItem 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 RFIDDocVisualExtendedInfoItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "DocVisualExtendedInfo": RFIDDocVisualExtendedInfo.from_dict(obj["DocVisualExtendedInfo"]) if obj.get("DocVisualExtendedInfo") is not None else None
+        })
+        return _obj
+
+