regula-documentreader-webclient 8.4.554rc0__py3-none-any.whl → 8.4.556.dev0__py3-none-any.whl

regula/documentreader/webclient/gen/__init__.py

@@ -92,6 +92,7 @@ __all__ = [
     "FieldItem",
     "FileImage",
     "GetTransactionsByTagResponse",
+    "GlaresCheckParams",
     "GraphData",
     "GraphicField",
     "GraphicFieldType",
@@ -339,6 +340,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.field_item import FieldItem as FieldItem
     from regula.documentreader.webclient.gen.models.file_image import FileImage as FileImage
     from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse as GetTransactionsByTagResponse
+    from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams as GlaresCheckParams
     from regula.documentreader.webclient.gen.models.graph_data import GraphData as GraphData
     from regula.documentreader.webclient.gen.models.graphic_field import GraphicField as GraphicField
     from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType as GraphicFieldType
@@ -592,6 +594,7 @@ from regula.documentreader.webclient.gen.models.fiber_result import FiberResult
 from regula.documentreader.webclient.gen.models.field_item import FieldItem as FieldItem
 from regula.documentreader.webclient.gen.models.file_image import FileImage as FileImage
 from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse as GetTransactionsByTagResponse
+from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams as GlaresCheckParams
 from regula.documentreader.webclient.gen.models.graph_data import GraphData as GraphData
 from regula.documentreader.webclient.gen.models.graphic_field import GraphicField as GraphicField
 from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType as GraphicFieldType

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

@@ -77,6 +77,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.field_item import FieldItem
     from regula.documentreader.webclient.gen.models.file_image import FileImage
     from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse
+    from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams
     from regula.documentreader.webclient.gen.models.graph_data import GraphData
     from regula.documentreader.webclient.gen.models.graphic_field import GraphicField
     from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType
@@ -312,6 +313,7 @@ from regula.documentreader.webclient.gen.models.fiber_result import FiberResult
 from regula.documentreader.webclient.gen.models.field_item import FieldItem
 from regula.documentreader.webclient.gen.models.file_image import FileImage
 from regula.documentreader.webclient.gen.models.get_transactions_by_tag_response import GetTransactionsByTagResponse
+from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams
 from regula.documentreader.webclient.gen.models.graph_data import GraphData
 from regula.documentreader.webclient.gen.models.graphic_field import GraphicField
 from regula.documentreader.webclient.gen.models.graphic_field_type import GraphicFieldType

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

@@ -68,6 +68,8 @@ class CheckDiagnose(int, Enum):
     FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR = 84
     FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR = 85
     FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION = 86
+    FIELD_POS_CORRECTOR_AGE_CHECK_ERROR = 87
+    FIELD_POS_CORRECTOR_SEX_CHECK_ERROR = 88
     OVI_IR_INVISIBLE = 90
     OVI_INSUFFICIENT_AREA = 91
     OVI_COLOR_INVARIABLE = 92

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

@@ -0,0 +1,84 @@
+# 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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic import SkipValidation, Field
+
+class GlaresCheckParams(BaseModel):
+    """
+    GlaresCheckParams
+    """ # noqa: E501
+    img_margin_part: SkipValidation[Optional[float]] = Field(alias="imgMarginPart", default=None, description="Margin from the edges of the image. 0.35 = 35%")
+    max_glaring_part: SkipValidation[Optional[float]] = Field(alias="maxGlaringPart", default=None, description="The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%")
+    __properties: ClassVar[List[str]] = ["imgMarginPart", "maxGlaringPart"]
+
+    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 GlaresCheckParams 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 GlaresCheckParams from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "imgMarginPart": obj.get("imgMarginPart"),
+            "maxGlaringPart": obj.get("maxGlaringPart")
+        })
+        return _obj
+
+

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

@@ -11,6 +11,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams
 from regula.documentreader.webclient.gen.models.input_image_quality_checks import InputImageQualityChecks
 from typing import Optional, Set
 from typing_extensions import Self
@@ -29,7 +30,8 @@ class ImageQA(BaseModel):
     moire_check: SkipValidation[Optional[bool]] = Field(alias="moireCheck", default=None, description="This option enables screen capture (moire patterns) check while performing image quality validation.")
     document_position_indent: SkipValidation[Optional[int]] = Field(alias="documentPositionIndent", default=None, description="This parameter specifies the necessary margin. Default 0.")
     expected_pass: SkipValidation[Optional[List[InputImageQualityChecks]]] = Field(alias="expectedPass", default=None, description="This parameter controls the quality checks that the image should pass to be considered a valid input during the scanning process.")
