DocumentReader-web-python-client/regula/documentreader/webclient/gen/models/auth_params.py at ffacd7c41168bef505fc07e3fe1cd6b9723ab778 · regulaforensics/DocumentReader-web-python-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# 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, StrictBool
from typing import Any, ClassVar, Dict, List, Optional
from regula.documentreader.webclient.gen.models.liveness_params import LivenessParams
from regula.documentreader.webclient.gen.models.properties_params import PropertiesParams
from typing import Optional, Set
from typing_extensions import Self
from pydantic import SkipValidation, Field

class AuthParams(BaseModel):
    """
    AuthParams
    """ # noqa: E501
    check_liveness: SkipValidation[Optional[bool]] = Field(alias="checkLiveness", default=None, description="This parameter is used to enable document liveness check")
    liveness_params: SkipValidation[Optional[LivenessParams]] = Field(alias="livenessParams", default=None)
    check_uv_luminiscence: SkipValidation[Optional[bool]] = Field(alias="checkUVLuminiscence", default=None, description="This parameter is used to enable Document luminescence check in UV light")
    check_irb900: SkipValidation[Optional[bool]] = Field(alias="checkIRB900", default=None, description="This parameter is used to enable B900 ink MRZ contrast check in IR light")
    check_image_patterns: SkipValidation[Optional[bool]] = Field(alias="checkImagePatterns", default=None, description="This parameter is used to enable Image patterns presence/absence check (position, shape, color)")
    check_fibers: SkipValidation[Optional[bool]] = Field(alias="checkFibers", default=None, description="This parameter is used to enable Fibers detection")
    check_ext_mrz: SkipValidation[Optional[bool]] = Field(alias="checkExtMRZ", default=None, description="This parameter is used to enable Extended MRZ Check")
    check_ext_ocr: SkipValidation[Optional[bool]] = Field(alias="checkExtOCR", default=None, description="This parameter is used to enable Extended OCR Check")
    check_axial: SkipValidation[Optional[bool]] = Field(alias="checkAxial", default=None, description="This parameter is used to enable laminate integrity check in axial light")
    check_barcode_format: SkipValidation[Optional[bool]] = Field(alias="checkBarcodeFormat", default=None, description="This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)")
    check_ir_visibility: SkipValidation[Optional[bool]] = Field(alias="checkIRVisibility", default=None, description="This parameter is used to enable Document elements visibility check in IR light")
    check_ipi: SkipValidation[Optional[bool]] = Field(alias="checkIPI", default=None, description="This parameter is used to enable Invisible Personal Information (IPI) check")
    check_photo_embedding: SkipValidation[Optional[bool]] = Field(alias="checkPhotoEmbedding", default=None, description="This parameter is used to enable Owner's photo embedding check (is photo printed or sticked)")
    check_photo_comparison: SkipValidation[Optional[bool]] = Field(alias="checkPhotoComparison", default=None, description="This parameter is used to enable Portrait comparison check")
    check_letter_screen: SkipValidation[Optional[bool]] = Field(alias="checkLetterScreen", default=None, description="This parameter is used to enable LetterScreen check")
    check_security_text: SkipValidation[Optional[bool]] = Field(alias="checkSecurityText", default=None, description="This parameter is used to enable Security text check")
    check_properties: SkipValidation[Optional[bool]] = Field(alias="checkProperties", default=None, description="Set to true to enable detection of the document properties, such as holder's signature and other attributes.")
    properties_params: SkipValidation[Optional[PropertiesParams]] = Field(alias="propertiesParams", default=None)
    __properties: ClassVar[List[str]] = ["checkLiveness", "livenessParams", "checkUVLuminiscence", "checkIRB900", "checkImagePatterns", "checkFibers", "checkExtMRZ", "checkExtOCR", "checkAxial", "checkBarcodeFormat", "checkIRVisibility", "checkIPI", "checkPhotoEmbedding", "checkPhotoComparison", "checkLetterScreen", "checkSecurityText", "checkProperties", "propertiesParams"]

    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 AuthParams 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,
        )
        # override the default output from pydantic by calling `to_dict()` of liveness_params
        if self.liveness_params and isinstance(self.liveness_params, LivenessParams):
            _dict['livenessParams'] = self.liveness_params.to_dict()
        # override the default output from pydantic by calling `to_dict()` of properties_params
        if self.properties_params and isinstance(self.properties_params, PropertiesParams):
            _dict['propertiesParams'] = self.properties_params.to_dict()
        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of AuthParams from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate({
            "checkLiveness": obj.get("checkLiveness"),
            "livenessParams": LivenessParams.from_dict(obj["livenessParams"]) if obj.get("livenessParams") is not None else None,
            "checkUVLuminiscence": obj.get("checkUVLuminiscence"),
            "checkIRB900": obj.get("checkIRB900"),
            "checkImagePatterns": obj.get("checkImagePatterns"),
            "checkFibers": obj.get("checkFibers"),
            "checkExtMRZ": obj.get("checkExtMRZ"),
            "checkExtOCR": obj.get("checkExtOCR"),
            "checkAxial": obj.get("checkAxial"),
            "checkBarcodeFormat": obj.get("checkBarcodeFormat"),
            "checkIRVisibility": obj.get("checkIRVisibility"),
            "checkIPI": obj.get("checkIPI"),
            "checkPhotoEmbedding": obj.get("checkPhotoEmbedding"),
            "checkPhotoComparison": obj.get("checkPhotoComparison"),
            "checkLetterScreen": obj.get("checkLetterScreen"),
            "checkSecurityText": obj.get("checkSecurityText"),
            "checkProperties": obj.get("checkProperties"),
            "propertiesParams": PropertiesParams.from_dict(obj["propertiesParams"]) if obj.get("propertiesParams") is not None else None
        })
        return _obj