SP-22413 - Fix authenticity

.openapi-generator/FILES

@@ -135,6 +135,7 @@ regula/documentreader/webclient/gen/models/out_data.py
 regula/documentreader/webclient/gen/models/out_data_transaction_images_field_value.py
 regula/documentreader/webclient/gen/models/p_array_field.py
 regula/documentreader/webclient/gen/models/parsed_data.py
+regula/documentreader/webclient/gen/models/parsing_error_codes.py
 regula/documentreader/webclient/gen/models/parsing_notification_codes.py
 regula/documentreader/webclient/gen/models/per_document_config.py
 regula/documentreader/webclient/gen/models/photo_ident_item.py

README.md

@@ -39,7 +39,7 @@ with open("australia_passport.jpg", "rb") as f:
 
 with DocumentReaderApi(host='http://localhost:8080') as api:
     params = ProcessParams(
-        scenario=Scenario.FULL_PROCESS,
+        scenario=Scenario.FULLPROCESS,
         result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
     )
     request = RecognitionRequest(process_params=params, images=[input_image])

example/example.py

@@ -63,13 +63,13 @@
     #                                                      if FULL_PROCESS then auth is None
 
     doc_ir_b900_blank = doc_ir_b900.checks_by_element(SecurityFeatureType.BLANK) \
-        if doc_authenticity is not None else None
+        if doc_ir_b900 is not None else None
 
     doc_image_pattern = doc_authenticity.image_pattern_checks \
         if doc_authenticity is not None else None
 
     doc_image_pattern_blank = doc_image_pattern.checks_by_element(SecurityFeatureType.BLANK) \
-        if doc_authenticity is not None else None
+        if doc_image_pattern is not None else None
 
     # images fields example
     document_image = response.images.get_field(GraphicFieldType.DOCUMENT_FRONT).get_value()

regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py

@@ -14,77 +14,107 @@ class AuthenticityCheckList(GenAuthenticityCheckList):
     @property
     def uv_luminescence_checks(self) -> Optional[SecurityFeatureChecks]:
         result = self.__result_by_type(AuthenticityResultType.UV_LUMINESCENCE)
-        return SecurityFeatureChecks.from_dict(result.to_dict())
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
 
     @property
     def ir_b900_checks(self) -> Optional[SecurityFeatureChecks]:
         result = self.__result_by_type(AuthenticityResultType.IR_B900)
-        return SecurityFeatureChecks.from_dict(result.to_dict())
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
 
     @property
     def image_pattern_checks(self) -> Optional[IdentChecks]:
         result = self.__result_by_type(AuthenticityResultType.IMAGE_PATTERN)
-        return IdentChecks.from_dict(result.to_dict())
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
 
     @property
     def axial_protection_checks(self) -> Optional[SecurityFeatureChecks]:
         result = self.__result_by_type(AuthenticityResultType.AXIAL_PROTECTION)
-        return SecurityFeatureChecks.from_dict(result.to_dict())
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
 
     @property
     def uv_fiber_checks(self) -> Optional[FiberChecks]:
         result = self.__result_by_type(AuthenticityResultType.UV_FIBERS)
-        return FiberChecks.from_dict(result.to_dict())
+        if result:
+            return FiberChecks.from_json(result.to_json())
+        return None
 
     @property
     def ir_visibility_checks(self) -> Optional[IdentChecks]:
         result = self.__result_by_type(AuthenticityResultType.IR_VISIBILITY)
-        return IdentChecks.from_dict(result.to_dict())
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
 
     @property
     def ocr_security_text_checks(self) -> Optional[OCRSecurityTextChecks]:
         result = self.__result_by_type(AuthenticityResultType.OCR_SECURITY_TEXT)
-        return OCRSecurityTextChecks.from_dict(result.to_dict())
+        if result:
+            return OCRSecurityTextChecks.from_json(result.to_json())
+        return None
 
     @property
     def ipi_checks(self) -> Optional[ImageIdentChecks]:
         result = self.__result_by_type(AuthenticityResultType.IPI)
-        return ImageIdentChecks.from_dict(result.to_dict())
+        if result:
+            return ImageIdentChecks.from_json(result.to_json())
+        return None
 
     @property
     def embed_image_checks(self) -> Optional[SecurityFeatureChecks]:
         result = self.__result_by_type(AuthenticityResultType.PHOTO_EMBED_TYPE)
-        return SecurityFeatureChecks.from_dict(result.to_dict())
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
 
     @property
     def holograms_checks(self) -> Optional[SecurityFeatureChecks]:
         result = self.__result_by_type(AuthenticityResultType.HOLOGRAMS)
