DocumentReader-web-python-client/regula/documentreader/webclient/gen/models/database_document.py at 9e19a1f1a8a78f81e149af34e582597369f47d21 · 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
# 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, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from regula.documentreader.webclient.gen.models.document_type import DocumentType
from typing import Optional, Set
from typing_extensions import Self
from pydantic import SkipValidation, Field

class DatabaseDocument(BaseModel):
    """
    DatabaseDocument
    """ # noqa: E501
    barcode_fields: SkipValidation[bool] = Field(alias="barcode_fields", description="Whether the document has a barcode.")
    country: SkipValidation[str] = Field(alias="country", description="Country name.")
    created: SkipValidation[str] = Field(alias="created", description="Date when the document description was created in the database.")
    doc_type: SkipValidation[DocumentType] = Field(alias="doc_type")
    document: SkipValidation[str] = Field(alias="document", description="Document name.")
    graphic_fields: SkipValidation[bool] = Field(alias="graphic_fields", description="The presence of graphic fields in the document.")
    id: SkipValidation[int] = Field(alias="id", description="Document code.")
    mrz: SkipValidation[bool] = Field(alias="mrz", description="The document has an MRZ.")
    region: SkipValidation[Optional[str]] = Field(alias="region", default=None, description="Country region.")
    rfid_chip: SkipValidation[bool] = Field(alias="rfid_chip", description="The document has an RFID chip.")
    text_fields: SkipValidation[bool] = Field(alias="text_fields", description="The presence of text fields in the document.")
    updated: SkipValidation[str] = Field(alias="updated", description="Date when the document description was updated in the database.")
    year: SkipValidation[Optional[str]] = Field(alias="year", default=None, description="The year when the document was issued.")
    sovereignty: SkipValidation[Optional[str]] = Field(alias="sovereignty", default=None, description="Guardian country.")
    deprecated: SkipValidation[Optional[bool]] = Field(alias="deprecated", default=None, description="Whether the document is no longer in circulation.")
    icao_code: SkipValidation[Optional[str]] = Field(alias="icao_code", default=None, description="ICAO country code.")
    doc_codes: SkipValidation[Optional[str]] = Field(alias="doc_codes", default=None, description="Document codes.")
    __properties: ClassVar[List[str]] = ["barcode_fields", "country", "created", "doc_type", "document", "graphic_fields", "id", "mrz", "region", "rfid_chip", "text_fields", "updated", "year", "sovereignty", "deprecated", "icao_code", "doc_codes"]

    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 DatabaseDocument 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 DatabaseDocument from a dict"""
        if obj is None:
            return None

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

        _obj = cls.model_validate({
            "barcode_fields": obj.get("barcode_fields"),
            "country": obj.get("country"),
            "created": obj.get("created"),
            "doc_type": obj.get("doc_type"),
            "document": obj.get("document"),
            "graphic_fields": obj.get("graphic_fields"),
            "id": obj.get("id"),
            "mrz": obj.get("mrz"),
            "region": obj.get("region"),
            "rfid_chip": obj.get("rfid_chip"),
            "text_fields": obj.get("text_fields"),
            "updated": obj.get("updated"),
            "year": obj.get("year"),
            "sovereignty": obj.get("sovereignty"),
            "deprecated": obj.get("deprecated"),
            "icao_code": obj.get("icao_code"),
            "doc_codes": obj.get("doc_codes")
        })
        return _obj