regula-documentreader-webclient 9.8.982.dev0__py3-none-any.whl → 9.8.984.dev0__py3-none-any.whl

regula/documentreader/webclient/gen/__init__.py

@@ -157,6 +157,7 @@ __all__ = [
     "MrzPositionItem",
     "OCRSecurityTextItem",
     "OCRSecurityTextResult",
+    "OcclusionCheckParams",
     "OneCandidate",
     "OneCandidateItem",
     "OriginalSymbol",
@@ -429,6 +430,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem as MrzPositionItem
     from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem as OCRSecurityTextItem
     from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult as OCRSecurityTextResult
+    from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams as OcclusionCheckParams
     from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate as OneCandidate
     from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem as OneCandidateItem
     from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol as OriginalSymbol
@@ -707,6 +709,7 @@ from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzD
 from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem as MrzPositionItem
 from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem as OCRSecurityTextItem
 from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult as OCRSecurityTextResult
+from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams as OcclusionCheckParams
 from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate as OneCandidate
 from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem as OneCandidateItem
 from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol as OriginalSymbol

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

@@ -141,6 +141,7 @@ if __import__("typing").TYPE_CHECKING:
     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
+    from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams
     from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
     from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem
     from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol
@@ -400,6 +401,7 @@ from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzD
 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
+from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams
 from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
 from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem
 from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol

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

@@ -13,6 +13,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, Stri
 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 regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic import SkipValidation, Field
@@ -31,7 +32,8 @@ class ImageQA(BaseModel):
     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.")
     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"]
+    occlusion_check_params: SkipValidation[Optional[OcclusionCheckParams]] = Field(alias="occlusionCheckParams", default=None)
+    __properties: ClassVar[List[str]] = ["brightnessThreshold", "dpiThreshold", "angleThreshold", "focusCheck", "glaresCheck", "colornessCheck", "moireCheck", "documentPositionIndent", "expectedPass", "glaresCheckParams", "occlusionCheckParams"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -77,6 +79,9 @@ class ImageQA(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of glares_check_params
         if self.glares_check_params and isinstance(self.glares_check_params, GlaresCheckParams):
             _dict['glaresCheckParams'] = self.glares_check_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of occlusion_check_params
+        if self.occlusion_check_params and isinstance(self.occlusion_check_params, OcclusionCheckParams):
+            _dict['occlusionCheckParams'] = self.occlusion_check_params.to_dict()
         return _dict
 
     @classmethod
@@ -98,7 +103,8 @@ class ImageQA(BaseModel):
             "moireCheck": obj.get("moireCheck"),
             "documentPositionIndent": obj.get("documentPositionIndent"),
             "expectedPass": obj.get("expectedPass"),
-            "glaresCheckParams": GlaresCheckParams.from_dict(obj["glaresCheckParams"]) if obj.get("glaresCheckParams") is not None else None
+            "glaresCheckParams": GlaresCheckParams.from_dict(obj["glaresCheckParams"]) if obj.get("glaresCheckParams") is not None else None,
+            "occlusionCheckParams": OcclusionCheckParams.from_dict(obj["occlusionCheckParams"]) if obj.get("occlusionCheckParams") is not None else None
         })
         return _obj
 

regula/documentreader/webclient/gen/models/occlusion_check_params.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, 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 OcclusionCheckParams(BaseModel):
+    """
+    OcclusionCheckParams
+    """ # noqa: E501
+    max_occlusion_part: SkipValidation[Optional[float]] = Field(alias="maxOcclusionPart", default=None, description="The maximum size for the occluded area of a document; only those exceeding this size will be validated")
+    __properties: ClassVar[List[str]] = ["maxOcclusionPart"]
+
+    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 OcclusionCheckParams 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 OcclusionCheckParams from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "maxOcclusionPart": obj.get("maxOcclusionPart")
+        })
+        return _obj
+
+

{regula_documentreader_webclient-9.8.982.dev0.dist-info → regula_documentreader_webclient-9.8.984.dev0.dist-info}/METADATA

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

