regula-documentreader-webclient 8.3.480.dev0__py3-none-any.whl → 8.4.587.dev0__py3-none-any.whl

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

@@ -11,25 +11,29 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from uuid import UUID
 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
+from pydantic import SkipValidation, Field
 
 class TransactionProcessGetResponse(BaseModel):
     """
     TransactionProcessGetResponse
     """ # noqa: E501
-    transaction_id: Optional[StrictStr] = Field(default=None, alias="transactionId")
-    tag: Optional[StrictStr] = None
-    out_data: Optional[OutData] = Field(default=None, alias="outData")
-    in_data: Optional[InData] = Field(default=None, alias="inData")
+    transaction_id: SkipValidation[Optional[str]] = Field(alias="transactionId", default=None)
+    tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None)
+    out_data: SkipValidation[Optional[OutData]] = Field(alias="outData", default=None)
+    in_data: SkipValidation[Optional[InData]] = Field(alias="inData", default=None)
     __properties: ClassVar[List[str]] = ["transactionId", "tag", "outData", "inData"]
 
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
         protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
     )
 
 

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

@@ -17,28 +17,31 @@ from regula.documentreader.webclient.gen.models.process_request_image import Pro
 from regula.documentreader.webclient.gen.models.process_system_info import ProcessSystemInfo
 from typing import Optional, Set
 from typing_extensions import Self
+from pydantic import SkipValidation, Field
 
 class TransactionProcessRequest(BaseModel):
     """
     TransactionProcessRequest
     """ # noqa: E501
-    process_param: ProcessParams = Field(alias="processParam")
-    list: Optional[List[ProcessRequestImage]] = Field(default=None, alias="List")
-    tag: Optional[StrictStr] = Field(default=None, description="Session ID")
-    tenant: Optional[StrictStr] = Field(default=None, description="Customer name")
-    env: Optional[StrictStr] = Field(default=None, description="Environment type")
-    live_portrait: Optional[StrictStr] = Field(default=None, description="Live portrait photo", alias="livePortrait")
-    ext_portrait: Optional[StrictStr] = Field(default=None, description="Portrait photo from an external source", alias="extPortrait")
-    container_list: Optional[ContainerList] = Field(default=None, alias="ContainerList")
-    system_info: Optional[ProcessSystemInfo] = Field(default=None, alias="systemInfo")
-    pass_back_object: Optional[Dict[str, Any]] = Field(default=None, description="Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.", alias="passBackObject")
-    dtc: Optional[StrictStr] = Field(default=None, description="Digital Travel Credential (DTC-VC) data in base64 format for processing")
+    process_param: SkipValidation[ProcessParams] = Field(alias="processParam")
+    list: SkipValidation[Optional[List[ProcessRequestImage]]] = Field(alias="List", default=None)
+    tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session ID")
+    tenant: SkipValidation[Optional[str]] = Field(alias="tenant", default=None, description="Customer name")
+    env: SkipValidation[Optional[str]] = Field(alias="env", default=None, description="Environment type")
+    live_portrait: SkipValidation[Optional[str]] = Field(alias="livePortrait", default=None, description="Live portrait photo")
+    ext_portrait: SkipValidation[Optional[str]] = Field(alias="extPortrait", default=None, description="Portrait photo from an external source")
+    container_list: SkipValidation[Optional[ContainerList]] = Field(alias="ContainerList", default=None)
+    system_info: SkipValidation[Optional[ProcessSystemInfo]] = Field(alias="systemInfo", default=None)
+    pass_back_object: SkipValidation[Optional[Dict[str, object]]] = Field(alias="passBackObject", default=None, description="Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.")
+    dtc: SkipValidation[Optional[str]] = Field(alias="dtc", default=None, description="Digital Travel Credential (DTC-VC) data in base64 format for processing")
     __properties: ClassVar[List[str]] = ["processParam", "List", "tag", "tenant", "env", "livePortrait", "extPortrait", "ContainerList", "systemInfo", "passBackObject", "dtc"]
 
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
         protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
     )
 
 

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

@@ -11,25 +11,29 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from uuid import UUID
 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
+from pydantic import SkipValidation, Field
 
 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")
+    out_data: SkipValidation[Optional[OutData]] = Field(alias="outData", default=None)
+    in_data: SkipValidation[Optional[InData]] = Field(alias="inData", default=None)
+    tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None)
+    transaction_id: SkipValidation[Optional[str]] = Field(alias="transactionId", default=None)
     __properties: ClassVar[List[str]] = ["outData", "inData", "tag", "transactionId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
         protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
     )
 
 

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

@@ -13,21 +13,24 @@ from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, Stric
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
+from pydantic import SkipValidation, Field
 
 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")
+    type: SkipValidation[int] = Field(alias="Type", description="Logical type of the field")
+    status: SkipValidation[float] = Field(alias="Status", description="Result of logical analysis of compliance of the contents of the field with the requirements of the specification")
+    length: SkipValidation[float] = Field(alias="Length", description="Length of Data array")
+    data: SkipValidation[str] = Field(alias="Data", description="Binary data array. Base64 encoded.")
     __properties: ClassVar[List[str]] = ["Type", "Status", "Length", "Data"]
 
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
         protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
     )
 
 

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

