SP-18211 - update models

Author: ArtsiomTsybulko

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

@@ -14,6 +14,7 @@
 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 regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -24,9 +25,9 @@ class OCRSecurityTextItem(BaseModel):
     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_result_type: StrictInt = Field(description="Same as Result type, but used for safe parsing of not-described values. See Result type.", alias="EtalonResultType")
+    etalon_field_type: TextFieldType = Field(alias="EtalonFieldType")
+    etalon_light_type: Light = 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")
@@ -95,7 +96,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "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"),
+            "EtalonResultType": obj.get("EtalonResultType") if obj.get("EtalonResultType") is not None else 0,
             "EtalonFieldType": obj.get("EtalonFieldType"),
             "EtalonLightType": obj.get("EtalonLightType"),
             "EtalonFieldRect": RectangleCoordinates.from_dict(obj["EtalonFieldRect"]) if obj.get("EtalonFieldRect") is not None else None,

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

@@ -18,6 +18,7 @@
 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 regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,9 +29,9 @@ class OCRSecurityTextResult(AuthenticityCheckResultItem):
     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_result_type: StrictInt = Field(description="Same as Result type, but used for safe parsing of not-described values. See Result type.", alias="EtalonResultType")
+    etalon_field_type: TextFieldType = Field(alias="EtalonFieldType")
+    etalon_light_type: Light = 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")
@@ -103,7 +104,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "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"),
+            "EtalonResultType": obj.get("EtalonResultType") if obj.get("EtalonResultType") is not None else 0,
             "EtalonFieldType": obj.get("EtalonFieldType"),
             "EtalonLightType": obj.get("EtalonLightType"),
             "EtalonFieldRect": RectangleCoordinates.from_dict(obj["EtalonFieldRect"]) if obj.get("EtalonFieldRect") is not None else None,

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

@@ -15,6 +15,7 @@
 from regula.documentreader.webclient.gen.models.bc_pdf417_info import BcPDF417INFO
 from regula.documentreader.webclient.gen.models.bc_roidetect import BcROIDETECT
 from regula.documentreader.webclient.gen.models.data_module import DataModule
+from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,7 +30,7 @@ class PArrayField(BaseModel):
     bc_pdf417_info: Optional[BcPDF417INFO] = Field(default=None, alias="bcPDF417INFO")
     bc_roi_detect: BcROIDETECT = Field(alias="bcROI_DETECT")
     bc_text_decoder_types: Optional[StrictInt] = Field(default=None, alias="bcTextDecoderTypes")
-    bc_text_field_type: Optional[StrictInt] = Field(default=None, alias="bcTextFieldType")
+    bc_text_field_type: Optional[TextFieldType] = Field(default=None, alias="bcTextFieldType")
     bc_type_decode: BarcodeType = Field(alias="bcType_DECODE")
     bc_type_detect: StrictInt = Field(alias="bcType_DETECT")
     __properties: ClassVar[List[str]] = ["bcAngle_DETECT", "bcCodeResult", "bcCountModule", "bcDataModule", "bcPDF417INFO", "bcROI_DETECT", "bcTextDecoderTypes", "bcTextFieldType", "bcType_DECODE", "bcType_DETECT"]

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

@@ -12,7 +12,6 @@
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from regula.documentreader.webclient.gen.models.auth_params import AuthParams
-from regula.documentreader.webclient.gen.models.authenticity_result_type import AuthenticityResultType
 from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
 from regula.documentreader.webclient.gen.models.document_type import DocumentType
 from regula.documentreader.webclient.gen.models.face_api import FaceApi
@@ -82,7 +81,7 @@ class ProcessParams(BaseModel):
     split_names: Optional[StrictBool] = Field(default=None, description="When enabled, the Surname and GivenNames fields from MRZ will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default.", alias="splitNames")
     disable_perforation_ocr: Optional[StrictBool] = Field(default=None, description="When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default.", alias="disablePerforationOCR")
     document_group_filter: Optional[List[DocumentType]] = Field(default=None, description="List of specific eligible document types from DocumentType enum to recognize from. You may, for example, specify only passports to be recognized by setting this property. Empty by default.", alias="documentGroupFilter")
-    process_auth: Optional[AuthenticityResultType] = Field(default=None, alias="processAuth")
+    process_auth: Optional[StrictInt] = Field(default=None, alias="processAuth")
     device_id: Optional[StrictInt] = Field(default=None, description="This parameter is used to specify the document reader device type from which input images were captured. Default 0.", alias="deviceId")
     device_type: Optional[StrictInt] = Field(default=None, description="This parameter is used to specify the document reader device type from which input images were captured. Default 0.", alias="deviceType")
     device_type_hex: Optional[StrictStr] = Field(default=None, description="This parameter is used to specify the document reader device type from which input images were captured", alias="deviceTypeHex")

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

@@ -12,7 +12,6 @@
 from pydantic import BaseModel, ConfigDict, Field, 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.lcid import LCID
 from regula.documentreader.webclient.gen.models.process_params import ProcessParams
 from regula.documentreader.webclient.gen.models.process_request_image import ProcessRequestImage
 from regula.documentreader.webclient.gen.models.process_system_info import ProcessSystemInfo
