|
| 1 | +# coding: utf-8 |
| 2 | + |
| 3 | +""" |
| 4 | + Onfido API v3.6 |
| 5 | +
|
| 6 | + The Onfido API (v3.6) |
| 7 | +
|
| 8 | + The version of the OpenAPI document: v3.6 |
| 9 | + Generated by OpenAPI Generator (https://openapi-generator.tech) |
| 10 | +
|
| 11 | + Do not edit the class manually. |
| 12 | +""" # noqa: E501 |
| 13 | + |
| 14 | + |
| 15 | +from __future__ import annotations |
| 16 | +import pprint |
| 17 | +import re # noqa: F401 |
| 18 | +import json |
| 19 | + |
| 20 | +from pydantic import BaseModel, ConfigDict, Field |
| 21 | +from typing import Any, ClassVar, Dict, List, Optional |
| 22 | +from onfido.models.report_document import ReportDocument |
| 23 | +from typing import Optional, Set |
| 24 | +from typing_extensions import Self |
| 25 | + |
| 26 | +class DocumentReportShared(BaseModel): |
| 27 | + """ |
| 28 | + DocumentReportShared |
| 29 | + """ # noqa: E501 |
| 30 | + documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.") |
| 31 | + additional_properties: Dict[str, Any] = {} |
| 32 | + __properties: ClassVar[List[str]] = ["documents"] |
| 33 | + |
| 34 | + model_config = ConfigDict( |
| 35 | + populate_by_name=True, |
| 36 | + validate_assignment=True, |
| 37 | + protected_namespaces=(), |
| 38 | + ) |
| 39 | + |
| 40 | + |
| 41 | + def to_str(self) -> str: |
| 42 | + """Returns the string representation of the model using alias""" |
| 43 | + return pprint.pformat(self.model_dump(by_alias=True)) |
| 44 | + |
| 45 | + def to_json(self) -> str: |
| 46 | + """Returns the JSON representation of the model using alias""" |
| 47 | + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead |
| 48 | + return json.dumps(self.to_dict()) |
| 49 | + |
| 50 | + @classmethod |
| 51 | + def from_json(cls, json_str: str) -> Optional[Self]: |
| 52 | + """Create an instance of DocumentReportShared from a JSON string""" |
| 53 | + return cls.from_dict(json.loads(json_str)) |
| 54 | + |
| 55 | + def to_dict(self) -> Dict[str, Any]: |
| 56 | + """Return the dictionary representation of the model using alias. |
| 57 | +
|
| 58 | + This has the following differences from calling pydantic's |
| 59 | + `self.model_dump(by_alias=True)`: |
| 60 | +
|
| 61 | + * `None` is only added to the output dict for nullable fields that |
| 62 | + were set at model initialization. Other fields with value `None` |
| 63 | + are ignored. |
| 64 | + * Fields in `self.additional_properties` are added to the output dict. |
| 65 | + """ |
| 66 | + excluded_fields: Set[str] = set([ |
| 67 | + "additional_properties", |
| 68 | + ]) |
| 69 | + |
| 70 | + _dict = self.model_dump( |
| 71 | + by_alias=True, |
| 72 | + exclude=excluded_fields, |
| 73 | + exclude_none=True, |
| 74 | + ) |
| 75 | + # override the default output from pydantic by calling `to_dict()` of each item in documents (list) |
| 76 | + _items = [] |
| 77 | + if self.documents: |
| 78 | + for _item_documents in self.documents: |
| 79 | + if _item_documents: |
| 80 | + _items.append(_item_documents.to_dict()) |
| 81 | + _dict['documents'] = _items |
| 82 | + # puts key-value pairs in additional_properties in the top level |
| 83 | + if self.additional_properties is not None: |
| 84 | + for _key, _value in self.additional_properties.items(): |
| 85 | + _dict[_key] = _value |
| 86 | + |
| 87 | + return _dict |
| 88 | + |
| 89 | + @classmethod |
| 90 | + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: |
| 91 | + """Create an instance of DocumentReportShared from a dict""" |
| 92 | + if obj is None: |
| 93 | + return None |
| 94 | + |
| 95 | + if not isinstance(obj, dict): |
| 96 | + return cls.model_validate(obj) |
| 97 | + |
| 98 | + _obj = cls.model_validate({ |
| 99 | + "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None |
| 100 | + }) |
| 101 | + # store additional fields in additional_properties |
| 102 | + for _key in obj.keys(): |
| 103 | + if _key not in cls.__properties: |
| 104 | + _obj.additional_properties[_key] = obj.get(_key) |
| 105 | + |
| 106 | + return _obj |
| 107 | + |
| 108 | + |
0 commit comments