regula.documentreader.webclient 9.8.985.dev0__py3-none-any.whl → 9.8.986rc0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -157,7 +157,6 @@ __all__ = [
157
157
  "MrzPositionItem",
158
158
  "OCRSecurityTextItem",
159
159
  "OCRSecurityTextResult",
160
- "OcclusionCheckParams",
161
160
  "OneCandidate",
162
161
  "OneCandidateItem",
163
162
  "OriginalSymbol",
@@ -430,7 +429,6 @@ if __import__("typing").TYPE_CHECKING:
430
429
  from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem as MrzPositionItem
431
430
  from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem as OCRSecurityTextItem
432
431
  from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult as OCRSecurityTextResult
433
- from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams as OcclusionCheckParams
434
432
  from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate as OneCandidate
435
433
  from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem as OneCandidateItem
436
434
  from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol as OriginalSymbol
@@ -709,7 +707,6 @@ from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzD
709
707
  from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem as MrzPositionItem
710
708
  from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem as OCRSecurityTextItem
711
709
  from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult as OCRSecurityTextResult
712
- from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams as OcclusionCheckParams
713
710
  from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate as OneCandidate
714
711
  from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem as OneCandidateItem
715
712
  from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol as OriginalSymbol
@@ -141,7 +141,6 @@ if __import__("typing").TYPE_CHECKING:
141
141
  from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem
142
142
  from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem
143
143
  from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
144
- from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams
145
144
  from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
146
145
  from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem
147
146
  from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol
@@ -401,7 +400,6 @@ from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzD
401
400
  from regula.documentreader.webclient.gen.models.mrz_position_item import MrzPositionItem
402
401
  from regula.documentreader.webclient.gen.models.ocr_security_text_item import OCRSecurityTextItem
403
402
  from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
404
- from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams
405
403
  from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
406
404
  from regula.documentreader.webclient.gen.models.one_candidate_item import OneCandidateItem
407
405
  from regula.documentreader.webclient.gen.models.original_symbol import OriginalSymbol
@@ -13,7 +13,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, Stri
13
13
  from typing import Any, ClassVar, Dict, List, Optional, Union
14
14
  from regula.documentreader.webclient.gen.models.glares_check_params import GlaresCheckParams
15
15
  from regula.documentreader.webclient.gen.models.input_image_quality_checks import InputImageQualityChecks
16
- from regula.documentreader.webclient.gen.models.occlusion_check_params import OcclusionCheckParams
17
16
  from typing import Optional, Set
18
17
  from typing_extensions import Self
19
18
  from pydantic import SkipValidation, Field
@@ -32,8 +31,7 @@ class ImageQA(BaseModel):
32
31
  document_position_indent: SkipValidation[Optional[int]] = Field(alias="documentPositionIndent", default=None, description="This parameter specifies the necessary margin. Default 0.")
33
32
  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.")
34
33
  glares_check_params: SkipValidation[Optional[GlaresCheckParams]] = Field(alias="glaresCheckParams", default=None)
35
- occlusion_check_params: SkipValidation[Optional[OcclusionCheckParams]] = Field(alias="occlusionCheckParams", default=None)
36
- __properties: ClassVar[List[str]] = ["brightnessThreshold", "dpiThreshold", "angleThreshold", "focusCheck", "glaresCheck", "colornessCheck", "moireCheck", "documentPositionIndent", "expectedPass", "glaresCheckParams", "occlusionCheckParams"]
34
+ __properties: ClassVar[List[str]] = ["brightnessThreshold", "dpiThreshold", "angleThreshold", "focusCheck", "glaresCheck", "colornessCheck", "moireCheck", "documentPositionIndent", "expectedPass", "glaresCheckParams"]
37
35
 
38
36
  model_config = ConfigDict(
39
37
  populate_by_name=True,
@@ -79,9 +77,6 @@ class ImageQA(BaseModel):
79
77
  # override the default output from pydantic by calling `to_dict()` of glares_check_params
80
78
  if self.glares_check_params and isinstance(self.glares_check_params, GlaresCheckParams):
81
79
  _dict['glaresCheckParams'] = self.glares_check_params.to_dict()
82
- # override the default output from pydantic by calling `to_dict()` of occlusion_check_params
83
- if self.occlusion_check_params and isinstance(self.occlusion_check_params, OcclusionCheckParams):
84
- _dict['occlusionCheckParams'] = self.occlusion_check_params.to_dict()
85
80
  return _dict
86
81
 
87
82
  @classmethod
@@ -103,8 +98,7 @@ class ImageQA(BaseModel):
103
98
  "moireCheck": obj.get("moireCheck"),
104
99
  "documentPositionIndent": obj.get("documentPositionIndent"),
105
100
  "expectedPass": obj.get("expectedPass"),
106
- "glaresCheckParams": GlaresCheckParams.from_dict(obj["glaresCheckParams"]) if obj.get("glaresCheckParams") is not None else None,
107
- "occlusionCheckParams": OcclusionCheckParams.from_dict(obj["occlusionCheckParams"]) if obj.get("occlusionCheckParams") is not None else None
101
+ "glaresCheckParams": GlaresCheckParams.from_dict(obj["glaresCheckParams"]) if obj.get("glaresCheckParams") is not None else None
108
102
  })
