Merge pull request #300 from regulaforensics/develop

Develop -> Stable

Author: KirylKovaliov

.openapi-generator/FILES

@@ -28,6 +28,7 @@ regula/documentreader/webclient/gen/models/barcode_type.py
 regula/documentreader/webclient/gen/models/bc_pdf417_info.py
 regula/documentreader/webclient/gen/models/bc_roidetect.py
 regula/documentreader/webclient/gen/models/binary_data.py
+regula/documentreader/webclient/gen/models/bsi_tr03135.py
 regula/documentreader/webclient/gen/models/bsiv2_item.py
 regula/documentreader/webclient/gen/models/bsiv2_result.py
 regula/documentreader/webclient/gen/models/byte_array_item.py

regula/documentreader/webclient/gen/__init__.py

@@ -42,6 +42,7 @@
     "BcPDF417INFO",
     "BcROIDETECT",
     "BinaryData",
+    "BsiTr03135",
     "ByteArrayItem",
     "ByteArrayResult",
     "CandidatesListItem",
@@ -312,6 +313,7 @@
     from regula.documentreader.webclient.gen.models.bc_pdf417_info import BcPDF417INFO as BcPDF417INFO
     from regula.documentreader.webclient.gen.models.bc_roidetect import BcROIDETECT as BcROIDETECT
     from regula.documentreader.webclient.gen.models.binary_data import BinaryData as BinaryData
+    from regula.documentreader.webclient.gen.models.bsi_tr03135 import BsiTr03135 as BsiTr03135
     from regula.documentreader.webclient.gen.models.byte_array_item import ByteArrayItem as ByteArrayItem
     from regula.documentreader.webclient.gen.models.byte_array_result import ByteArrayResult as ByteArrayResult
     from regula.documentreader.webclient.gen.models.candidates_list_item import CandidatesListItem as CandidatesListItem
@@ -588,6 +590,7 @@
 from regula.documentreader.webclient.gen.models.bc_pdf417_info import BcPDF417INFO as BcPDF417INFO
 from regula.documentreader.webclient.gen.models.bc_roidetect import BcROIDETECT as BcROIDETECT
 from regula.documentreader.webclient.gen.models.binary_data import BinaryData as BinaryData
+from regula.documentreader.webclient.gen.models.bsi_tr03135 import BsiTr03135 as BsiTr03135
 from regula.documentreader.webclient.gen.models.byte_array_item import ByteArrayItem as ByteArrayItem
 from regula.documentreader.webclient.gen.models.byte_array_result import ByteArrayResult as ByteArrayResult
 from regula.documentreader.webclient.gen.models.candidates_list_item import CandidatesListItem as CandidatesListItem

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

@@ -26,6 +26,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.binary_data import BinaryData
+    from regula.documentreader.webclient.gen.models.bsi_tr03135 import BsiTr03135
     from regula.documentreader.webclient.gen.models.byte_array_item import ByteArrayItem
     from regula.documentreader.webclient.gen.models.byte_array_result import ByteArrayResult
     from regula.documentreader.webclient.gen.models.candidates_list_item import CandidatesListItem
@@ -283,6 +284,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.binary_data import BinaryData
+from regula.documentreader.webclient.gen.models.bsi_tr03135 import BsiTr03135
 from regula.documentreader.webclient.gen.models.byte_array_item import ByteArrayItem
 from regula.documentreader.webclient.gen.models.byte_array_result import ByteArrayResult
 from regula.documentreader.webclient.gen.models.candidates_list_item import CandidatesListItem

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

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class BsiTr03135(BaseModel):
+    """
+    BsiTr03135
+    """ # noqa: E501
+    generate_result: SkipValidation[Optional[bool]] = Field(alias="generateResult", default=None, description="When enabled, returns processing results in accordance with the BSI TR-03135 standard in addition to the existing processing results.")
+    __properties: ClassVar[List[str]] = ["generateResult"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        arbitrary_types_allowed=True,
+        use_enum_values=True
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BsiTr03135 from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BsiTr03135 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "generateResult": obj.get("generateResult")
+        })
+        return _obj
+
+

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

@@ -12,6 +12,7 @@
 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.bsi_tr03135 import BsiTr03135
 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
@@ -103,8 +104,8 @@ class ProcessParams(BaseModel):
     disable_auth_resolution_filter: SkipValidation[Optional[bool]] = Field(alias="disableAuthResolutionFilter", default=None, description="This parameter if enabled will ignore the minimum barcode resolution needed to start processing.")
     strict_security_checks: SkipValidation[Optional[bool]] = Field(alias="strictSecurityChecks", default=None, description="When enabled, this parameter marks security checks that don’t meet minimum requirements as 'Failed' (instead of 'WasNotDone'), which causes the overall security status to be 'Failed'.")
     return_transliterated_fields: SkipValidation[Optional[bool]] = Field(alias="returnTransliteratedFields", default=None, description="Allows transliteration to be turned on or off; by default, it is enabled.")
-    bsi_tr03135_results: SkipValidation[Optional[bool]] = Field(alias="bsiTr03135Results", default=None, description="When enabled, returns processing results in accordance with the BSI TR-03135 standard in addition to the existing processing results.")
-    __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "fieldTypesIgnoreFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry", "generateAlpha2Codes", "pdfPagesLimit", "disableAuthResolutionFilter", "strictSecurityChecks", "returnTransliteratedFields", "bsiTr03135Results"]
+    bsi_tr03135: SkipValidation[Optional[BsiTr03135]] = Field(alias="bsiTr03135", default=None)
+    __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "fieldTypesIgnoreFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry", "generateAlpha2Codes", "pdfPagesLimit", "disableAuthResolutionFilter", "strictSecurityChecks", "returnTransliteratedFields", "bsiTr03135"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -166,6 +167,9 @@ def to_dict(self) -> Dict[str, Any]:
         # override the default output from pydantic by calling `to_dict()` of auth_params
         if self.auth_params and isinstance(self.auth_params, AuthParams):
             _dict['authParams'] = self.auth_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of bsi_tr03135
+        if self.bsi_tr03135 and isinstance(self.bsi_tr03135, BsiTr03135):
+            _dict['bsiTr03135'] = self.bsi_tr03135.to_dict()
         return _dict
 
     @classmethod
@@ -245,7 +249,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "disableAuthResolutionFilter": obj.get("disableAuthResolutionFilter"),
             "strictSecurityChecks": obj.get("strictSecurityChecks"),
             "returnTransliteratedFields": obj.get("returnTransliteratedFields"),
-            "bsiTr03135Results": obj.get("bsiTr03135Results")
+            "bsiTr03135": BsiTr03135.from_dict(obj["bsiTr03135"]) if obj.get("bsiTr03135") is not None else None
         })
         return _obj