@@ -35,8 +34,7 @@ class ProcessRequest(BaseModel):
     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")
     image_urls: Optional[List[StrictStr]] = Field(default=None, description="URLs to the document images for processing.", alias="ImageUrls")
-    lcid_filter: Optional[List[LCID]] = Field(default=None, description="The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.", alias="lcidFilter")
-    __properties: ClassVar[List[str]] = ["processParam", "List", "tag", "tenant", "env", "livePortrait", "extPortrait", "ContainerList", "systemInfo", "passBackObject", "dtc", "ImageUrls", "lcidFilter"]
+    __properties: ClassVar[List[str]] = ["processParam", "List", "tag", "tenant", "env", "livePortrait", "extPortrait", "ContainerList", "systemInfo", "passBackObject", "dtc", "ImageUrls"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -116,8 +114,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "systemInfo": ProcessSystemInfo.from_dict(obj["systemInfo"]) if obj.get("systemInfo") is not None else None,
             "passBackObject": obj.get("passBackObject"),
             "dtc": obj.get("dtc"),
-            "ImageUrls": obj.get("ImageUrls"),
-            "lcidFilter": obj.get("lcidFilter")
+            "ImageUrls": obj.get("ImageUrls")
         })
         return _obj
 

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

@@ -129,7 +129,7 @@ class RFIDErrorCodes(int, Enum):
     RFID_ERROR_LAYER6_GET_CHALLENGE_FAILURE = 2248147719
     RFID_ERROR_LAYER6_EXT_AUTH_FAILURE = 2248147720
     RFID_ERROR_LAYER6_GENERAL_AUTH_FAILURE = 2248147721
-    RFID_ERROR_FAILED = 4294967295
+    RFID_ERROR_FAILED = -1
     RFID_ERROR_NO_ERROR = 1
     RFID_ERROR_ALREADY_DONE = 2
 

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

@@ -28,9 +28,8 @@ class SecurityFeatureItem(BaseModel):
     visibility: Visibility = Field(alias="Visibility")
     critical_flag: Critical = Field(alias="CriticalFlag")
     area_list: Optional[AreaContainer] = Field(default=None, alias="AreaList")
-    result: Optional[StrictInt] = Field(default=None, alias="Result")
     reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
-    __properties: ClassVar[List[str]] = ["ElementType", "ElementRect", "Visibility", "CriticalFlag", "AreaList", "Result", "Reserved2"]
+    __properties: ClassVar[List[str]] = ["ElementType", "ElementRect", "Visibility", "CriticalFlag", "AreaList", "Reserved2"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -94,7 +93,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "Visibility": obj.get("Visibility"),
             "CriticalFlag": obj.get("CriticalFlag"),
             "AreaList": AreaContainer.from_dict(obj["AreaList"]) if obj.get("AreaList") is not None else None,
-            "Result": obj.get("Result"),
             "Reserved2": obj.get("Reserved2")
         })
         return _obj

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

@@ -32,9 +32,8 @@ class SecurityFeatureResult(AuthenticityCheckResultItem):
     visibility: Visibility = Field(alias="Visibility")
     critical_flag: Critical = Field(alias="CriticalFlag")
     area_list: Optional[AreaContainer] = Field(default=None, alias="AreaList")
-    result: Optional[StrictInt] = Field(default=None, alias="Result")
     reserved2: Optional[StrictInt] = Field(default=None, alias="Reserved2")
-    __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue", "ElementType", "ElementRect", "Visibility", "CriticalFlag", "AreaList", "Result", "Reserved2"]
+    __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue", "ElementType", "ElementRect", "Visibility", "CriticalFlag", "AreaList", "Reserved2"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -102,7 +101,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "Visibility": obj.get("Visibility"),
             "CriticalFlag": obj.get("CriticalFlag"),
             "AreaList": AreaContainer.from_dict(obj["AreaList"]) if obj.get("AreaList") is not None else None,
-            "Result": obj.get("Result"),
             "Reserved2": obj.get("Reserved2")
         })
         return _obj

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

@@ -9,7 +9,7 @@
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from regula.documentreader.webclient.gen.models.lcid import LCID
@@ -29,8 +29,7 @@ class VerifiedFieldMap(BaseModel):
     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")
-    field_type: Optional[StrictInt] = Field(default=None, alias="FieldType")
-    __properties: ClassVar[List[str]] = ["wFieldType", "wLCID", "Field_MRZ", "Field_Visual", "Field_Barcode", "Field_RFID", "Matrix", "FieldType"]
+    __properties: ClassVar[List[str]] = ["wFieldType", "wLCID", "Field_MRZ", "Field_Visual", "Field_Barcode", "Field_RFID", "Matrix"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,8 +88,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "Field_Visual": obj.get("Field_Visual"),
             "Field_Barcode": obj.get("Field_Barcode"),
             "Field_RFID": obj.get("Field_RFID"),
-            "Matrix": obj.get("Matrix"),
-            "FieldType": obj.get("FieldType")
+            "Matrix": obj.get("Matrix")
         })
         return _obj