109
103
  return _obj
110
104
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: regula_documentreader_webclient
3
- Version: 9.8.985.dev0
3
+ Version: 9.8.986rc0
4
4
  Summary: Regula's Document Reader python client
5
5
  Home-page: https://regulaforensics.com
6
6
  Author: Regula Forensics, Inc.
@@ -17,7 +17,7 @@ regula/documentreader/webclient/ext/models/authenticity/ident.py,sha256=DSmXEJ-v
17
17
  regula/documentreader/webclient/ext/models/authenticity/image_ident.py,sha256=QmKTghP4Lo7bHBEubwzsVt1ob97NNaNIu_5QN_LUF9M,370
18
18
  regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py,sha256=BV0h2_UDrwUlWczoJQW8qTSkdZ0icm0n0pPDRY9Qwq4,407
19
19
  regula/documentreader/webclient/ext/models/authenticity/security_feature.py,sha256=t8egDyT1wlGvsyvZboAFOvcaYsALGpj41E50FUbvx68,622
20
- regula/documentreader/webclient/gen/__init__.py,sha256=xic2JA1G1LspIJB0r-MnLn6kChUxArccn6SKL7qvuY0,66180
20
+ regula/documentreader/webclient/gen/__init__.py,sha256=YscWuO6_Dr1M4AlmkxxqbS4cijOMDe7omfI-EU5Hg4c,65902
21
21
  regula/documentreader/webclient/gen/api_client.py,sha256=BZ1SIy0PwA4khadeMet9fNj8pt1j_OaaebUSHChq31k,27673
22
22
  regula/documentreader/webclient/gen/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
23
23
  regula/documentreader/webclient/gen/configuration.py,sha256=0hMqlAxYaL30050LBPnHrh6Sg1EIfSfQLr0eGNRNz1w,18084
@@ -29,7 +29,7 @@ regula/documentreader/webclient/gen/api/healthcheck_api.py,sha256=g3Q3XsdgYfEmmd
29
29
  regula/documentreader/webclient/gen/api/process_api.py,sha256=RnJXVZy-M1bNfiXK0tHEQEuhOgxkXk9jMG-hpZfTjZ8,12123
30
30
  regula/documentreader/webclient/gen/api/resources_api.py,sha256=grQfqv8hZNJnR1hC72jG614D_Y9MDn3sMyZYWllk15U,10264
31
31
  regula/documentreader/webclient/gen/api/transaction_api.py,sha256=53uZvktOfFNr_b9iWYR0AqD4YGTzvVtfUa25ir5ooqE,66657
