Merge pull request #217 from regulaforensics/feature/sp-18211

SP-18211 - update models

Author: KirylKovaliov

.openapi-generator/FILES

@@ -120,7 +120,6 @@ regula/documentreader/webclient/gen/models/measure_system.py
 regula/documentreader/webclient/gen/models/mrz_detect_mode_enum.py
 regula/documentreader/webclient/gen/models/mrz_detector_result.py
 regula/documentreader/webclient/gen/models/mrz_format.py
-regula/documentreader/webclient/gen/models/mrz_position.py
 regula/documentreader/webclient/gen/models/mrz_position_item.py
 regula/documentreader/webclient/gen/models/mrz_position_result.py
 regula/documentreader/webclient/gen/models/mrz_rows_item.py

regula/documentreader/webclient/gen/__init__.py

@@ -140,7 +140,6 @@
 from regula.documentreader.webclient.gen.models.mrz_test_quality_result import MRZTestQualityResult
 from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem
 from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzDetectModeEnum
-from regula.documentreader.webclient.gen.models.mrz_position import MrzPosition
 from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem
 from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem
 from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult

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

@@ -121,7 +121,6 @@
 from regula.documentreader.webclient.gen.models.mrz_test_quality_result import MRZTestQualityResult
 from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem
 from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzDetectModeEnum
-from regula.documentreader.webclient.gen.models.mrz_position import MrzPosition
 from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem
 from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem
 from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult

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

@@ -11,6 +11,7 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.lcid import LCID
 from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
 from regula.documentreader.webclient.gen.models.string_recognition_result import StringRecognitionResult
 from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
@@ -30,7 +31,7 @@ class DocVisualExtendedField(BaseModel):
     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")
+    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")
     field_rect: RectangleCoordinates = Field(alias="FieldRect")

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

@@ -11,15 +11,15 @@
 
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
-from regula.documentreader.webclient.gen.models.mrz_position import MrzPosition
+from regula.documentreader.webclient.gen.models.document_position import DocumentPosition
 from typing import Optional, Set
 from typing_extensions import Self
 
 class MrzPositionItem(BaseModel):
     """
     MrzPositionItem
     """ # noqa: E501
-    mrz_position: MrzPosition = Field(alias="MrzPosition")
+    mrz_position: DocumentPosition = Field(alias="MrzPosition")
     __properties: ClassVar[List[str]] = ["MrzPosition"]
 
     model_config = ConfigDict(
@@ -76,7 +76,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "MrzPosition": MrzPosition.from_dict(obj["MrzPosition"]) if obj.get("MrzPosition") is not None else None
+            "MrzPosition": DocumentPosition.from_dict(obj["MrzPosition"]) if obj.get("MrzPosition") is not None else None
         })
         return _obj
 

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

@@ -11,7 +11,7 @@
 
 from pydantic import ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
-from regula.documentreader.webclient.gen.models.mrz_position import MrzPosition
+from regula.documentreader.webclient.gen.models.document_position import DocumentPosition
 from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
@@ -21,7 +21,7 @@ class MRZPositionResult(ResultItem):
     """
     MRZPositionResult
     """ # noqa: E501
-    mrz_position: MrzPosition = Field(alias="MrzPosition")
+    mrz_position: DocumentPosition = Field(alias="MrzPosition")
     __properties: ClassVar[List[str]] = ["buf_length", "light", "list_idx", "page_idx", "result_type", "MrzPosition"]
 
     model_config = ConfigDict(
@@ -83,7 +83,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
             "result_type": obj.get("result_type"),
-            "MrzPosition": MrzPosition.from_dict(obj["MrzPosition"]) if obj.get("MrzPosition") is not None else None
+            "MrzPosition": DocumentPosition.from_dict(obj["MrzPosition"]) if obj.get("MrzPosition") is not None else None
         })
         return _obj
 

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

@@ -11,6 +11,7 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
 from regula.documentreader.webclient.gen.models.string_item import StringItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -19,16 +20,16 @@ class MRZTestQuality(BaseModel):
     """
     MRZTestQuality
     """ # noqa: E501
-    check_sums: StrictInt = Field(alias="CHECK_SUMS")
-    contrast_print: StrictInt = Field(alias="CONTRAST_PRINT")
+    check_sums: CheckResult = Field(alias="CHECK_SUMS")
+    contrast_print: CheckResult = 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")
+    print_position: CheckResult = Field(alias="PRINT_POSITION")
+    stain_mrz: CheckResult = Field(alias="STAIN_MRZ")
+    symbols_param: CheckResult = Field(alias="SYMBOLS_PARAM")
     str_count: StrictInt = Field(alias="StrCount")
     strings: List[StringItem] = Field(alias="Strings")
