Commit: d3901898

.github/workflows/run-smoke-test.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Install pipenv
         run: |
           python -m pip install --upgrade pip

Pipfile

@@ -7,7 +7,7 @@ name = "pypi"
 certifi = ">=2024.07.04"
 six = ">=1.10"
 python-dateutil = ">=2.8.2"
-urllib3 = ">=2.7.0, <3.0.0"
+urllib3 = ">=2.8.0, <3.0.0"
 vistir = ">=0.4.0, <=0.6.1"
 idna = ">=3.18"
 requests = ">=2.33.0"

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

@@ -26,7 +26,7 @@ class ChosenDocumentType(BaseModel):
     id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)")
     p: SkipValidation[float] = Field(alias="P", description="A measure of the likelihood of correct recognition in the analysis of this type of document")
     rotated180: SkipValidation[int] = Field(alias="Rotated180", description="Indicates if the document of the given type is rotated by 180 degrees")
-    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence")
+    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence", description="Indication of the presence of an RFID chip in the document (electronic document indicator)")
     fdsid_list: SkipValidation[Optional[FDSIDList]] = Field(alias="FDSIDList", default=None)
     necessary_lights: SkipValidation[int] = Field(alias="NecessaryLights", description="Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document")
     check_authenticity: SkipValidation[int] = Field(alias="CheckAuthenticity", description="Set of authentication options provided for this type of document (combination of Authenticity enum)")

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

@@ -20,14 +20,14 @@ class DetailsOptical(BaseModel):
     """
     Details on performed optical checks
     """ # noqa: E501
-    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus")
-    doc_type: SkipValidation[CheckResult] = Field(alias="docType")
-    expiry: SkipValidation[CheckResult] = Field(alias="expiry")
-    image_qa: SkipValidation[CheckResult] = Field(alias="imageQA")
-    mrz: SkipValidation[CheckResult] = Field(alias="mrz")
+    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus", description="Overall optical checks combined status")
+    doc_type: SkipValidation[CheckResult] = Field(alias="docType", description="Status of document type recognition")
+    expiry: SkipValidation[CheckResult] = Field(alias="expiry", description="Status of document expiration")
+    image_qa: SkipValidation[CheckResult] = Field(alias="imageQA", description="Status of document image quality check")
+    mrz: SkipValidation[CheckResult] = Field(alias="mrz", description="Status of document MRZ")
     pages_count: SkipValidation[int] = Field(alias="pagesCount", description="Number of processed pages in the document")
-    security: SkipValidation[CheckResult] = Field(alias="security")
-    text: SkipValidation[CheckResult] = Field(alias="text")
+    security: SkipValidation[CheckResult] = Field(alias="security", description="Authenticity verification status")
+    text: SkipValidation[CheckResult] = Field(alias="text", description="Status of text fields analysis")
     vds: SkipValidation[Optional[int]] = Field(alias="vds", default=None)
     __properties: ClassVar[List[str]] = ["overallStatus", "docType", "expiry", "imageQA", "mrz", "pagesCount", "security", "text", "vds"]
 

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

@@ -20,13 +20,13 @@ class DetailsRFID(BaseModel):
     """
     Details on performed RFID checks
     """ # noqa: E501
-    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus")
-    aa: SkipValidation[CheckResult] = Field(alias="AA")
-    bac: SkipValidation[CheckResult] = Field(alias="BAC")
-    ca: SkipValidation[CheckResult] = Field(alias="CA")
-    pa: SkipValidation[CheckResult] = Field(alias="PA")
-    pace: SkipValidation[CheckResult] = Field(alias="PACE")
-    ta: SkipValidation[CheckResult] = Field(alias="TA")
+    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus", description="Overall RFID checks combined status")
+    aa: SkipValidation[CheckResult] = Field(alias="AA", description="Active Authentication status")
+    bac: SkipValidation[CheckResult] = Field(alias="BAC", description="Basic Access Control (BAC) status")
+    ca: SkipValidation[CheckResult] = Field(alias="CA", description="Chip Authentication status")
+    pa: SkipValidation[CheckResult] = Field(alias="PA", description="Passive Authentication status")
+    pace: SkipValidation[CheckResult] = Field(alias="PACE", description="Password Authenticated Connection Establishment (PACE) status")
+    ta: SkipValidation[CheckResult] = Field(alias="TA", description="Terminal Authentication status")
     __properties: ClassVar[List[str]] = ["overallStatus", "AA", "BAC", "CA", "PA", "PACE", "TA"]
 
     model_config = ConfigDict(

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

@@ -35,7 +35,7 @@ class DocVisualExtendedField(BaseModel):
     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)