32
- regula/documentreader/webclient/gen/models/__init__.py,sha256=yLaOkwTWkgOlVuXXPKS2kF22LEH4Ff0dQ_YcsFHnAtU,47143
32
+ regula/documentreader/webclient/gen/models/__init__.py,sha256=Su3MgYbrc0yitoyKmgCciSCGv0GLhjTbUYsz0fSpsW8,46941
33
33
  regula/documentreader/webclient/gen/models/area_array.py,sha256=ifzL0bjUAQGTdIdsY8Lce0wvZQxuuVB9_DhFRSlA9jY,3756
34
34
  regula/documentreader/webclient/gen/models/area_container.py,sha256=rWQPaY9tD3QkQXxnV1rmi1PeB3F2WPBj9zdPWnc7kCY,3737
35
35
  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
118
118
  regula/documentreader/webclient/gen/models/ident_item.py,sha256=DdoEjDO8taUP3_1zIqsLtjoB4xyW8OyNecdXWhdlNjM,4758
119
119
  regula/documentreader/webclient/gen/models/ident_result.py,sha256=9DPzw_5IrtSSRl4YawtG-QTXdD7TEqDT5i2asEURunI,5418
120
120
  regula/documentreader/webclient/gen/models/image_data.py,sha256=s8GTx-UadfPNYgqqIdalolz7iaDxwkc4C2afsI_oFuY,2592
121
- regula/documentreader/webclient/gen/models/image_qa.py,sha256=B4Bm4ty8gTXfATbhEr_HXocFEvYay3sNqL01WMy4xtI,6382
121
+ regula/documentreader/webclient/gen/models/image_qa.py,sha256=8QY7b4uRxdJdL_ZpwKx0UdizJqZ4YIgM3c4CkzYMtQM,5689
122
122
  regula/documentreader/webclient/gen/models/image_quality_check.py,sha256=j1bZK-M76YLEJzqULMWCAsAJArVXt9bz3dYUvGeBHqE,3896
123
123
  regula/documentreader/webclient/gen/models/image_quality_check_list.py,sha256=KLfxAjWFnppv2GKrp6o1QsS23PPmPTmnPZ9wM33gp5U,3330
124
124
  regula/documentreader/webclient/gen/models/image_quality_check_list_item.py,sha256=RnTqHKekzb-AbXRq-sB1K3opH9e8MvVZdReS3pDr9WE,3005
@@ -162,7 +162,6 @@ regula/documentreader/webclient/gen/models/mrz_rows_item.py,sha256=SN6DrWpJmVrBz
162
162
  regula/documentreader/webclient/gen/models/mrz_test_quality.py,sha256=FhoYuqgcOTO0oSxdyFbsBxShaa0rnpRPk7H8Cw5mfbM,4278
163
163
  regula/documentreader/webclient/gen/models/mrz_test_quality_item.py,sha256=FO5Rf30Cm3oi3aAxc3pl7dDW-ZTJhPo4fQ_d8Lhi5IE,2859
164
164
  regula/documentreader/webclient/gen/models/mrz_test_quality_result.py,sha256=hxSLHyNYmZgGtALhFYFaw22TsFT3Yji-KSqRKiDJ1ys,3295
165
- regula/documentreader/webclient/gen/models/occlusion_check_params.py,sha256=fpQGsWqANbIeE3DhJcP_9TG8F5x-MLUoU24zeRWv8MA,2638
166
165
  regula/documentreader/webclient/gen/models/ocr_security_text_item.py,sha256=8ymmB_n0kAWIt3KGoSKqCL8_sdXktffrk5v9y6VKBMc,5136
167
166
  regula/documentreader/webclient/gen/models/ocr_security_text_result.py,sha256=GpiRyAZID-mqWTKSvXptmkONjyTmvhPotAypLI3Q6Ko,5796
168
167
  regula/documentreader/webclient/gen/models/one_candidate.py,sha256=l1O4WGZ5MLLYrh-ROM-9R7xMXvt8I0RkwhLkep-LcUE,5468
