onfido-python 3.4.0__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.
- onfido/__init__.py +311 -0
- onfido/api/__init__.py +5 -0
- onfido/api/default_api.py +17488 -0
- onfido/api_client.py +770 -0
- onfido/api_response.py +21 -0
- onfido/configuration.py +460 -0
- onfido/exceptions.py +199 -0
- onfido/models/__init__.py +291 -0
- onfido/models/address.py +169 -0
- onfido/models/address_builder.py +169 -0
- onfido/models/address_shared.py +169 -0
- onfido/models/addresses_list.py +108 -0
- onfido/models/applicant.py +162 -0
- onfido/models/applicant_builder.py +152 -0
- onfido/models/applicant_create.py +117 -0
- onfido/models/applicant_request.py +116 -0
- onfido/models/applicant_response.py +146 -0
- onfido/models/applicant_shared.py +115 -0
- onfido/models/applicant_update.py +123 -0
- onfido/models/applicant_updater.py +158 -0
- onfido/models/applicants_list.py +108 -0
- onfido/models/check.py +147 -0
- onfido/models/check_builder.py +127 -0
- onfido/models/check_request.py +119 -0
- onfido/models/check_response.py +137 -0
- onfido/models/check_shared.py +108 -0
- onfido/models/checks_list.py +108 -0
- onfido/models/complete_task_builder.py +104 -0
- onfido/models/complete_task_data_builder.py +143 -0
- onfido/models/consent_item.py +109 -0
- onfido/models/consents_builder.py +98 -0
- onfido/models/country_codes.py +285 -0
- onfido/models/device_intelligence_breakdown.py +110 -0
- onfido/models/device_intelligence_breakdown_breakdown.py +104 -0
- onfido/models/device_intelligence_breakdown_breakdown_device.py +104 -0
- onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.py +114 -0
- onfido/models/device_intelligence_breakdown_properties.py +116 -0
- onfido/models/device_intelligence_breakdown_properties_device.py +189 -0
- onfido/models/device_intelligence_breakdown_properties_geolocation.py +105 -0
- onfido/models/device_intelligence_breakdown_properties_ip.py +106 -0
- onfido/models/device_intelligence_report.py +135 -0
- onfido/models/document.py +142 -0
- onfido/models/document_breakdown.py +152 -0
- onfido/models/document_breakdown_age_validation.py +106 -0
- onfido/models/document_breakdown_age_validation_breakdown.py +104 -0
- onfido/models/document_breakdown_compromised_document.py +106 -0
- onfido/models/document_breakdown_compromised_document_breakdown.py +109 -0
- onfido/models/document_breakdown_data_comparison.py +106 -0
- onfido/models/document_breakdown_data_comparison_breakdown.py +139 -0
- onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.py +102 -0
- onfido/models/document_breakdown_data_consistency.py +106 -0
- onfido/models/document_breakdown_data_consistency_breakdown.py +149 -0
- onfido/models/document_breakdown_data_validation.py +106 -0
- onfido/models/document_breakdown_data_validation_breakdown.py +136 -0
- onfido/models/document_breakdown_data_validation_breakdown_document_expiration.py +102 -0
- onfido/models/document_breakdown_data_validation_breakdown_expiry_date.py +102 -0
- onfido/models/document_breakdown_image_integrity.py +106 -0
- onfido/models/document_breakdown_image_integrity_breakdown.py +122 -0
- onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.py +102 -0
- onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.py +106 -0
- onfido/models/document_breakdown_image_integrity_breakdown_image_quality.py +106 -0
- onfido/models/document_breakdown_image_integrity_breakdown_supported_document.py +102 -0
- onfido/models/document_breakdown_issuing_authority.py +106 -0
- onfido/models/document_breakdown_issuing_authority_breakdown.py +110 -0
- onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.py +102 -0
- onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.py +102 -0
- onfido/models/document_breakdown_police_record.py +100 -0
- onfido/models/document_breakdown_visual_authenticity.py +106 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown.py +146 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.py +102 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.py +102 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.py +102 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.py +106 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_other.py +102 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.py +102 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.py +102 -0
- onfido/models/document_breakdown_visual_authenticity_breakdown_template.py +102 -0
- onfido/models/document_cdq_reasons.py +114 -0
- onfido/models/document_iq_reasons.py +118 -0
- onfido/models/document_odp_reasons.py +106 -0
- onfido/models/document_properties.py +255 -0
- onfido/models/document_properties_address_lines.py +110 -0
- onfido/models/document_properties_barcode_inner.py +135 -0
- onfido/models/document_properties_document_classification.py +104 -0
- onfido/models/document_properties_document_numbers_inner.py +102 -0
- onfido/models/document_properties_driving_licence_information.py +107 -0
- onfido/models/document_properties_extracted_data.py +141 -0
- onfido/models/document_properties_nfc.py +125 -0
- onfido/models/document_report.py +141 -0
- onfido/models/document_response.py +111 -0
- onfido/models/document_shared.py +129 -0
- onfido/models/document_types.py +60 -0
- onfido/models/document_video_report.py +141 -0
- onfido/models/document_video_with_address_information_report.py +141 -0
- onfido/models/document_with_address_information_report.py +141 -0
- onfido/models/document_with_driver_verification_report.py +141 -0
- onfido/models/document_with_driver_verification_report_all_of_properties.py +279 -0
- onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.py +105 -0
- onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.py +107 -0
- onfido/models/document_with_driving_licence_information_report.py +141 -0
- onfido/models/documents_list.py +108 -0
- onfido/models/error.py +104 -0
- onfido/models/error1.py +106 -0
- onfido/models/error_properties.py +104 -0
- onfido/models/error_properties1.py +102 -0
- onfido/models/extract_request.py +100 -0
- onfido/models/extraction.py +112 -0
- onfido/models/extraction_document_classification.py +120 -0
- onfido/models/extraction_extracted_data.py +176 -0
- onfido/models/facial_similarity_motion_breakdown.py +116 -0
- onfido/models/facial_similarity_motion_breakdown_face_comparison.py +106 -0
- onfido/models/facial_similarity_motion_breakdown_image_integrity.py +106 -0
- onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.py +110 -0
- onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.py +102 -0
- onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.py +106 -0
- onfido/models/facial_similarity_motion_breakdown_visual_authenticity.py +106 -0
- onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.py +110 -0
- onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.py +106 -0
- onfido/models/facial_similarity_motion_properties.py +100 -0
- onfido/models/facial_similarity_motion_report.py +141 -0
- onfido/models/facial_similarity_photo_breakdown.py +116 -0
- onfido/models/facial_similarity_photo_breakdown_face_comparison.py +106 -0
- onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.py +104 -0
- onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.py +106 -0
- onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.py +102 -0
- onfido/models/facial_similarity_photo_breakdown_image_integrity.py +106 -0
- onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.py +110 -0
- onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.py +102 -0
- onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.py +106 -0
- onfido/models/facial_similarity_photo_breakdown_visual_authenticity.py +106 -0
- onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.py +104 -0
- onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.py +106 -0
- onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.py +100 -0
- onfido/models/facial_similarity_photo_fully_auto_breakdown.py +116 -0
- onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.py +106 -0
- onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.py +110 -0
- onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.py +106 -0
- onfido/models/facial_similarity_photo_fully_auto_properties.py +100 -0
- onfido/models/facial_similarity_photo_fully_auto_report.py +141 -0
- onfido/models/facial_similarity_photo_properties.py +100 -0
- onfido/models/facial_similarity_photo_report.py +141 -0
- onfido/models/facial_similarity_video_breakdown.py +116 -0
- onfido/models/facial_similarity_video_breakdown_face_comparison.py +106 -0
- onfido/models/facial_similarity_video_breakdown_image_integrity.py +106 -0
- onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.py +110 -0
- onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.py +102 -0
- onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.py +106 -0
- onfido/models/facial_similarity_video_breakdown_visual_authenticity.py +106 -0
- onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.py +110 -0
- onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.py +102 -0
- onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.py +106 -0
- onfido/models/facial_similarity_video_properties.py +100 -0
- onfido/models/facial_similarity_video_report.py +141 -0
- onfido/models/id_number.py +114 -0
- onfido/models/id_photo.py +113 -0
- onfido/models/id_photo_response.py +113 -0
- onfido/models/id_photos_list.py +108 -0
- onfido/models/identity_enhanced_breakdown.py +122 -0
- onfido/models/identity_enhanced_breakdown_address.py +106 -0
- onfido/models/identity_enhanced_breakdown_address_breakdown.py +116 -0
- onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.py +106 -0
- onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.py +100 -0
- onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.py +102 -0
- onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.py +102 -0
- onfido/models/identity_enhanced_breakdown_date_of_birth.py +106 -0
- onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.py +110 -0
- onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.py +102 -0
- onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.py +102 -0
- onfido/models/identity_enhanced_breakdown_mortality.py +100 -0
- onfido/models/identity_enhanced_breakdown_sources.py +106 -0
- onfido/models/identity_enhanced_breakdown_sources_breakdown.py +104 -0
- onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.py +106 -0
- onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.py +100 -0
- onfido/models/identity_enhanced_properties.py +110 -0
- onfido/models/identity_enhanced_properties_matched_addresses_inner.py +102 -0
- onfido/models/identity_enhanced_report.py +141 -0
- onfido/models/india_pan_report.py +141 -0
- onfido/models/india_pan_report_all_of_breakdown.py +104 -0
- onfido/models/india_pan_report_all_of_breakdown_device.py +104 -0
- onfido/models/india_pan_report_all_of_breakdown_device_breakdown.py +109 -0
- onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.py +100 -0
- onfido/models/india_pan_report_all_of_properties.py +104 -0
- onfido/models/india_pan_report_all_of_properties_device.py +102 -0
- onfido/models/known_faces_breakdown.py +110 -0
- onfido/models/known_faces_breakdown_image_integrity.py +100 -0
- onfido/models/known_faces_breakdown_previously_seen_faces.py +100 -0
- onfido/models/known_faces_properties.py +108 -0
- onfido/models/known_faces_properties_matches_inner.py +108 -0
- onfido/models/known_faces_report.py +141 -0
- onfido/models/live_photo.py +113 -0
- onfido/models/live_photo_response.py +113 -0
- onfido/models/live_photos_list.py +108 -0
- onfido/models/live_video.py +115 -0
- onfido/models/live_videos_list.py +108 -0
- onfido/models/location.py +103 -0
- onfido/models/location_builder.py +103 -0
- onfido/models/location_shared.py +103 -0
- onfido/models/motion_capture.py +113 -0
- onfido/models/motion_captures_list.py +108 -0
- onfido/models/photo_auto_reasons.py +108 -0
- onfido/models/photo_reasons.py +108 -0
- onfido/models/proof_of_address_breakdown.py +116 -0
- onfido/models/proof_of_address_breakdown_data_comparison.py +106 -0
- onfido/models/proof_of_address_breakdown_data_comparison_breakdown.py +114 -0
- onfido/models/proof_of_address_breakdown_document_classification.py +106 -0
- onfido/models/proof_of_address_breakdown_document_classification_breakdown.py +104 -0
- onfido/models/proof_of_address_breakdown_image_integrity.py +106 -0
- onfido/models/proof_of_address_breakdown_image_integrity_breakdown.py +104 -0
- onfido/models/proof_of_address_properties.py +125 -0
- onfido/models/proof_of_address_report.py +141 -0
- onfido/models/repeat_attempts_list.py +117 -0
- onfido/models/repeat_attempts_list_repeat_attempts_inner.py +143 -0
- onfido/models/report.py +621 -0
- onfido/models/report_document.py +100 -0
- onfido/models/report_name.py +56 -0
- onfido/models/report_result.py +38 -0
- onfido/models/report_shared.py +129 -0
- onfido/models/report_status.py +40 -0
- onfido/models/report_sub_result.py +39 -0
- onfido/models/reports_list.py +108 -0
- onfido/models/results_feedback.py +116 -0
- onfido/models/sdk_token.py +100 -0
- onfido/models/sdk_token_builder.py +106 -0
- onfido/models/sdk_token_request.py +106 -0
- onfido/models/sdk_token_response.py +100 -0
- onfido/models/task.py +146 -0
- onfido/models/task_item.py +128 -0
- onfido/models/timeline_file_reference.py +102 -0
- onfido/models/us_driving_licence_breakdown.py +116 -0
- onfido/models/us_driving_licence_breakdown_address.py +106 -0
- onfido/models/us_driving_licence_breakdown_address_breakdown.py +129 -0
- onfido/models/us_driving_licence_breakdown_document.py +106 -0
- onfido/models/us_driving_licence_breakdown_document_breakdown.py +119 -0
- onfido/models/us_driving_licence_breakdown_personal.py +106 -0
- onfido/models/us_driving_licence_breakdown_personal_breakdown.py +164 -0
- onfido/models/us_driving_licence_builder.py +185 -0
- onfido/models/us_driving_licence_report.py +141 -0
- onfido/models/us_driving_licence_shared.py +185 -0
- onfido/models/video_reasons.py +106 -0
- onfido/models/watchlist_aml_breakdown.py +122 -0
- onfido/models/watchlist_aml_breakdown_adverse_media.py +100 -0
- onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.py +100 -0
- onfido/models/watchlist_aml_breakdown_politically_exposed_person.py +100 -0
- onfido/models/watchlist_aml_breakdown_sanction.py +100 -0
- onfido/models/watchlist_aml_properties.py +100 -0
- onfido/models/watchlist_aml_report.py +141 -0
- onfido/models/watchlist_enhanced_breakdown.py +122 -0
- onfido/models/watchlist_enhanced_properties.py +100 -0
- onfido/models/watchlist_enhanced_report.py +141 -0
- onfido/models/watchlist_monitor.py +120 -0
- onfido/models/watchlist_monitor_builder.py +111 -0
- onfido/models/watchlist_monitor_match.py +102 -0
- onfido/models/watchlist_monitor_matches_list.py +108 -0
- onfido/models/watchlist_monitor_matches_updater.py +102 -0
- onfido/models/watchlist_monitor_response.py +107 -0
- onfido/models/watchlist_monitor_shared.py +111 -0
- onfido/models/watchlist_monitors_list.py +108 -0
- onfido/models/watchlist_peps_only_report.py +141 -0
- onfido/models/watchlist_sanctions_only_report.py +141 -0
- onfido/models/watchlist_standard_breakdown.py +116 -0
- onfido/models/watchlist_standard_properties.py +100 -0
- onfido/models/watchlist_standard_report.py +141 -0
- onfido/models/webhook.py +115 -0
- onfido/models/webhook_builder.py +109 -0
- onfido/models/webhook_create.py +100 -0
- onfido/models/webhook_event.py +104 -0
- onfido/models/webhook_event_payload.py +111 -0
- onfido/models/webhook_event_payload_object.py +109 -0
- onfido/models/webhook_event_type.py +52 -0
- onfido/models/webhook_resend.py +108 -0
- onfido/models/webhook_response.py +106 -0
- onfido/models/webhook_shared.py +107 -0
- onfido/models/webhook_update.py +100 -0
- onfido/models/webhook_updater.py +109 -0
- onfido/models/webhooks_list.py +108 -0
- onfido/models/webhooks_resend_item.py +103 -0
- onfido/models/workflow_run.py +158 -0
- onfido/models/workflow_run_builder.py +125 -0
- onfido/models/workflow_run_request.py +100 -0
- onfido/models/workflow_run_response.py +133 -0
- onfido/models/workflow_run_response_error.py +102 -0
- onfido/models/workflow_run_shared.py +123 -0
- onfido/models/workflow_run_shared_link.py +119 -0
- onfido/py.typed +0 -0
- onfido/rest.py +258 -0
- onfido/webhook_event_verifier.py +27 -0
- onfido_python-3.4.0.dist-info/LICENSE +21 -0
- onfido_python-3.4.0.dist-info/METADATA +18 -0
- onfido_python-3.4.0.dist-info/RECORD +291 -0
- onfido_python-3.4.0.dist-info/WHEEL +5 -0
- onfido_python-3.4.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,106 @@
|
|
|
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, StrictStr
|
|
21
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from typing import Optional, Set
|
|
23
|
+
from typing_extensions import Self
|
|
24
|
+
|
|
25
|
+
class DocumentODPReasons(BaseModel):
|
|
26
|
+
"""
|
|
27
|
+
DocumentODPReasons
|
|
28
|
+
""" # noqa: E501
|
|
29
|
+
photo_of_screen: Optional[StrictStr] = Field(default=None, description="When the applicant's document is on a physical screen or device.")
|
|
30
|
+
screenshot: Optional[StrictStr] = Field(default=None, description="When the applicant has used their mobile phone, tablet, or computer to take a photo within the device.")
|
|
31
|
+
document_on_printed_paper: Optional[StrictStr] = Field(default=None, description="When the applicant has previously captured an image of the document, printed it out, and has now taken a photo of this print out to upload.")
|
|
32
|
+
scan: Optional[StrictStr] = Field(default=None, description="When the document has clearly been captured using a scanner and there are visible indicators of this")
|
|
33
|
+
additional_properties: Dict[str, Any] = {}
|
|
34
|
+
__properties: ClassVar[List[str]] = ["photo_of_screen", "screenshot", "document_on_printed_paper", "scan"]
|
|
35
|
+
|
|
36
|
+
model_config = ConfigDict(
|
|
37
|
+
populate_by_name=True,
|
|
38
|
+
validate_assignment=True,
|
|
39
|
+
protected_namespaces=(),
|
|
40
|
+
)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
def to_str(self) -> str:
|
|
44
|
+
"""Returns the string representation of the model using alias"""
|
|
45
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
46
|
+
|
|
47
|
+
def to_json(self) -> str:
|
|
48
|
+
"""Returns the JSON representation of the model using alias"""
|
|
49
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
50
|
+
return json.dumps(self.to_dict())
|
|
51
|
+
|
|
52
|
+
@classmethod
|
|
53
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
54
|
+
"""Create an instance of DocumentODPReasons from a JSON string"""
|
|
55
|
+
return cls.from_dict(json.loads(json_str))
|
|
56
|
+
|
|
57
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
58
|
+
"""Return the dictionary representation of the model using alias.
|
|
59
|
+
|
|
60
|
+
This has the following differences from calling pydantic's
|
|
61
|
+
`self.model_dump(by_alias=True)`:
|
|
62
|
+
|
|
63
|
+
* `None` is only added to the output dict for nullable fields that
|
|
64
|
+
were set at model initialization. Other fields with value `None`
|
|
65
|
+
are ignored.
|
|
66
|
+
* Fields in `self.additional_properties` are added to the output dict.
|
|
67
|
+
"""
|
|
68
|
+
excluded_fields: Set[str] = set([
|
|
69
|
+
"additional_properties",
|
|
70
|
+
])
|
|
71
|
+
|
|
72
|
+
_dict = self.model_dump(
|
|
73
|
+
by_alias=True,
|
|
74
|
+
exclude=excluded_fields,
|
|
75
|
+
exclude_none=True,
|
|
76
|
+
)
|
|
77
|
+
# puts key-value pairs in additional_properties in the top level
|
|
78
|
+
if self.additional_properties is not None:
|
|
79
|
+
for _key, _value in self.additional_properties.items():
|
|
80
|
+
_dict[_key] = _value
|
|
81
|
+
|
|
82
|
+
return _dict
|
|
83
|
+
|
|
84
|
+
@classmethod
|
|
85
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
86
|
+
"""Create an instance of DocumentODPReasons from a dict"""
|
|
87
|
+
if obj is None:
|
|
88
|
+
return None
|
|
89
|
+
|
|
90
|
+
if not isinstance(obj, dict):
|
|
91
|
+
return cls.model_validate(obj)
|
|
92
|
+
|
|
93
|
+
_obj = cls.model_validate({
|
|
94
|
+
"photo_of_screen": obj.get("photo_of_screen"),
|
|
95
|
+
"screenshot": obj.get("screenshot"),
|
|
96
|
+
"document_on_printed_paper": obj.get("document_on_printed_paper"),
|
|
97
|
+
"scan": obj.get("scan")
|
|
98
|
+
})
|
|
99
|
+
# store additional fields in additional_properties
|
|
100
|
+
for _key in obj.keys():
|
|
101
|
+
if _key not in cls.__properties:
|
|
102
|
+
_obj.additional_properties[_key] = obj.get(_key)
|
|
103
|
+
|
|
104
|
+
return _obj
|
|
105
|
+
|
|
106
|
+
|
|
@@ -0,0 +1,255 @@
|
|
|
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 datetime import date
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr, field_validator
|
|
22
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
|
+
from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
|
|
24
|
+
from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
|
|
25
|
+
from onfido.models.document_properties_document_classification import DocumentPropertiesDocumentClassification
|
|
26
|
+
from onfido.models.document_properties_document_numbers_inner import DocumentPropertiesDocumentNumbersInner
|
|
27
|
+
from onfido.models.document_properties_driving_licence_information import DocumentPropertiesDrivingLicenceInformation
|
|
28
|
+
from onfido.models.document_properties_extracted_data import DocumentPropertiesExtractedData
|
|
29
|
+
from onfido.models.document_properties_nfc import DocumentPropertiesNfc
|
|
30
|
+
from typing import Optional, Set
|
|
31
|
+
from typing_extensions import Self
|
|
32
|
+
|
|
33
|
+
class DocumentProperties(BaseModel):
|
|
34
|
+
"""
|
|
35
|
+
DocumentProperties
|
|
36
|
+
""" # noqa: E501
|
|
37
|
+
date_of_birth: Optional[date] = None
|
|
38
|
+
date_of_expiry: Optional[date] = None
|
|
39
|
+
personal_number: Optional[StrictStr] = None
|
|
40
|
+
document_numbers: Optional[List[DocumentPropertiesDocumentNumbersInner]] = None
|
|
41
|
+
document_type: Optional[StrictStr] = None
|
|
42
|
+
first_name: Optional[StrictStr] = None
|
|
43
|
+
middle_name: Optional[StrictStr] = None
|
|
44
|
+
last_name: Optional[StrictStr] = None
|
|
45
|
+
gender: Optional[StrictStr] = None
|
|
46
|
+
issuing_country: Optional[StrictStr] = None
|
|
47
|
+
nationality: Optional[StrictStr] = None
|
|
48
|
+
issuing_state: Optional[StrictStr] = None
|
|
49
|
+
issuing_date: Optional[date] = None
|
|
50
|
+
categorisation: Optional[StrictStr] = None
|
|
51
|
+
mrz_line1: Optional[StrictStr] = None
|
|
52
|
+
mrz_line2: Optional[StrictStr] = None
|
|
53
|
+
mrz_line3: Optional[StrictStr] = None
|
|
54
|
+
address: Optional[StrictStr] = None
|
|
55
|
+
place_of_birth: Optional[StrictStr] = None
|
|
56
|
+
spouse_name: Optional[StrictStr] = None
|
|
57
|
+
widow_name: Optional[StrictStr] = None
|
|
58
|
+
alias_name: Optional[StrictStr] = None
|
|
59
|
+
issuing_authority: Optional[StrictStr] = None
|
|
60
|
+
remarks: Optional[StrictStr] = None
|
|
61
|
+
civil_state: Optional[StrictStr] = None
|
|
62
|
+
expatriation: Optional[StrictStr] = None
|
|
63
|
+
father_name: Optional[StrictStr] = None
|
|
64
|
+
mother_name: Optional[StrictStr] = None
|
|
65
|
+
religion: Optional[StrictStr] = None
|
|
66
|
+
type_of_permit: Optional[StrictStr] = None
|
|
67
|
+
version_number: Optional[StrictStr] = None
|
|
68
|
+
document_subtype: Optional[StrictStr] = None
|
|
69
|
+
profession: Optional[StrictStr] = None
|
|
70
|
+
security_document_number: Optional[StrictStr] = None
|
|
71
|
+
tax_number: Optional[StrictStr] = None
|
|
72
|
+
nist_identity_evidence_strength: Optional[StrictStr] = None
|
|
73
|
+
has_issuance_confirmation: Optional[StrictStr] = None
|
|
74
|
+
real_id_compliance: Optional[StrictBool] = None
|
|
75
|
+
security_tier: Optional[StrictStr] = None
|
|
76
|
+
address_lines: Optional[DocumentPropertiesAddressLines] = None
|
|
77
|
+
barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
|
|
78
|
+
nfc: Optional[DocumentPropertiesNfc] = None
|
|
79
|
+
driving_licence_information: Optional[DocumentPropertiesDrivingLicenceInformation] = None
|
|
80
|
+
document_classification: Optional[DocumentPropertiesDocumentClassification] = None
|
|
81
|
+
extracted_data: Optional[DocumentPropertiesExtractedData] = None
|
|
82
|
+
additional_properties: Dict[str, Any] = {}
|
|
83
|
+
__properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "middle_name", "last_name", "gender", "issuing_country", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data"]
|
|
84
|
+
|
|
85
|
+
@field_validator('nist_identity_evidence_strength')
|
|
86
|
+
def nist_identity_evidence_strength_validate_enum(cls, value):
|
|
87
|
+
"""Validates the enum"""
|
|
88
|
+
if value is None:
|
|
89
|
+
return value
|
|
90
|
+
|
|
91
|
+
if value not in set(['superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength']):
|
|
92
|
+
raise ValueError("must be one of enum values ('superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength')")
|
|
93
|
+
return value
|
|
94
|
+
|
|
95
|
+
@field_validator('has_issuance_confirmation')
|
|
96
|
+
def has_issuance_confirmation_validate_enum(cls, value):
|
|
97
|
+
"""Validates the enum"""
|
|
98
|
+
if value is None:
|
|
99
|
+
return value
|
|
100
|
+
|
|
101
|
+
if value not in set(['true', 'false', 'unspecified']):
|
|
102
|
+
raise ValueError("must be one of enum values ('true', 'false', 'unspecified')")
|
|
103
|
+
return value
|
|
104
|
+
|
|
105
|
+
@field_validator('security_tier')
|
|
106
|
+
def security_tier_validate_enum(cls, value):
|
|
107
|
+
"""Validates the enum"""
|
|
108
|
+
if value is None:
|
|
109
|
+
return value
|
|
110
|
+
|
|
111
|
+
if value not in set(['tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier']):
|
|
112
|
+
raise ValueError("must be one of enum values ('tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier')")
|
|
113
|
+
return value
|
|
114
|
+
|
|
115
|
+
model_config = ConfigDict(
|
|
116
|
+
populate_by_name=True,
|
|
117
|
+
validate_assignment=True,
|
|
118
|
+
protected_namespaces=(),
|
|
119
|
+
)
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
def to_str(self) -> str:
|
|
123
|
+
"""Returns the string representation of the model using alias"""
|
|
124
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
125
|
+
|
|
126
|
+
def to_json(self) -> str:
|
|
127
|
+
"""Returns the JSON representation of the model using alias"""
|
|
128
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
129
|
+
return json.dumps(self.to_dict())
|
|
130
|
+
|
|
131
|
+
@classmethod
|
|
132
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
133
|
+
"""Create an instance of DocumentProperties from a JSON string"""
|
|
134
|
+
return cls.from_dict(json.loads(json_str))
|
|
135
|
+
|
|
136
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
137
|
+
"""Return the dictionary representation of the model using alias.
|
|
138
|
+
|
|
139
|
+
This has the following differences from calling pydantic's
|
|
140
|
+
`self.model_dump(by_alias=True)`:
|
|
141
|
+
|
|
142
|
+
* `None` is only added to the output dict for nullable fields that
|
|
143
|
+
were set at model initialization. Other fields with value `None`
|
|
144
|
+
are ignored.
|
|
145
|
+
* Fields in `self.additional_properties` are added to the output dict.
|
|
146
|
+
"""
|
|
147
|
+
excluded_fields: Set[str] = set([
|
|
148
|
+
"additional_properties",
|
|
149
|
+
])
|
|
150
|
+
|
|
151
|
+
_dict = self.model_dump(
|
|
152
|
+
by_alias=True,
|
|
153
|
+
exclude=excluded_fields,
|
|
154
|
+
exclude_none=True,
|
|
155
|
+
)
|
|
156
|
+
# override the default output from pydantic by calling `to_dict()` of each item in document_numbers (list)
|
|
157
|
+
_items = []
|
|
158
|
+
if self.document_numbers:
|
|
159
|
+
for _item in self.document_numbers:
|
|
160
|
+
if _item:
|
|
161
|
+
_items.append(_item.to_dict())
|
|
162
|
+
_dict['document_numbers'] = _items
|
|
163
|
+
# override the default output from pydantic by calling `to_dict()` of address_lines
|
|
164
|
+
if self.address_lines:
|
|
165
|
+
_dict['address_lines'] = self.address_lines.to_dict()
|
|
166
|
+
# override the default output from pydantic by calling `to_dict()` of each item in barcode (list)
|
|
167
|
+
_items = []
|
|
168
|
+
if self.barcode:
|
|
169
|
+
for _item in self.barcode:
|
|
170
|
+
if _item:
|
|
171
|
+
_items.append(_item.to_dict())
|
|
172
|
+
_dict['barcode'] = _items
|
|
173
|
+
# override the default output from pydantic by calling `to_dict()` of nfc
|
|
174
|
+
if self.nfc:
|
|
175
|
+
_dict['nfc'] = self.nfc.to_dict()
|
|
176
|
+
# override the default output from pydantic by calling `to_dict()` of driving_licence_information
|
|
177
|
+
if self.driving_licence_information:
|
|
178
|
+
_dict['driving_licence_information'] = self.driving_licence_information.to_dict()
|
|
179
|
+
# override the default output from pydantic by calling `to_dict()` of document_classification
|
|
180
|
+
if self.document_classification:
|
|
181
|
+
_dict['document_classification'] = self.document_classification.to_dict()
|
|
182
|
+
# override the default output from pydantic by calling `to_dict()` of extracted_data
|
|
183
|
+
if self.extracted_data:
|
|
184
|
+
_dict['extracted_data'] = self.extracted_data.to_dict()
|
|
185
|
+
# puts key-value pairs in additional_properties in the top level
|
|
186
|
+
if self.additional_properties is not None:
|
|
187
|
+
for _key, _value in self.additional_properties.items():
|
|
188
|
+
_dict[_key] = _value
|
|
189
|
+
|
|
190
|
+
return _dict
|
|
191
|
+
|
|
192
|
+
@classmethod
|
|
193
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
194
|
+
"""Create an instance of DocumentProperties from a dict"""
|
|
195
|
+
if obj is None:
|
|
196
|
+
return None
|
|
197
|
+
|
|
198
|
+
if not isinstance(obj, dict):
|
|
199
|
+
return cls.model_validate(obj)
|
|
200
|
+
|
|
201
|
+
_obj = cls.model_validate({
|
|
202
|
+
"date_of_birth": obj.get("date_of_birth"),
|
|
203
|
+
"date_of_expiry": obj.get("date_of_expiry"),
|
|
204
|
+
"personal_number": obj.get("personal_number"),
|
|
205
|
+
"document_numbers": [DocumentPropertiesDocumentNumbersInner.from_dict(_item) for _item in obj["document_numbers"]] if obj.get("document_numbers") is not None else None,
|
|
206
|
+
"document_type": obj.get("document_type"),
|
|
207
|
+
"first_name": obj.get("first_name"),
|
|
208
|
+
"middle_name": obj.get("middle_name"),
|
|
209
|
+
"last_name": obj.get("last_name"),
|
|
210
|
+
"gender": obj.get("gender"),
|
|
211
|
+
"issuing_country": obj.get("issuing_country"),
|
|
212
|
+
"nationality": obj.get("nationality"),
|
|
213
|
+
"issuing_state": obj.get("issuing_state"),
|
|
214
|
+
"issuing_date": obj.get("issuing_date"),
|
|
215
|
+
"categorisation": obj.get("categorisation"),
|
|
216
|
+
"mrz_line1": obj.get("mrz_line1"),
|
|
217
|
+
"mrz_line2": obj.get("mrz_line2"),
|
|
218
|
+
"mrz_line3": obj.get("mrz_line3"),
|
|
219
|
+
"address": obj.get("address"),
|
|
220
|
+
"place_of_birth": obj.get("place_of_birth"),
|
|
221
|
+
"spouse_name": obj.get("spouse_name"),
|
|
222
|
+
"widow_name": obj.get("widow_name"),
|
|
223
|
+
"alias_name": obj.get("alias_name"),
|
|
224
|
+
"issuing_authority": obj.get("issuing_authority"),
|
|
225
|
+
"remarks": obj.get("remarks"),
|
|
226
|
+
"civil_state": obj.get("civil_state"),
|
|
227
|
+
"expatriation": obj.get("expatriation"),
|
|
228
|
+
"father_name": obj.get("father_name"),
|
|
229
|
+
"mother_name": obj.get("mother_name"),
|
|
230
|
+
"religion": obj.get("religion"),
|
|
231
|
+
"type_of_permit": obj.get("type_of_permit"),
|
|
232
|
+
"version_number": obj.get("version_number"),
|
|
233
|
+
"document_subtype": obj.get("document_subtype"),
|
|
234
|
+
"profession": obj.get("profession"),
|
|
235
|
+
"security_document_number": obj.get("security_document_number"),
|
|
236
|
+
"tax_number": obj.get("tax_number"),
|
|
237
|
+
"nist_identity_evidence_strength": obj.get("nist_identity_evidence_strength"),
|
|
238
|
+
"has_issuance_confirmation": obj.get("has_issuance_confirmation"),
|
|
239
|
+
"real_id_compliance": obj.get("real_id_compliance"),
|
|
240
|
+
"security_tier": obj.get("security_tier"),
|
|
241
|
+
"address_lines": DocumentPropertiesAddressLines.from_dict(obj["address_lines"]) if obj.get("address_lines") is not None else None,
|
|
242
|
+
"barcode": [DocumentPropertiesBarcodeInner.from_dict(_item) for _item in obj["barcode"]] if obj.get("barcode") is not None else None,
|
|
243
|
+
"nfc": DocumentPropertiesNfc.from_dict(obj["nfc"]) if obj.get("nfc") is not None else None,
|
|
244
|
+
"driving_licence_information": DocumentPropertiesDrivingLicenceInformation.from_dict(obj["driving_licence_information"]) if obj.get("driving_licence_information") is not None else None,
|
|
245
|
+
"document_classification": DocumentPropertiesDocumentClassification.from_dict(obj["document_classification"]) if obj.get("document_classification") is not None else None,
|
|
246
|
+
"extracted_data": DocumentPropertiesExtractedData.from_dict(obj["extracted_data"]) if obj.get("extracted_data") is not None else None
|
|
247
|
+
})
|
|
248
|
+
# store additional fields in additional_properties
|
|
249
|
+
for _key in obj.keys():
|
|
250
|
+
if _key not in cls.__properties:
|
|
251
|
+
_obj.additional_properties[_key] = obj.get(_key)
|
|
252
|
+
|
|
253
|
+
return _obj
|
|
254
|
+
|
|
255
|
+
|
|
@@ -0,0 +1,110 @@
|
|
|
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, StrictStr
|
|
21
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from typing import Optional, Set
|
|
23
|
+
from typing_extensions import Self
|
|
24
|
+
|
|
25
|
+
class DocumentPropertiesAddressLines(BaseModel):
|
|
26
|
+
"""
|
|
27
|
+
DocumentPropertiesAddressLines
|
|
28
|
+
""" # noqa: E501
|
|
29
|
+
street_address: Optional[StrictStr] = None
|
|
30
|
+
state: Optional[StrictStr] = None
|
|
31
|
+
postal_code: Optional[StrictStr] = None
|
|
32
|
+
country: Optional[StrictStr] = None
|
|
33
|
+
city: Optional[StrictStr] = None
|
|
34
|
+
country_code: Optional[StrictStr] = None
|
|
35
|
+
additional_properties: Dict[str, Any] = {}
|
|
36
|
+
__properties: ClassVar[List[str]] = ["street_address", "state", "postal_code", "country", "city", "country_code"]
|
|
37
|
+
|
|
38
|
+
model_config = ConfigDict(
|
|
39
|
+
populate_by_name=True,
|
|
40
|
+
validate_assignment=True,
|
|
41
|
+
protected_namespaces=(),
|
|
42
|
+
)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
def to_str(self) -> str:
|
|
46
|
+
"""Returns the string representation of the model using alias"""
|
|
47
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
48
|
+
|
|
49
|
+
def to_json(self) -> str:
|
|
50
|
+
"""Returns the JSON representation of the model using alias"""
|
|
51
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
52
|
+
return json.dumps(self.to_dict())
|
|
53
|
+
|
|
54
|
+
@classmethod
|
|
55
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
56
|
+
"""Create an instance of DocumentPropertiesAddressLines from a JSON string"""
|
|
57
|
+
return cls.from_dict(json.loads(json_str))
|
|
58
|
+
|
|
59
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
60
|
+
"""Return the dictionary representation of the model using alias.
|
|
61
|
+
|
|
62
|
+
This has the following differences from calling pydantic's
|
|
63
|
+
`self.model_dump(by_alias=True)`:
|
|
64
|
+
|
|
65
|
+
* `None` is only added to the output dict for nullable fields that
|
|
66
|
+
were set at model initialization. Other fields with value `None`
|
|
67
|
+
are ignored.
|
|
68
|
+
* Fields in `self.additional_properties` are added to the output dict.
|
|
69
|
+
"""
|
|
70
|
+
excluded_fields: Set[str] = set([
|
|
71
|
+
"additional_properties",
|
|
72
|
+
])
|
|
73
|
+
|
|
74
|
+
_dict = self.model_dump(
|
|
75
|
+
by_alias=True,
|
|
76
|
+
exclude=excluded_fields,
|
|
77
|
+
exclude_none=True,
|
|
78
|
+
)
|
|
79
|
+
# puts key-value pairs in additional_properties in the top level
|
|
80
|
+
if self.additional_properties is not None:
|
|
81
|
+
for _key, _value in self.additional_properties.items():
|
|
82
|
+
_dict[_key] = _value
|
|
83
|
+
|
|
84
|
+
return _dict
|
|
85
|
+
|
|
86
|
+
@classmethod
|
|
87
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
88
|
+
"""Create an instance of DocumentPropertiesAddressLines from a dict"""
|
|
89
|
+
if obj is None:
|
|
90
|
+
return None
|
|
91
|
+
|
|
92
|
+
if not isinstance(obj, dict):
|
|
93
|
+
return cls.model_validate(obj)
|
|
94
|
+
|
|
95
|
+
_obj = cls.model_validate({
|
|
96
|
+
"street_address": obj.get("street_address"),
|
|
97
|
+
"state": obj.get("state"),
|
|
98
|
+
"postal_code": obj.get("postal_code"),
|
|
99
|
+
"country": obj.get("country"),
|
|
100
|
+
"city": obj.get("city"),
|
|
101
|
+
"country_code": obj.get("country_code")
|
|
102
|
+
})
|
|
103
|
+
# store additional fields in additional_properties
|
|
104
|
+
for _key in obj.keys():
|
|
105
|
+
if _key not in cls.__properties:
|
|
106
|
+
_obj.additional_properties[_key] = obj.get(_key)
|
|
107
|
+
|
|
108
|
+
return _obj
|
|
109
|
+
|
|
110
|
+
|
|
@@ -0,0 +1,135 @@
|
|
|
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 datetime import date
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictStr
|
|
22
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
|
+
from typing import Optional, Set
|
|
24
|
+
from typing_extensions import Self
|
|
25
|
+
|
|
26
|
+
class DocumentPropertiesBarcodeInner(BaseModel):
|
|
27
|
+
"""
|
|
28
|
+
DocumentPropertiesBarcodeInner
|
|
29
|
+
""" # noqa: E501
|
|
30
|
+
first_name: Optional[StrictStr] = None
|
|
31
|
+
middle_name: Optional[StrictStr] = None
|
|
32
|
+
last_name: Optional[StrictStr] = None
|
|
33
|
+
document_type: Optional[StrictStr] = None
|
|
34
|
+
date_of_expiry: Optional[date] = None
|
|
35
|
+
date_of_birth: Optional[date] = None
|
|
36
|
+
issuing_date: Optional[date] = None
|
|
37
|
+
address_line_1: Optional[StrictStr] = None
|
|
38
|
+
address_line_2: Optional[StrictStr] = None
|
|
39
|
+
address_line_3: Optional[StrictStr] = None
|
|
40
|
+
address_line_4: Optional[StrictStr] = None
|
|
41
|
+
address_line_5: Optional[StrictStr] = None
|
|
42
|
+
issuing_state: Optional[StrictStr] = None
|
|
43
|
+
var_class: Optional[StrictStr] = Field(default=None, alias="class")
|
|
44
|
+
gender: Optional[StrictStr] = None
|
|
45
|
+
issuing_country: Optional[StrictStr] = None
|
|
46
|
+
document_number: Optional[StrictStr] = None
|
|
47
|
+
real_id_classification: Optional[StrictStr] = None
|
|
48
|
+
additional_properties: Dict[str, Any] = {}
|
|
49
|
+
__properties: ClassVar[List[str]] = ["first_name", "middle_name", "last_name", "document_type", "date_of_expiry", "date_of_birth", "issuing_date", "address_line_1", "address_line_2", "address_line_3", "address_line_4", "address_line_5", "issuing_state", "class", "gender", "issuing_country", "document_number", "real_id_classification"]
|
|
50
|
+
|
|
51
|
+
model_config = ConfigDict(
|
|
52
|
+
populate_by_name=True,
|
|
53
|
+
validate_assignment=True,
|
|
54
|
+
protected_namespaces=(),
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
def to_str(self) -> str:
|
|
59
|
+
"""Returns the string representation of the model using alias"""
|
|
60
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
61
|
+
|
|
62
|
+
def to_json(self) -> str:
|
|
63
|
+
"""Returns the JSON representation of the model using alias"""
|
|
64
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
65
|
+
return json.dumps(self.to_dict())
|
|
66
|
+
|
|
67
|
+
@classmethod
|
|
68
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
69
|
+
"""Create an instance of DocumentPropertiesBarcodeInner from a JSON string"""
|
|
70
|
+
return cls.from_dict(json.loads(json_str))
|
|
71
|
+
|
|
72
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
73
|
+
"""Return the dictionary representation of the model using alias.
|
|
74
|
+
|
|
75
|
+
This has the following differences from calling pydantic's
|
|
76
|
+
`self.model_dump(by_alias=True)`:
|
|
77
|
+
|
|
78
|
+
* `None` is only added to the output dict for nullable fields that
|
|
79
|
+
were set at model initialization. Other fields with value `None`
|
|
80
|
+
are ignored.
|
|
81
|
+
* Fields in `self.additional_properties` are added to the output dict.
|
|
82
|
+
"""
|
|
83
|
+
excluded_fields: Set[str] = set([
|
|
84
|
+
"additional_properties",
|
|
85
|
+
])
|
|
86
|
+
|
|
87
|
+
_dict = self.model_dump(
|
|
88
|
+
by_alias=True,
|
|
89
|
+
exclude=excluded_fields,
|
|
90
|
+
exclude_none=True,
|
|
91
|
+
)
|
|
92
|
+
# puts key-value pairs in additional_properties in the top level
|
|
93
|
+
if self.additional_properties is not None:
|
|
94
|
+
for _key, _value in self.additional_properties.items():
|
|
95
|
+
_dict[_key] = _value
|
|
96
|
+
|
|
97
|
+
return _dict
|
|
98
|
+
|
|
99
|
+
@classmethod
|
|
100
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
101
|
+
"""Create an instance of DocumentPropertiesBarcodeInner from a dict"""
|
|
102
|
+
if obj is None:
|
|
103
|
+
return None
|
|
104
|
+
|
|
105
|
+
if not isinstance(obj, dict):
|
|
106
|
+
return cls.model_validate(obj)
|
|
107
|
+
|
|
108
|
+
_obj = cls.model_validate({
|
|
109
|
+
"first_name": obj.get("first_name"),
|
|
110
|
+
"middle_name": obj.get("middle_name"),
|
|
111
|
+
"last_name": obj.get("last_name"),
|
|
112
|
+
"document_type": obj.get("document_type"),
|
|
113
|
+
"date_of_expiry": obj.get("date_of_expiry"),
|
|
114
|
+
"date_of_birth": obj.get("date_of_birth"),
|
|
115
|
+
"issuing_date": obj.get("issuing_date"),
|
|
116
|
+
"address_line_1": obj.get("address_line_1"),
|
|
117
|
+
"address_line_2": obj.get("address_line_2"),
|
|
118
|
+
"address_line_3": obj.get("address_line_3"),
|
|
119
|
+
"address_line_4": obj.get("address_line_4"),
|
|
120
|
+
"address_line_5": obj.get("address_line_5"),
|
|
121
|
+
"issuing_state": obj.get("issuing_state"),
|
|
122
|
+
"class": obj.get("class"),
|
|
123
|
+
"gender": obj.get("gender"),
|
|
124
|
+
"issuing_country": obj.get("issuing_country"),
|
|
125
|
+
"document_number": obj.get("document_number"),
|
|
126
|
+
"real_id_classification": obj.get("real_id_classification")
|
|
127
|
+
})
|
|
128
|
+
# store additional fields in additional_properties
|
|
129
|
+
for _key in obj.keys():
|
|
130
|
+
if _key not in cls.__properties:
|
|
131
|
+
_obj.additional_properties[_key] = obj.get(_key)
|
|
132
|
+
|
|
133
|
+
return _obj
|
|
134
|
+
|
|
135
|
+
|