{regula_documentreader_webclient-9.8.982.dev0.dist-info → regula_documentreader_webclient-9.8.984.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=YscWuO6_Dr1M4AlmkxxqbS4cijOMDe7omfI-EU5Hg4c,65902
+regula/documentreader/webclient/gen/__init__.py,sha256=xic2JA1G1LspIJB0r-MnLn6kChUxArccn6SKL7qvuY0,66180
 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
@@ -29,7 +29,7 @@ regula/documentreader/webclient/gen/api/healthcheck_api.py,sha256=g3Q3XsdgYfEmmd
 regula/documentreader/webclient/gen/api/process_api.py,sha256=RnJXVZy-M1bNfiXK0tHEQEuhOgxkXk9jMG-hpZfTjZ8,12123
 regula/documentreader/webclient/gen/api/resources_api.py,sha256=grQfqv8hZNJnR1hC72jG614D_Y9MDn3sMyZYWllk15U,10264
 regula/documentreader/webclient/gen/api/transaction_api.py,sha256=53uZvktOfFNr_b9iWYR0AqD4YGTzvVtfUa25ir5ooqE,66657
-regula/documentreader/webclient/gen/models/__init__.py,sha256=Su3MgYbrc0yitoyKmgCciSCGv0GLhjTbUYsz0fSpsW8,46941
+regula/documentreader/webclient/gen/models/__init__.py,sha256=yLaOkwTWkgOlVuXXPKS2kF22LEH4Ff0dQ_YcsFHnAtU,47143
 regula/documentreader/webclient/gen/models/area_array.py,sha256=ifzL0bjUAQGTdIdsY8Lce0wvZQxuuVB9_DhFRSlA9jY,3756
 regula/documentreader/webclient/gen/models/area_container.py,sha256=rWQPaY9tD3QkQXxnV1rmi1PeB3F2WPBj9zdPWnc7kCY,3737
 regula/documentreader/webclient/gen/models/auth_params.py,sha256=FZSIL8W_77LNVdcT0IJZ1Zy2_VrqR4W1qb-aBt91_JM,7717
@@ -118,7 +118,7 @@ regula/documentreader/webclient/gen/models/healthcheck_documents_database.py,sha
 regula/documentreader/webclient/gen/models/ident_item.py,sha256=DdoEjDO8taUP3_1zIqsLtjoB4xyW8OyNecdXWhdlNjM,4758
 regula/documentreader/webclient/gen/models/ident_result.py,sha256=9DPzw_5IrtSSRl4YawtG-QTXdD7TEqDT5i2asEURunI,5418
 regula/documentreader/webclient/gen/models/image_data.py,sha256=s8GTx-UadfPNYgqqIdalolz7iaDxwkc4C2afsI_oFuY,2592
-regula/documentreader/webclient/gen/models/image_qa.py,sha256=8QY7b4uRxdJdL_ZpwKx0UdizJqZ4YIgM3c4CkzYMtQM,5689
+regula/documentreader/webclient/gen/models/image_qa.py,sha256=B4Bm4ty8gTXfATbhEr_HXocFEvYay3sNqL01WMy4xtI,6382
 regula/documentreader/webclient/gen/models/image_quality_check.py,sha256=j1bZK-M76YLEJzqULMWCAsAJArVXt9bz3dYUvGeBHqE,3896
 regula/documentreader/webclient/gen/models/image_quality_check_list.py,sha256=KLfxAjWFnppv2GKrp6o1QsS23PPmPTmnPZ9wM33gp5U,3330
 regula/documentreader/webclient/gen/models/image_quality_check_list_item.py,sha256=RnTqHKekzb-AbXRq-sB1K3opH9e8MvVZdReS3pDr9WE,3005
@@ -162,6 +162,7 @@ regula/documentreader/webclient/gen/models/mrz_rows_item.py,sha256=SN6DrWpJmVrBz
 regula/documentreader/webclient/gen/models/mrz_test_quality.py,sha256=FhoYuqgcOTO0oSxdyFbsBxShaa0rnpRPk7H8Cw5mfbM,4278
 regula/documentreader/webclient/gen/models/mrz_test_quality_item.py,sha256=FO5Rf30Cm3oi3aAxc3pl7dDW-ZTJhPo4fQ_d8Lhi5IE,2859
 regula/documentreader/webclient/gen/models/mrz_test_quality_result.py,sha256=hxSLHyNYmZgGtALhFYFaw22TsFT3Yji-KSqRKiDJ1ys,3295
+regula/documentreader/webclient/gen/models/occlusion_check_params.py,sha256=fpQGsWqANbIeE3DhJcP_9TG8F5x-MLUoU24zeRWv8MA,2638
 regula/documentreader/webclient/gen/models/ocr_security_text_item.py,sha256=8ymmB_n0kAWIt3KGoSKqCL8_sdXktffrk5v9y6VKBMc,5136
 regula/documentreader/webclient/gen/models/ocr_security_text_result.py,sha256=GpiRyAZID-mqWTKSvXptmkONjyTmvhPotAypLI3Q6Ko,5796
 regula/documentreader/webclient/gen/models/one_candidate.py,sha256=l1O4WGZ5MLLYrh-ROM-9R7xMXvt8I0RkwhLkep-LcUE,5468
@@ -284,7 +285,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=FETunEPtXE6eAsQbSg1Tn7rO7rut4ZT7BooMPT1ZhmA,5282
-regula_documentreader_webclient-9.8.982.dev0.dist-info/METADATA,sha256=Vyrtx_cgeylCxpvrzEaSnZzEqejBBpR0pl35zAOpadk,4037
-regula_documentreader_webclient-9.8.982.dev0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-regula_documentreader_webclient-9.8.982.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
-regula_documentreader_webclient-9.8.982.dev0.dist-info/RECORD,,
+regula_documentreader_webclient-9.8.984.dev0.dist-info/METADATA,sha256=FIFh1fdUeex2ujLthlq_-lgo0C9FuGfcC617w1HHfzQ,4037
+regula_documentreader_webclient-9.8.984.dev0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+regula_documentreader_webclient-9.8.984.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
+regula_documentreader_webclient-9.8.984.dev0.dist-info/RECORD,,