@@ -285,7 +284,7 @@ regula/documentreader/webclient/gen/models/verification_result.py,sha256=E6bCVR5
285
284
  regula/documentreader/webclient/gen/models/verified_field_map.py,sha256=QjCCjZ82WhT5uzdFthwfiX4Kgi5RL_m7E0NprLhHAJs,4863
286
285
  regula/documentreader/webclient/gen/models/visibility.py,sha256=GACgQd_8lx_cwMwI5lCi7cTxEWxw2atbJo6uI4mTKpQ,602
287
286
  regula/documentreader/webclient/gen/models/visual_extended_field_item.py,sha256=FETunEPtXE6eAsQbSg1Tn7rO7rut4ZT7BooMPT1ZhmA,5282
288
- regula_documentreader_webclient-9.8.985.dev0.dist-info/METADATA,sha256=hGoWD0zPSRkUTNs9SbMLBFFcs901P71pzlOnhk9J_OY,4037
289
- regula_documentreader_webclient-9.8.985.dev0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
290
- regula_documentreader_webclient-9.8.985.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
291
- regula_documentreader_webclient-9.8.985.dev0.dist-info/RECORD,,
287
+ regula_documentreader_webclient-9.8.986rc0.dist-info/METADATA,sha256=RbPyNIfwE7M5uEazHWEfV6PPEFlnBJ1oKZzeUnLHGUo,4035
288
+ regula_documentreader_webclient-9.8.986rc0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
289
+ regula_documentreader_webclient-9.8.986rc0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
290
+ regula_documentreader_webclient-9.8.986rc0.dist-info/RECORD,,
@@ -1,82 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- Generated by: https://openapi-generator.tech
5
- """
6
-
7
- from __future__ import annotations
8
- import pprint
9
- import re # noqa: F401
10
- import json
11
-
12
- from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
13
- from typing import Any, ClassVar, Dict, List, Optional, Union
14
- from typing import Optional, Set
15
- from typing_extensions import Self
16
- from pydantic import SkipValidation, Field
17
-
18
- class OcclusionCheckParams(BaseModel):
19
- """
20
- OcclusionCheckParams
21
- """ # noqa: E501
22
- 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")
23
- __properties: ClassVar[List[str]] = ["maxOcclusionPart"]
24
-
25
- model_config = ConfigDict(
26
- populate_by_name=True,
27
- validate_assignment=True,
28
- protected_namespaces=(),
29
- arbitrary_types_allowed=True,
30
- use_enum_values=True
31
- )
32
-
33
-
34
- def to_str(self) -> str:
35
- """Returns the string representation of the model using alias"""
36
- return pprint.pformat(self.model_dump(by_alias=True))
37
-
38
- def to_json(self) -> str:
39
- """Returns the JSON representation of the model using alias"""
40
- # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
41
- return json.dumps(self.to_dict())
42
-
43
- @classmethod
44
- def from_json(cls, json_str: str) -> Optional[Self]:
45
- """Create an instance of OcclusionCheckParams from a JSON string"""
46
- return cls.from_dict(json.loads(json_str))
47
-
48
- def to_dict(self) -> Dict[str, Any]:
49
- """Return the dictionary representation of the model using alias.
50
-
51
- This has the following differences from calling pydantic's
52
- `self.model_dump(by_alias=True)`:
53
-
54
- * `None` is only added to the output dict for nullable fields that
55
- were set at model initialization. Other fields with value `None`
56
- are ignored.
57
- """
58
- excluded_fields: Set[str] = set([
59
- ])
60
-
61
- _dict = self.model_dump(
62
- by_alias=True,
63
- exclude=excluded_fields,
64
- exclude_none=True,
65
- )
66
- return _dict
67
-
68
- @classmethod
69
- def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
70
- """Create an instance of OcclusionCheckParams from a dict"""
71
- if obj is None:
72
- return None
73
-
74
- if not isinstance(obj, dict):
75
- return cls.model_validate(obj)
76
-
77
- _obj = cls.model_validate({
78
- "maxOcclusionPart": obj.get("maxOcclusionPart")
79
- })
80
- return _obj
81
-
82
-