diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 7aa8e86..a508126 100755 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -143,6 +143,7 @@ regula/documentreader/webclient/gen/models/mrz_rows_item.py regula/documentreader/webclient/gen/models/mrz_test_quality.py regula/documentreader/webclient/gen/models/mrz_test_quality_item.py regula/documentreader/webclient/gen/models/mrz_test_quality_result.py +regula/documentreader/webclient/gen/models/occlusion_check_params.py regula/documentreader/webclient/gen/models/ocr_security_text_item.py regula/documentreader/webclient/gen/models/ocr_security_text_result.py regula/documentreader/webclient/gen/models/one_candidate.py diff --git a/regula/documentreader/webclient/gen/__init__.py b/regula/documentreader/webclient/gen/__init__.py index 1207645..79e348c 100644 --- a/regula/documentreader/webclient/gen/__init__.py +++ b/regula/documentreader/webclient/gen/__init__.py @@ -157,6 +157,7 @@ "MrzPositionItem", "OCRSecurityTextItem", "OCRSecurityTextResult", + "OcclusionCheckParams", "OneCandidate", "OneCandidateItem", "OriginalSymbol", @@ -429,6 +430,7 @@ 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_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 diff --git a/regula/documentreader/webclient/gen/models/__init__.py b/regula/documentreader/webclient/gen/models/__init__.py index 5eb8b79..24019d9 100644 --- a/regula/documentreader/webclient/gen/models/__init__.py +++ b/regula/documentreader/webclient/gen/models/__init__.py @@ -141,6 +141,7 @@ 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_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 diff --git a/regula/documentreader/webclient/gen/models/image_qa.py b/regula/documentreader/webclient/gen/models/image_qa.py index a376892..f3946ce 100644 --- a/regula/documentreader/webclient/gen/models/image_qa.py +++ b/regula/documentreader/webclient/gen/models/image_qa.py @@ -13,6 +13,7 @@ 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 @@ def to_dict(self) -> Dict[str, Any]: # 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 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "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 diff --git a/regula/documentreader/webclient/gen/models/occlusion_check_params.py b/regula/documentreader/webclient/gen/models/occlusion_check_params.py new file mode 100644 index 0000000..983165a --- /dev/null +++ b/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 + +