-        return SecurityFeatureChecks.from_dict(result.to_dict())
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
 
     @property
     def photo_area_checks(self) -> Optional[SecurityFeatureChecks]:
         result = self.__result_by_type(AuthenticityResultType.PHOTO_AREA)
-        return SecurityFeatureChecks.from_dict(result.to_dict())
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
 
     @property
     def portrait_comparison_checks(self) -> Optional[IdentChecks]:
         result = self.__result_by_type(AuthenticityResultType.PORTRAIT_COMPARISON)
-        return IdentChecks.from_dict(result.to_dict())
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
 
     @property
     def barcode_format_checks(self) -> Optional[SecurityFeatureChecks]:
         result = self.__result_by_type(AuthenticityResultType.BARCODE_FORMAT_CHECK)
-        return SecurityFeatureChecks.from_dict(result.to_dict())
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
 
     @property
     def kinegram_checks(self) -> Optional[IdentChecks]:
         result = self.__result_by_type(AuthenticityResultType.KINEGRAM)
-        return IdentChecks.from_dict(result.to_dict())
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
 
     @property
     def letter_screen_checks(self) -> Optional[IdentChecks]:
         result = self.__result_by_type(AuthenticityResultType.LETTER_SCREEN)
-        return IdentChecks.from_dict(result.to_dict())
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
 
     def __result_by_type(self, authenticity_type: int) -> Optional[AuthenticityCheckResult]:
         for result in self.list:

regula/documentreader/webclient/ext/models/authenticity/fiber.py

@@ -1,11 +1,11 @@
-from typing import List
+from typing import List, cast
 
 from regula.documentreader.webclient.gen.models import FiberResult, AuthenticityCheckResult
 
 
 class FiberChecks(AuthenticityCheckResult):
 
     @property
-    def list(self) -> List[FiberResult]:
-        # noinspection PyTypeChecker
-        return super().list
+    def checks_list(self) -> List[FiberResult]:
+        fiber_list: List[FiberResult] = cast(List[FiberResult], self.list)
+        return fiber_list

regula/documentreader/webclient/ext/models/authenticity/ident.py

@@ -1,15 +1,15 @@
-from typing import List
+from typing import List, cast
 
 from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, IdentResult
 
 
 class IdentChecks(AuthenticityCheckResult):
 
     @property
-    def list(self) -> List[IdentResult]:
-        # noinspection PyTypeChecker
-        return self.list
+    def checks_list(self) -> List[IdentResult]:
+        ident_list: List[IdentResult] = cast(List[IdentResult], self.list)
+        return ident_list
 
     # element_type is SecurityFeatureType
     def checks_by_element(self, element_type: int) -> List[IdentResult]:
-        return [check for check in self.list if check.element_type == element_type]
+        return [check for check in self.checks_list if check.element_type == element_type]

regula/documentreader/webclient/ext/models/authenticity/image_ident.py

@@ -1,11 +1,11 @@
-from typing import List
+from typing import List, cast
 
 from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, PhotoIdentResult
 
 
 class ImageIdentChecks(AuthenticityCheckResult):
 
     @property
-    def list(self) -> List[PhotoIdentResult]:
-        # noinspection PyTypeChecker
-        return self.list
+    def checks_list(self) -> List[PhotoIdentResult]:
+        image_ident_list: List[PhotoIdentResult] = cast(List[PhotoIdentResult], self.list)
+        return image_ident_list

regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py

@@ -1,11 +1,11 @@
-from typing import List
+from typing import List, cast
 
 from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, OCRSecurityTextResult
 
 
 class OCRSecurityTextChecks(AuthenticityCheckResult):
 
     @property
-    def list(self) -> List[OCRSecurityTextResult]:
-        # noinspection PyTypeChecker
-        return self.list
+    def checks_list(self) -> List[OCRSecurityTextResult]:
+        ocr_security_text_list: List[OCRSecurityTextResult] = cast(List[OCRSecurityTextResult], self.list)
+        return ocr_security_text_list

regula/documentreader/webclient/ext/models/authenticity/security_feature.py

@@ -1,15 +1,15 @@
-from typing import List, Optional
+from typing import List, cast
 
 from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, SecurityFeatureResult
 
 
 class SecurityFeatureChecks(AuthenticityCheckResult):
 
     @property
-    def list(self) -> List[SecurityFeatureResult]:
-        # noinspection PyTypeChecker
-        return self.list
+    def checks_list(self) -> List[SecurityFeatureResult]:
+        security_feature_list: List[SecurityFeatureResult] = cast(List[SecurityFeatureResult], self.list)
+        return security_feature_list
 
     # element_type is SecurityFeatureType
     def checks_by_element(self, element_type: int) -> List[SecurityFeatureResult]:
-        return [check for check in self.list if check.element_type == element_type]
+        return [check for check in self.checks_list if check.element_type == element_type]