-    __properties: ClassVar[List[str]] = ["brightnessThreshold", "dpiThreshold", "angleThreshold", "focusCheck", "glaresCheck", "colornessCheck", "moireCheck", "documentPositionIndent", "expectedPass"]
+    glares_check_params: SkipValidation[Optional[GlaresCheckParams]] = Field(alias="glaresCheckParams", default=None)
+    __properties: ClassVar[List[str]] = ["brightnessThreshold", "dpiThreshold", "angleThreshold", "focusCheck", "glaresCheck", "colornessCheck", "moireCheck", "documentPositionIndent", "expectedPass", "glaresCheckParams"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -72,6 +74,9 @@ class ImageQA(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of glares_check_params
+        if self.glares_check_params:
+            _dict['glaresCheckParams'] = self.glares_check_params.to_dict()
         return _dict
 
     @classmethod
@@ -92,7 +97,8 @@ class ImageQA(BaseModel):
             "colornessCheck": obj.get("colornessCheck"),
             "moireCheck": obj.get("moireCheck"),
             "documentPositionIndent": obj.get("documentPositionIndent"),
-            "expectedPass": obj.get("expectedPass")
+            "expectedPass": obj.get("expectedPass"),
+            "glaresCheckParams": GlaresCheckParams.from_dict(obj["glaresCheckParams"]) if obj.get("glaresCheckParams") is not None else None
         })
         return _obj
 

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

@@ -73,6 +73,8 @@ class SecurityFeatureType(int, Enum):
     LIVENESS_BLACK_AND_WHITE_COPY_CHECK = 53
     LIVENESS_DYNAPRINT = 54
     LIVENESS_GEOMETRY_CHECK = 55
