From 14e1fa4b198bb978df43fab3477fb41a38e712db Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 17 Oct 2025 13:29:29 +0000 Subject: [PATCH] Commit: 66d1067c --- .openapi-generator/FILES | 1 + .../documentreader/webclient/gen/__init__.py | 3 + .../webclient/gen/models/__init__.py | 2 + .../gen/models/glares_check_params.py | 84 +++++++++++++++++++ .../webclient/gen/models/image_qa.py | 10 ++- 5 files changed, 98 insertions(+), 2 deletions(-) create mode 100644 regula/documentreader/webclient/gen/models/glares_check_params.py diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 0ce93f5..cd160da 100755 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -80,6 +80,7 @@ regula/documentreader/webclient/gen/models/fiber_result.py regula/documentreader/webclient/gen/models/field_item.py regula/documentreader/webclient/gen/models/file_image.py regula/documentreader/webclient/gen/models/get_transactions_by_tag_response.py +regula/documentreader/webclient/gen/models/glares_check_params.py regula/documentreader/webclient/gen/models/graph_data.py regula/documentreader/webclient/gen/models/graphic_field.py regula/documentreader/webclient/gen/models/graphic_field_type.py diff --git a/regula/documentreader/webclient/gen/__init__.py b/regula/documentreader/webclient/gen/__init__.py index c5581a9..d448a43 100644 --- a/regula/documentreader/webclient/gen/__init__.py +++ b/regula/documentreader/webclient/gen/__init__.py @@ -92,6 +92,7 @@ "FieldItem", "FileImage", "GetTransactionsByTagResponse", + "GlaresCheckParams", "GraphData", "GraphicField", "GraphicFieldType", @@ -339,6 +340,7 @@ 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.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 diff --git a/regula/documentreader/webclient/gen/models/__init__.py b/regula/documentreader/webclient/gen/models/__init__.py index ff127c5..e64f3d6 100644 --- a/regula/documentreader/webclient/gen/models/__init__.py +++ b/regula/documentreader/webclient/gen/models/__init__.py @@ -77,6 +77,7 @@ 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.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 diff --git a/regula/documentreader/webclient/gen/models/glares_check_params.py b/regula/documentreader/webclient/gen/models/glares_check_params.py new file mode 100644 index 0000000..060ef19 --- /dev/null +++ b/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 + + diff --git a/regula/documentreader/webclient/gen/models/image_qa.py b/regula/documentreader/webclient/gen/models/image_qa.py index db7043b..485da4b 100644 --- a/regula/documentreader/webclient/gen/models/image_qa.py +++ b/regula/documentreader/webclient/gen/models/image_qa.py @@ -11,6 +11,7 @@ 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 @@ def to_dict(self) -> Dict[str, Any]: 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 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "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