regula/documentreader/webclient/ext/models/images.py

@@ -33,8 +33,8 @@ class Images(GenImages):
     def get_field(self, field_type: int) -> Optional[ImagesField]:
         for field in self.field_list:
             if field.field_type == field_type:
-                return ImagesField.from_dict(field.to_dict())
+                return ImagesField.from_json(field.to_json())
         return None
 
     def get_fields(self, field_type: int) -> List[ImagesField]:
-        return [ImagesField.from_dict(field.to_dict()) for field in self.field_list if field.field_type == field_type]
+        return [ImagesField.from_json(field.to_json()) for field in self.field_list if field.field_type == field_type]

regula/documentreader/webclient/ext/models/recognition_response.py

@@ -20,7 +20,7 @@ def __init__(self, process_response: ProcessResponse):
     def text(self) -> Optional[Text]:
         result = self.result_by_type(Result.TEXT)
         if result:
-            return Text.from_dict(result.text.to_dict())
+            return Text.from_json(result.text.to_json())
         return None
 
     @property
@@ -34,13 +34,13 @@ def status(self) -> Optional[Status]:
     def images(self) -> Optional[Images]:
         result = self.result_by_type(Result.IMAGES)
         if result:
-            return Images.from_dict(result.images.to_dict())
+            return Images.from_json(result.images.to_json())
         return None
 
     def authenticity(self, page_idx=0) -> Optional[AuthenticityCheckList]:
         result = self.pageable_result_by_type(Result.AUTHENTICITY, page_idx)
         if result:
-            return AuthenticityCheckList.from_dict(result.authenticity_check_list.to_dict())
+            return AuthenticityCheckList.from_json(result.authenticity_check_list.to_json())
         return None
 
     def image_quality_checks(self, page_idx=0) -> Optional[ImageQualityCheckList]:

regula/documentreader/webclient/ext/models/text.py

@@ -11,12 +11,12 @@ def get_field(self, field_type: int, lcid: int = None) -> Optional[TextField]:
         for field in self.field_list:
             if field.field_type == field_type:
                 if lcid is not None and field.lcid == lcid:
-                    return TextField.from_dict(field.to_dict())
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and field.lcid == LCID.LATIN:
-                    return TextField.from_dict(field.to_dict())
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and result is None:
                     result = field
-        return TextField.from_dict(result.to_dict())
+        return TextField.from_json(result.to_json())
 
     def get_field_value(self, field_type: int, lcid: int = None) -> Optional[str]:
         field = self.get_field(field_type, lcid)
@@ -27,12 +27,12 @@ def get_field_by_name(self, field_name: str, lcid: int = None) -> Optional[TextF
         for field in self.field_list:
             if field.field_name == field_name:
                 if lcid is not None and field.lcid == lcid:
-                    return TextField.from_dict(field.to_dict())
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and field.lcid == LCID.LATIN:
-                    return TextField.from_dict(field.to_dict())
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and result is None:
                     result = field
-        return TextField.from_dict(result.to_dict())
+        return TextField.from_json(result.to_json())
 
     def get_field_value_by_name(self, field_name: str, lcid: int = None) -> Optional[str]:
         field = self.get_field_by_name(field_name, lcid)

regula/documentreader/webclient/gen/__init__.py

@@ -150,6 +150,7 @@
 from regula.documentreader.webclient.gen.models.out_data_transaction_images_field_value import OutDataTransactionImagesFieldValue
 from regula.documentreader.webclient.gen.models.p_array_field import PArrayField
 from regula.documentreader.webclient.gen.models.parsed_data import ParsedData
+from regula.documentreader.webclient.gen.models.parsing_error_codes import ParsingErrorCodes
 from regula.documentreader.webclient.gen.models.parsing_notification_codes import ParsingNotificationCodes
 from regula.documentreader.webclient.gen.models.per_document_config import PerDocumentConfig
 from regula.documentreader.webclient.gen.models.photo_ident_item import PhotoIdentItem

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

@@ -131,6 +131,7 @@
 from regula.documentreader.webclient.gen.models.out_data_transaction_images_field_value import OutDataTransactionImagesFieldValue
 from regula.documentreader.webclient.gen.models.p_array_field import PArrayField
 from regula.documentreader.webclient.gen.models.parsed_data import ParsedData
+from regula.documentreader.webclient.gen.models.parsing_error_codes import ParsingErrorCodes
 from regula.documentreader.webclient.gen.models.parsing_notification_codes import ParsingNotificationCodes
 from regula.documentreader.webclient.gen.models.per_document_config import PerDocumentConfig
 from regula.documentreader.webclient.gen.models.photo_ident_item import PhotoIdentItem