+    AGE_CHECK = 56
+    SEX_CHECK = 57
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{regula_documentreader_webclient-8.4.554rc0.dist-info → regula_documentreader_webclient-8.4.556.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 8.4.554rc0
+Version: 8.4.556.dev0
 Summary: Regula's Document Reader python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_documentreader_webclient-8.4.554rc0.dist-info → regula_documentreader_webclient-8.4.556.dev0.dist-info}/RECORD

@@ -17,7 +17,7 @@ regula/documentreader/webclient/ext/models/authenticity/ident.py,sha256=DSmXEJ-v
 regula/documentreader/webclient/ext/models/authenticity/image_ident.py,sha256=QmKTghP4Lo7bHBEubwzsVt1ob97NNaNIu_5QN_LUF9M,370
 regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py,sha256=BV0h2_UDrwUlWczoJQW8qTSkdZ0icm0n0pPDRY9Qwq4,407
 regula/documentreader/webclient/ext/models/authenticity/security_feature.py,sha256=t8egDyT1wlGvsyvZboAFOvcaYsALGpj41E50FUbvx68,622
-regula/documentreader/webclient/gen/__init__.py,sha256=rA4GthlUHZ7-2PJ8BsPfcnVU1apERvvpOdGRdf42f5w,60450
+regula/documentreader/webclient/gen/__init__.py,sha256=GCZqiHii-kQ6CTxfkpCwcKqW7S9v2jJutKst8bxS8a4,60707
 regula/documentreader/webclient/gen/api_client.py,sha256=BZ1SIy0PwA4khadeMet9fNj8pt1j_OaaebUSHChq31k,27673
 regula/documentreader/webclient/gen/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
 regula/documentreader/webclient/gen/configuration.py,sha256=0hMqlAxYaL30050LBPnHrh6Sg1EIfSfQLr0eGNRNz1w,18084
@@ -28,7 +28,7 @@ regula/documentreader/webclient/gen/api/__init__.py,sha256=v4_OMiqFnSqq6QQtO51dX
 regula/documentreader/webclient/gen/api/healthcheck_api.py,sha256=g3Q3XsdgYfEmmdgnnspRX5DluONia4bDANKUZLRMMlQ,29942
 regula/documentreader/webclient/gen/api/process_api.py,sha256=RnJXVZy-M1bNfiXK0tHEQEuhOgxkXk9jMG-hpZfTjZ8,12123
 regula/documentreader/webclient/gen/api/transaction_api.py,sha256=lVfSEe4-iWrP_2gdQ3Pg5XJu9MNtKK7fyKJC-M0y8Rk,65548
-regula/documentreader/webclient/gen/models/__init__.py,sha256=Km2xYUXsUUzuK_OVjCgKp5-IQavZULGVWANpyKZNuko,42927
+regula/documentreader/webclient/gen/models/__init__.py,sha256=CA-hi89GT7USlPrYyOtazj0BGeMQtWFPU1pDID5dLWk,43117
 regula/documentreader/webclient/gen/models/area_array.py,sha256=cWpxUR1lpgj1UalajIiU8s3OjhWEZqYli9bV02ixT2M,3684
 regula/documentreader/webclient/gen/models/area_container.py,sha256=E6e1gPW516A0KCAmHm05ad_I0yD3FauruZgNxU-EIdA,3665
 regula/documentreader/webclient/gen/models/auth_params.py,sha256=XY1Exfwh68u6FKGhZdjnzHPmB2pFlKxiywcV7f5dj2E,6743
@@ -50,7 +50,7 @@ regula/documentreader/webclient/gen/models/byte_array_item.py,sha256=Ki6Vqa2mVHW
 regula/documentreader/webclient/gen/models/byte_array_result.py,sha256=2N05ADgeJwD7A7dvFS1o6mjKsPPH_-0RcMR51-z5Khs,2872
 regula/documentreader/webclient/gen/models/candidates_list_item.py,sha256=V6uX8f2AVVqtNqiwMa70_oBzKsrnZq1XNzyLLQ9b7b4,2888
 regula/documentreader/webclient/gen/models/certificate_data.py,sha256=X4vRnZI4KaFIKCsBCueyWc6gz0n_gBgvru9liN93Auo,2500
-regula/documentreader/webclient/gen/models/check_diagnose.py,sha256=youy615XJwZ9-TF251ukDCcsdXuNhYKMJM6VR5fd0p8,5322
+regula/documentreader/webclient/gen/models/check_diagnose.py,sha256=TocdHuOjI48PMOC4rrdpl_Q80lVkb_-6mTAoDEZppjo,5412
 regula/documentreader/webclient/gen/models/check_result.py,sha256=8dR5KtJtyeSv4sW6oyJz9HXbUF-xpeJnSDqDp5Zk1ZE,570
 regula/documentreader/webclient/gen/models/chosen_document_type.py,sha256=PvHf0VSxqscN8TRjljxapEy3mLRSe24vciyGJiA2fDA,5447
 regula/documentreader/webclient/gen/models/chosen_document_type_result.py,sha256=BTPpnLNnACMAKNRB38UO8nGLV8Mi5-6vt_HaE5rfQNA,3559
@@ -99,6 +99,7 @@ regula/documentreader/webclient/gen/models/fiber_result.py,sha256=TJSk901NkDYWUX
 regula/documentreader/webclient/gen/models/field_item.py,sha256=N6_rNKbqdn0XA9PxqWQvwMEMeLdJqB5AS0sF8ETSHMY,3028
 regula/documentreader/webclient/gen/models/file_image.py,sha256=PMQxYkIJb8qcJ21MawrYfhXIJyq-FUKvQ_91RI8ngnQ,2476
 regula/documentreader/webclient/gen/models/get_transactions_by_tag_response.py,sha256=MUtsAhwW9lubm2ilRP19yk8kDc37o4l6oGZsWu0SpOQ,2885
+regula/documentreader/webclient/gen/models/glares_check_params.py,sha256=SULWihM3laHJK6UDOvy5kZXVUJTMKxLMxSU58t1DzgA,2837
 regula/documentreader/webclient/gen/models/graph_data.py,sha256=LDBmSGafS6IY6z06GtJI5mi1ySQvAgjPiiCiE0H1rU4,3527
 regula/documentreader/webclient/gen/models/graphic_field.py,sha256=1oXthlTL8Wc-tsycd8GK3ghsGilwesvZ_zz0Knwq45E,3594
 regula/documentreader/webclient/gen/models/graphic_field_type.py,sha256=0DV7PkG3Lym6GIGoytkyrihpXQAuIbGz2hXSDMxIetY,1166
@@ -109,7 +110,7 @@ regula/documentreader/webclient/gen/models/healthcheck_documents_database.py,sha
 regula/documentreader/webclient/gen/models/ident_item.py,sha256=zknhQd-0Tv4Q0dxTwsGLzsLAI8KmloBNtWbpdKBkpGI,4581
 regula/documentreader/webclient/gen/models/ident_result.py,sha256=PgYF9CjNUepSre9kH16gwN-fsoNzQIqr9rabfyngV4s,5241
 regula/documentreader/webclient/gen/models/image_data.py,sha256=s8GTx-UadfPNYgqqIdalolz7iaDxwkc4C2afsI_oFuY,2592
-regula/documentreader/webclient/gen/models/image_qa.py,sha256=WaLTreYEtGelb1KOD7HUosRLIQuFSDmkdBmE6zygeyw,5044
+regula/documentreader/webclient/gen/models/image_qa.py,sha256=MB1P2r5rFYCxJejRLh8tpXDedad4kfvthibANSgqjTU,5629
 regula/documentreader/webclient/gen/models/image_quality_check.py,sha256=oYudOAhctjhcAEqpAPEcMyAWbN4XhfLVCVgVhJ3KU8Y,3858
 regula/documentreader/webclient/gen/models/image_quality_check_list.py,sha256=cqTKbpzq4ULjWg5Q4-gPtlIhqpmx9mTLMacVnoyufD4,3295
 regula/documentreader/webclient/gen/models/image_quality_check_list_item.py,sha256=cLULYMR9eBphv42v0ml5qL__VgerKmkp_ZH-SC-9AdY,2936
@@ -220,7 +221,7 @@ regula/documentreader/webclient/gen/models/rfidpkd_resource_type.py,sha256=kAXsc
 regula/documentreader/webclient/gen/models/scenario.py,sha256=-KpZ-K-YwK8pNz3-lDg6gofCZppDNfI6wFYTTihlmTs,1062
 regula/documentreader/webclient/gen/models/security_feature_item.py,sha256=8h0r6J10maF_qmeBxglJPqbzWGaWg7HC-rcrAHMQaE0,4112
 regula/documentreader/webclient/gen/models/security_feature_result.py,sha256=EI_UPZZA_GA7hBf6FSC3V6kZh5C77g4oyf7MCJNBxkg,4772
-regula/documentreader/webclient/gen/models/security_feature_type.py,sha256=Z9qIAKRFU_MvpSkHABQLssAFXv8uJJQzefZYwnk7Bi8,2285
+regula/documentreader/webclient/gen/models/security_feature_type.py,sha256=5j0Dt0aJGA9kNU6xhbwkEXHGGiqhaba0GBPba8br1NY,2323
 regula/documentreader/webclient/gen/models/security_object_certificates.py,sha256=F-pbPcpsp51_YW-d3VgZ7gn7rVFS81tfhPlaoTfjYpQ,2886
 regula/documentreader/webclient/gen/models/source.py,sha256=CjKAJPFDZyN8lcoIhBl57Cxrls0m58dbjTPz81Sur10,641
 regula/documentreader/webclient/gen/models/source_validity.py,sha256=z5ckCcvZZ6IEVu0G7AKz0drQMLIRbY8TImMFVSlLeuo,2637
@@ -259,7 +260,7 @@ regula/documentreader/webclient/gen/models/verification_result.py,sha256=E6bCVR5
 regula/documentreader/webclient/gen/models/verified_field_map.py,sha256=QjCCjZ82WhT5uzdFthwfiX4Kgi5RL_m7E0NprLhHAJs,4863
 regula/documentreader/webclient/gen/models/visibility.py,sha256=GACgQd_8lx_cwMwI5lCi7cTxEWxw2atbJo6uI4mTKpQ,602
 regula/documentreader/webclient/gen/models/visual_extended_field_item.py,sha256=ym9y5RWEoE_92NrJfcrKA6OCtE_E8IOuiRHF2Ar3EQc,5245
-regula_documentreader_webclient-8.4.554rc0.dist-info/METADATA,sha256=zeMeJ9hUU-vruvDmAA4Pp8f0VxPys1ZaI7nhQKzM6TQ,4034
-regula_documentreader_webclient-8.4.554rc0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
-regula_documentreader_webclient-8.4.554rc0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
-regula_documentreader_webclient-8.4.554rc0.dist-info/RECORD,,
+regula_documentreader_webclient-8.4.556.dev0.dist-info/METADATA,sha256=biEtGzG7KuW5CyIOYPA8v3MvVd9aq_FIJSC1crD58zI,4036
+regula_documentreader_webclient-8.4.556.dev0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
+regula_documentreader_webclient-8.4.556.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
+regula_documentreader_webclient-8.4.556.dev0.dist-info/RECORD,,