-    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect")
+    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect", description="Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.")
     __properties: ClassVar[List[str]] = ["wFieldType", "FieldName", "StringsCount", "StringsResult", "Buf_Length", "Buf_Text", "FieldMask", "Validity", "InComparison", "wLCID", "Reserved2", "Reserved3", "FieldRect"]
 
     model_config = ConfigDict(

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

@@ -20,7 +20,7 @@ class DocVisualExtendedFieldItem(BaseModel):
     """
     DocVisualExtendedFieldItem
     """ # noqa: E501
-    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect")
+    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect", description="Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.")
     __properties: ClassVar[List[str]] = ["FieldRect"]
 
     model_config = ConfigDict(

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

@@ -25,6 +25,7 @@ class DocumentFormat(int, Enum):
     NON = 3
     A4 = 4
     ID3_X2 = 5
+    ID2_TURKEY = 6
     ID1_90 = 10
     ID1_180 = 11
     ID1_270 = 12

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

@@ -21,7 +21,7 @@ class DocumentTypesCandidates(BaseModel):
     """
     DocumentTypesCandidates
     """ # noqa: E501
-    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None)
+    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None, description="Overall recognition result")
     candidates: SkipValidation[Optional[List[OneCandidate]]] = Field(alias="Candidates", default=None)
     __properties: ClassVar[List[str]] = ["RecResult", "Candidates"]
 

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

@@ -21,7 +21,7 @@ class DocumentTypesCandidatesList(BaseModel):
     """
     DocumentTypesCandidatesList
     """ # noqa: E501
-    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None)
+    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None, description="Overall recognition result")
     candidates: SkipValidation[Optional[List[OneCandidate]]] = Field(alias="Candidates", default=None)
     __properties: ClassVar[List[str]] = ["RecResult", "Candidates"]
 

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

@@ -23,13 +23,13 @@ class FiberItem(BaseModel):
     """ # noqa: E501
     rect_count: SkipValidation[int] = Field(alias="RectCount", description="For UV_Fibers authenticity result type")
     expected_count: SkipValidation[int] = Field(alias="ExpectedCount", description="Expected fibers number. For UV_Fibers authentication result type")
-    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None)
+    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None, description="For UV_Background authentication result type")
     light_disp: SkipValidation[Optional[int]] = Field(alias="LightDisp", default=None, description="For UV_Background authentication result type")
     rect_array: SkipValidation[List[RectangleCoordinates]] = Field(alias="RectArray", description="Coordinates of located areas for defined fibers type")
     width: SkipValidation[List[int]] = Field(alias="Width", description="Fibers width value for located areas (in pixels)")
     length: SkipValidation[List[int]] = Field(alias="Length", description="Fibers length value for located areas (in pixels)")
     area: SkipValidation[List[int]] = Field(alias="Area", description="Fibers value for areas (in pixels)")
-    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value")
+    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value. Example: [BLUE, GREEN, RED]")
     __properties: ClassVar[List[str]] = ["RectCount", "ExpectedCount", "LightValue", "LightDisp", "RectArray", "Width", "Length", "Area", "ColorValues"]
 
     model_config = ConfigDict(

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

@@ -27,13 +27,13 @@ class FiberResult(AuthenticityCheckResultItem):
     """ # noqa: E501
     rect_count: SkipValidation[int] = Field(alias="RectCount", description="For UV_Fibers authenticity result type")
     expected_count: SkipValidation[int] = Field(alias="ExpectedCount", description="Expected fibers number. For UV_Fibers authentication result type")
-    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None)
+    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None, description="For UV_Background authentication result type")
     light_disp: SkipValidation[Optional[int]] = Field(alias="LightDisp", default=None, description="For UV_Background authentication result type")
     rect_array: SkipValidation[List[RectangleCoordinates]] = Field(alias="RectArray", description="Coordinates of located areas for defined fibers type")
     width: SkipValidation[List[int]] = Field(alias="Width", description="Fibers width value for located areas (in pixels)")
     length: SkipValidation[List[int]] = Field(alias="Length", description="Fibers length value for located areas (in pixels)")
     area: SkipValidation[List[int]] = Field(alias="Area", description="Fibers value for areas (in pixels)")
-    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value")
+    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value. Example: [BLUE, GREEN, RED]")
     __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue", "RectCount", "ExpectedCount", "LightValue", "LightDisp", "RectArray", "Width", "Length", "Area", "ColorValues"]
 
     model_config = ConfigDict(

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

@@ -27,8 +27,8 @@ class IdentItem(BaseModel):
     element_type: SkipValidation[SecurityFeatureType] = Field(alias="ElementType")
     light_index: SkipValidation[Light] = Field(alias="LightIndex")
     area: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="Area", default=None)
-    image: SkipValidation[ImageData] = Field(alias="Image")
-    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage")
+    image: SkipValidation[ImageData] = Field(alias="Image", description="Original image")
+    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage", description="Reference image")
     area_list: SkipValidation[Optional[AreaContainer]] = Field(alias="AreaList", default=None)
     element_id: SkipValidation[Optional[int]] = Field(alias="ElementID", default=None)
     __properties: ClassVar[List[str]] = ["ElementType", "LightIndex", "Area", "Image", "EtalonImage", "AreaList", "ElementID"]

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