@@ -13,21 +13,24 @@ 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
+from pydantic import SkipValidation, Field
 
 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")
+    type: SkipValidation[Optional[int]] = Field(alias="Type", default=None)
+    status: SkipValidation[Optional[int]] = Field(alias="Status", default=None, description="Result of logical analysis of compliance of the contents of the field with the requirements of the specification")
+    format: SkipValidation[Optional[str]] = Field(alias="Format", default=None, description="Mask of format of text information (for example, «YYMMDD» for date of birth)")
+    data: SkipValidation[str] = Field(alias="Data", description="Numeric value.")
     __properties: ClassVar[List[str]] = ["Type", "Status", "Format", "Data"]
 
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
         protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
     )
 
 

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

@@ -17,24 +17,27 @@ from regula.documentreader.webclient.gen.models.text_field_type import TextField
 from regula.documentreader.webclient.gen.models.verification_result import VerificationResult
 from typing import Optional, Set
 from typing_extensions import Self
+from pydantic import SkipValidation, Field
 
 class VerifiedFieldMap(BaseModel):
     """
     VerifiedFieldMap
     """ # noqa: E501
-    w_field_type: TextFieldType = Field(alias="wFieldType")
-    w_lcid: LCID = Field(alias="wLCID")
-    field_mrz: Optional[StrictStr] = Field(default=None, description="Field data extracted from mrz(machine readable zone)", alias="Field_MRZ")
-    field_visual: Optional[StrictStr] = Field(default=None, description="Field data extracted from visual zone", alias="Field_Visual")
-    field_barcode: Optional[StrictStr] = Field(default=None, description="Field data extracted from barcode", alias="Field_Barcode")
-    field_rfid: Optional[StrictStr] = Field(default=None, description="Field data extracted from rfid chip", alias="Field_RFID")
-    matrix: Annotated[List[VerificationResult], Field(min_length=10, max_length=10)] = Field(description="results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.", alias="Matrix")
+    w_field_type: SkipValidation[TextFieldType] = Field(alias="wFieldType")
+    w_lcid: SkipValidation[LCID] = Field(alias="wLCID")
+    field_mrz: SkipValidation[Optional[str]] = Field(alias="Field_MRZ", default=None, description="Field data extracted from mrz(machine readable zone)")
+    field_visual: SkipValidation[Optional[str]] = Field(alias="Field_Visual", default=None, description="Field data extracted from visual zone")
+    field_barcode: SkipValidation[Optional[str]] = Field(alias="Field_Barcode", default=None, description="Field data extracted from barcode")
+    field_rfid: SkipValidation[Optional[str]] = Field(alias="Field_RFID", default=None, description="Field data extracted from rfid chip")
+    matrix: SkipValidation[List[VerificationResult]] = Field(alias="Matrix", description="results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.")
     __properties: ClassVar[List[str]] = ["wFieldType", "wLCID", "Field_MRZ", "Field_Visual", "Field_Barcode", "Field_RFID", "Matrix"]
 
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
         protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
     )
 
 

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

@@ -16,29 +16,32 @@ from regula.documentreader.webclient.gen.models.string_recognition_result import
 from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
 from typing import Optional, Set
 from typing_extensions import Self
+from pydantic import SkipValidation, Field
 
 class VisualExtendedFieldItem(BaseModel):
     """
     VisualExtendedFieldItem
     """ # noqa: E501
-    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[LCID] = Field(default=None, alias="wLCID")
-    reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
-    reserved3: Optional[StrictInt] = Field(default=None, alias="Reserved3")
+    w_field_type: SkipValidation[TextFieldType] = Field(alias="wFieldType")
+    field_name: SkipValidation[str] = Field(alias="FieldName", description="Field symbolic name (null-terminated string)")
+    strings_count: SkipValidation[float] = Field(alias="StringsCount", description="Number of StringsResult array elements")
+    strings_result: SkipValidation[List[StringRecognitionResult]] = Field(alias="StringsResult", description="Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.")
+    buf_length: SkipValidation[float] = Field(alias="Buf_Length", description="Buf_Text text string length")
+    buf_text: SkipValidation[Optional[str]] = Field(alias="Buf_Text", default=None, description="Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'")
+    field_mask: SkipValidation[Optional[str]] = Field(alias="FieldMask", default=None)
+    validity: SkipValidation[Optional[int]] = Field(alias="Validity", default=None)
+    in_comparison: SkipValidation[Optional[int]] = Field(alias="InComparison", default=None)
+    w_lcid: SkipValidation[Optional[LCID]] = Field(alias="wLCID", default=None)
+    reserved2: SkipValidation[Optional[int]] = Field(alias="Reserved2", default=None)
+    reserved3: SkipValidation[Optional[int]] = Field(alias="Reserved3", default=None)
     __properties: ClassVar[List[str]] = ["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=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
     )
 
 

{regula_documentreader_webclient-8.3.480.dev0.dist-info → regula_documentreader_webclient-8.4.587.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 8.3.480.dev0
+Version: 8.4.587.dev0
 Summary: Regula's Document Reader python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.
@@ -17,6 +17,7 @@ Requires-Dist: idna==3.7
 Requires-Dist: requests>=2.32.3
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: lazy-imports==1.0.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: description