-    textual_filling: StrictInt = Field(alias="TEXTUAL_FILLING")
+    textual_filling: CheckResult = 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(

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

@@ -94,8 +94,8 @@ class RfidDataFileType(int, Enum):
     AUTHENTICITY_V2 = 302
     ATR = 400
     DIR = 401
-    _E_SIGN_PK = 500
-    _E_SIGN_SIGNED_DATA = 501
+    E_SIGN_PK = 500
+    E_SIGN_SIGNED_DATA = 501
     CERTIFICATE = 600
     MASTER_LIST = 601
     DEFECT_LIST = 602

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

@@ -11,6 +11,7 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.lcid import LCID
 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
@@ -29,7 +30,7 @@ class RFIDDocVisualExtendedField(BaseModel):
     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")
+    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")
     origin_dg: StrictInt = Field(alias="OriginDG")

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

@@ -10,7 +10,8 @@
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
-from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.check_result import CheckResult
 from regula.documentreader.webclient.gen.models.error_coordinates import ErrorCoordinates
 from regula.documentreader.webclient.gen.models.field_item import FieldItem
 from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
@@ -22,24 +23,24 @@ class StringItem(BaseModel):
     """
     StringItem
     """ # noqa: E501
-    alignment_symbols_in_string: StrictInt = Field(alias="ALIGNMENT_SYMBOLS_IN_STRING")
-    check_sums: StrictInt = Field(alias="CHECK_SUMS")
+    alignment_symbols_in_string: CheckResult = Field(alias="ALIGNMENT_SYMBOLS_IN_STRING")
+    check_sums: CheckResult = Field(alias="CHECK_SUMS")
     error_position: ErrorCoordinates = Field(alias="ErrorPOSITION")
     field_count: StrictInt = Field(alias="FieldCount")
     fields: List[FieldItem] = Field(alias="Fields")
-    strings_distance: StrictInt = Field(alias="STRINGS_DISTANCE")
-    strings_interval: StrictInt = Field(alias="STRINGS_INTERVAL")
-    string_filling: StrictInt = Field(alias="STRING_FILLING")
-    string_position: StrictInt = Field(alias="STRING_POSITION")
-    symbols_param: StrictInt = Field(alias="SYMBOLS_PARAM")
+    strings_distance: CheckResult = Field(alias="STRINGS_DISTANCE")
+    strings_interval: CheckResult = Field(alias="STRINGS_INTERVAL")
+    string_filling: CheckResult = Field(alias="STRING_FILLING")
+    strings_position: Optional[CheckResult] = Field(default=None, alias="STRINGS_POSITION")
+    symbols_param: CheckResult = Field(alias="SYMBOLS_PARAM")
     size_error_alignment: Union[StrictFloat, StrictInt] = Field(alias="SizeError_ALIGNMENT")
     size_error_distance: Union[StrictFloat, StrictInt] = Field(alias="SizeError_DISTANCE")
     size_error_interval: Union[StrictFloat, StrictInt] = Field(alias="SizeError_INTERVAL")
     string_angle: Union[StrictFloat, StrictInt] = Field(alias="StringAngle")
     string_borders: RectangleCoordinates = Field(alias="StringBorders")
     symbols_count: StrictInt = Field(alias="SymbolsCount")
     symbols_estimations: List[SymbolEstimationItem] = Field(alias="SymbolsEstimations")
-    __properties: ClassVar[List[str]] = ["ALIGNMENT_SYMBOLS_IN_STRING", "CHECK_SUMS", "ErrorPOSITION", "FieldCount", "Fields", "STRINGS_DISTANCE", "STRINGS_INTERVAL", "STRING_FILLING", "STRING_POSITION", "SYMBOLS_PARAM", "SizeError_ALIGNMENT", "SizeError_DISTANCE", "SizeError_INTERVAL", "StringAngle", "StringBorders", "SymbolsCount", "SymbolsEstimations"]
+    __properties: ClassVar[List[str]] = ["ALIGNMENT_SYMBOLS_IN_STRING", "CHECK_SUMS", "ErrorPOSITION", "FieldCount", "Fields", "STRINGS_DISTANCE", "STRINGS_INTERVAL", "STRING_FILLING", "STRINGS_POSITION", "SYMBOLS_PARAM", "SizeError_ALIGNMENT", "SizeError_DISTANCE", "SizeError_INTERVAL", "StringAngle", "StringBorders", "SymbolsCount", "SymbolsEstimations"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -120,7 +121,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "STRINGS_DISTANCE": obj.get("STRINGS_DISTANCE"),
             "STRINGS_INTERVAL": obj.get("STRINGS_INTERVAL"),
             "STRING_FILLING": obj.get("STRING_FILLING"),
-            "STRING_POSITION": obj.get("STRING_POSITION"),
+            "STRINGS_POSITION": obj.get("STRINGS_POSITION"),
             "SYMBOLS_PARAM": obj.get("SYMBOLS_PARAM"),
             "SizeError_ALIGNMENT": obj.get("SizeError_ALIGNMENT"),
             "SizeError_DISTANCE": obj.get("SizeError_DISTANCE"),

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

@@ -11,6 +11,7 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.lcid import LCID
 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
@@ -29,7 +30,7 @@ class VisualExtendedFieldItem(BaseModel):
     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")
+    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")
     __properties: ClassVar[List[str]] = ["wFieldType", "FieldName", "StringsCount", "StringsResult", "Buf_Length", "Buf_Text", "FieldMask", "Validity", "InComparison", "wLCID", "Reserved2", "Reserved3"]