@@ -31,8 +31,8 @@ class IdentResult(AuthenticityCheckResultItem):
     element_type: SkipValidation[SecurityFeatureType] = Field(alias="ElementType")
     light_index: SkipValidation[Light] = Field(alias="LightIndex")
     area: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="Area", default=None)
-    image: SkipValidation[ImageData] = Field(alias="Image")
-    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage")
+    image: SkipValidation[ImageData] = Field(alias="Image", description="Original image")
+    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage", description="Reference image")
     area_list: SkipValidation[Optional[AreaContainer]] = Field(alias="AreaList", default=None)
     element_id: SkipValidation[Optional[int]] = Field(alias="ElementID", default=None)
     __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue", "ElementType", "LightIndex", "Area", "Image", "EtalonImage", "AreaList", "ElementID"]

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

@@ -21,7 +21,7 @@ class ImageQualityCheckList(BaseModel):
     """
     ImageQualityCheckList
     """ # noqa: E501
-    result: SkipValidation[CheckResult] = Field(alias="result")
+    result: SkipValidation[CheckResult] = Field(alias="result", description="Overall image quality status, combined from check statuses in the list.")
     list: SkipValidation[List[ImageQualityCheck]] = Field(alias="List")
     count: SkipValidation[float] = Field(alias="Count", description="Number of List array elements")
     __properties: ClassVar[List[str]] = ["result", "List", "Count"]

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

@@ -25,13 +25,13 @@ class ImagesFieldValue(BaseModel):
     """ # noqa: E501
     source: SkipValidation[Source] = Field(alias="source")
     value: SkipValidation[Optional[str]] = Field(alias="value", default=None, description="Base64 encoded image")
-    original_value: SkipValidation[Optional[str]] = Field(alias="originalValue", default=None, description="Base64 encoded image")
+    original_value: SkipValidation[Optional[str]] = Field(alias="originalValue", default=None, description="Only for images from RFID. Image as was originally stored in the RFID chip.")
     original_page_index: SkipValidation[Optional[int]] = Field(alias="originalPageIndex", default=None, description="Original page index")
     page_index: SkipValidation[int] = Field(alias="pageIndex", description="Page index of the image from input list")
     light_index: SkipValidation[Light] = Field(alias="lightIndex")
     container_type: SkipValidation[int] = Field(alias="containerType", description="Same as Result type, but used for safe parsing of not-described values. See Result type.")
-    field_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="fieldRect", default=None)
-    rfid_origin: SkipValidation[Optional[RfidOrigin]] = Field(alias="rfidOrigin", default=None)
+    field_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="fieldRect", default=None, description="Only for images from VISUAL. Coordinates of the image in the normalized image of the document.")
+    rfid_origin: SkipValidation[Optional[RfidOrigin]] = Field(alias="rfidOrigin", default=None, description="Only for images from RFID. Image location in RFID chip.")
     __properties: ClassVar[List[str]] = ["source", "value", "originalValue", "originalPageIndex", "pageIndex", "lightIndex", "containerType", "fieldRect", "rfidOrigin"]
 
     model_config = ConfigDict(

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

@@ -23,8 +23,24 @@ class Light(int, Enum):
     WHITE_SIDE = 4
     WHITE = 6
     IR = 24
+    TRANSMITTED = 32
+    TRANSMITTED_IR = 64
     UV = 128
+    WHITE_UV = 134
+    IR_LUMINESCENCE = 256
     AXIAL_WHITE = 3072
+    IR_720 = 4096
+    IR_940 = 8192
+    ANTI_STOKES = 65536
+    UVC = 524288
+    UVB = 1048576
+    WHITE_OBL = 2097152
+    WHITE_SPECIAL = 4194304
+    OVD = 67108864
+    IR_870_OBL = 268435456
+    HR_WHITE = 1073741830
+    HR_IR = 1073741848
+    HR_UV = 1073741952
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

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

@@ -26,7 +26,7 @@ class OneCandidate(BaseModel):
     id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)")
     p: SkipValidation[float] = Field(alias="P", description="A measure of the likelihood of correct recognition in the analysis of this type of document")
     rotated180: SkipValidation[int] = Field(alias="Rotated180", description="Indicates if the document of the given type is rotated by 180 degrees")
-    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence")
+    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence", description="Indication of the presence of an RFID chip in the document (electronic document indicator)")
     fdsid_list: SkipValidation[Optional[FDSIDList]] = Field(alias="FDSIDList", default=None)
     necessary_lights: SkipValidation[int] = Field(alias="NecessaryLights", description="Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document")
     check_authenticity: SkipValidation[int] = Field(alias="CheckAuthenticity", description="Set of authentication options provided for this type of document (combination of Authenticity enum)")