onfido-python 4.6.0__py3-none-any.whl → 5.1.0__py3-none-any.whl

onfido/models/document_video_report.py

@@ -41,12 +41,12 @@ class DocumentVideoReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     breakdown: Optional[DocumentBreakdown] = None
     properties: Optional[DocumentProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -126,8 +126,8 @@ class DocumentVideoReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "breakdown": DocumentBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": DocumentProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

onfido/models/document_video_with_address_information_report.py

@@ -41,12 +41,12 @@ class DocumentVideoWithAddressInformationReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     breakdown: Optional[DocumentBreakdown] = None
     properties: Optional[DocumentProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -126,8 +126,8 @@ class DocumentVideoWithAddressInformationReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "breakdown": DocumentBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": DocumentProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

onfido/models/document_with_address_information_report.py

@@ -41,12 +41,12 @@ class DocumentWithAddressInformationReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     breakdown: Optional[DocumentBreakdown] = None
     properties: Optional[DocumentProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -126,8 +126,8 @@ class DocumentWithAddressInformationReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "breakdown": DocumentBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": DocumentProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

onfido/models/document_with_driver_verification_report.py

@@ -41,12 +41,12 @@ class DocumentWithDriverVerificationReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     breakdown: Optional[DocumentBreakdown] = None
     properties: Optional[DocumentWithDriverVerificationReportAllOfProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -126,8 +126,8 @@ class DocumentWithDriverVerificationReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "breakdown": DocumentBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": DocumentWithDriverVerificationReportAllOfProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

onfido/models/document_with_driver_verification_report_all_of_properties.py

@@ -24,7 +24,7 @@ from onfido.models.document_properties_address_lines import DocumentPropertiesAd
 from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
 from onfido.models.document_properties_document_classification import DocumentPropertiesDocumentClassification
 from onfido.models.document_properties_document_numbers_inner import DocumentPropertiesDocumentNumbersInner
-from onfido.models.document_properties_driving_licence_information import DocumentPropertiesDrivingLicenceInformation
+from onfido.models.document_properties_driving_licence_information_item import DocumentPropertiesDrivingLicenceInformationItem
 from onfido.models.document_properties_extracted_data import DocumentPropertiesExtractedData
 from onfido.models.document_properties_nfc import DocumentPropertiesNfc
 from onfido.models.document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle import DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle
@@ -78,7 +78,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     address_lines: Optional[DocumentPropertiesAddressLines] = None
     barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
     nfc: Optional[DocumentPropertiesNfc] = None
-    driving_licence_information: Optional[DocumentPropertiesDrivingLicenceInformation] = None
+    driving_licence_information: Optional[List[DocumentPropertiesDrivingLicenceInformationItem]] = None
     document_classification: Optional[DocumentPropertiesDocumentClassification] = None
     extracted_data: Optional[DocumentPropertiesExtractedData] = None
     drivers_licence: Optional[StrictBool] = Field(default=None, description="True for **non-restricted** driving licences")
@@ -96,8 +96,8 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength']):
-            raise ValueError("must be one of enum values ('superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength')")
+        if value not in set(['superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength', 'unknown_default_open_api')")
         return value
 
     @field_validator('has_issuance_confirmation')
@@ -106,8 +106,8 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['true', 'false', 'unspecified']):
-            raise ValueError("must be one of enum values ('true', 'false', 'unspecified')")
+        if value not in set(['true', 'false', 'unspecified', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('true', 'false', 'unspecified', 'unknown_default_open_api')")
         return value
 
     @field_validator('security_tier')
@@ -116,8 +116,8 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier']):
-            raise ValueError("must be one of enum values ('tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier')")
+        if value not in set(['tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(
@@ -181,9 +181,13 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of nfc
         if self.nfc:
             _dict['nfc'] = self.nfc.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of driving_licence_information
+        # override the default output from pydantic by calling `to_dict()` of each item in driving_licence_information (list)
+        _items = []
         if self.driving_licence_information:
-            _dict['driving_licence_information'] = self.driving_licence_information.to_dict()
+            for _item_driving_licence_information in self.driving_licence_information:
+                if _item_driving_licence_information:
+                    _items.append(_item_driving_licence_information.to_dict())
+            _dict['driving_licence_information'] = _items
         # override the default output from pydantic by calling `to_dict()` of document_classification
         if self.document_classification:
             _dict['document_classification'] = self.document_classification.to_dict()
@@ -259,7 +263,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
             "address_lines": DocumentPropertiesAddressLines.from_dict(obj["address_lines"]) if obj.get("address_lines") is not None else None,
             "barcode": [DocumentPropertiesBarcodeInner.from_dict(_item) for _item in obj["barcode"]] if obj.get("barcode") is not None else None,
             "nfc": DocumentPropertiesNfc.from_dict(obj["nfc"]) if obj.get("nfc") is not None else None,
-            "driving_licence_information": DocumentPropertiesDrivingLicenceInformation.from_dict(obj["driving_licence_information"]) if obj.get("driving_licence_information") is not None else None,
+            "driving_licence_information": [DocumentPropertiesDrivingLicenceInformationItem.from_dict(_item) for _item in obj["driving_licence_information"]] if obj.get("driving_licence_information") is not None else None,
             "document_classification": DocumentPropertiesDocumentClassification.from_dict(obj["document_classification"]) if obj.get("document_classification") is not None else None,
             "extracted_data": DocumentPropertiesExtractedData.from_dict(obj["extracted_data"]) if obj.get("extracted_data") is not None else None,
             "drivers_licence": obj.get("drivers_licence"),

onfido/models/document_with_driving_licence_information_report.py

@@ -41,12 +41,12 @@ class DocumentWithDrivingLicenceInformationReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     breakdown: Optional[DocumentBreakdown] = None
     properties: Optional[DocumentProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -126,8 +126,8 @@ class DocumentWithDrivingLicenceInformationReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "breakdown": DocumentBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": DocumentProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

onfido/models/extraction_document_classification.py

@@ -42,8 +42,8 @@ class ExtractionDocumentClassification(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['full', 'not_full', 'provisional']):
-            raise ValueError("must be one of enum values ('full', 'not_full', 'provisional')")
+        if value not in set(['full', 'not_full', 'provisional', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('full', 'not_full', 'provisional', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/extraction_extracted_data.py

@@ -66,8 +66,8 @@ class ExtractionExtractedData(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['Male', 'Female']):
-            raise ValueError("must be one of enum values ('Male', 'Female')")
+        if value not in set(['Male', 'Female', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('Male', 'Female', 'unknown_default_open_api')")
         return value
 
     @field_validator('nationality')

onfido/models/facial_similarity_motion_report.py

@@ -42,8 +42,8 @@ class FacialSimilarityMotionReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     live_photos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live photo ids that were used in the Onfido engine.")
     live_videos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live video ids that were used in the Onfido engine.")
     motion_captures: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with motion capture ids that were used in the Onfido engine.")
@@ -51,7 +51,7 @@ class FacialSimilarityMotionReport(BaseModel):
     breakdown: Optional[FacialSimilarityMotionBreakdown] = None
     properties: Optional[FacialSimilarityMotionProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -159,8 +159,8 @@ class FacialSimilarityMotionReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "live_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_photos"]] if obj.get("live_photos") is not None else None,
             "live_videos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_videos"]] if obj.get("live_videos") is not None else None,
             "motion_captures": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["motion_captures"]] if obj.get("motion_captures") is not None else None,

onfido/models/facial_similarity_photo_fully_auto_report.py

@@ -42,8 +42,8 @@ class FacialSimilarityPhotoFullyAutoReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     live_photos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live photo ids that were used in the Onfido engine.")
     live_videos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live video ids that were used in the Onfido engine.")
     motion_captures: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with motion capture ids that were used in the Onfido engine.")
@@ -51,7 +51,7 @@ class FacialSimilarityPhotoFullyAutoReport(BaseModel):
     breakdown: Optional[FacialSimilarityPhotoFullyAutoBreakdown] = None
     properties: Optional[FacialSimilarityPhotoFullyAutoProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -159,8 +159,8 @@ class FacialSimilarityPhotoFullyAutoReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "live_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_photos"]] if obj.get("live_photos") is not None else None,
             "live_videos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_videos"]] if obj.get("live_videos") is not None else None,
             "motion_captures": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["motion_captures"]] if obj.get("motion_captures") is not None else None,

onfido/models/facial_similarity_photo_report.py

@@ -42,8 +42,8 @@ class FacialSimilarityPhotoReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     live_photos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live photo ids that were used in the Onfido engine.")
     live_videos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live video ids that were used in the Onfido engine.")
     motion_captures: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with motion capture ids that were used in the Onfido engine.")
@@ -51,7 +51,7 @@ class FacialSimilarityPhotoReport(BaseModel):
     breakdown: Optional[FacialSimilarityPhotoBreakdown] = None
     properties: Optional[FacialSimilarityPhotoProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -159,8 +159,8 @@ class FacialSimilarityPhotoReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "live_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_photos"]] if obj.get("live_photos") is not None else None,
             "live_videos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_videos"]] if obj.get("live_videos") is not None else None,
             "motion_captures": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["motion_captures"]] if obj.get("motion_captures") is not None else None,

onfido/models/facial_similarity_report_shared.py

@@ -20,6 +20,7 @@ import json
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.facial_similarity_report_media import FacialSimilarityReportMedia
+from onfido.models.report_document import ReportDocument
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,12 +28,13 @@ class FacialSimilarityReportShared(BaseModel):
     """
     FacialSimilarityReportShared
     """ # noqa: E501
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     live_photos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live photo ids that were used in the Onfido engine.")
     live_videos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live video ids that were used in the Onfido engine.")
     motion_captures: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with motion capture ids that were used in the Onfido engine.")
     id_photos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with id photo ids that were used in the Onfido engine.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["live_photos", "live_videos", "motion_captures", "id_photos"]
+    __properties: ClassVar[List[str]] = ["documents", "live_photos", "live_videos", "motion_captures", "id_photos"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -75,6 +77,13 @@ class FacialSimilarityReportShared(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
+        _items = []
+        if self.documents:
+            for _item_documents in self.documents:
+                if _item_documents:
+                    _items.append(_item_documents.to_dict())
+            _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of each item in live_photos (list)
         _items = []
         if self.live_photos:
@@ -120,6 +129,7 @@ class FacialSimilarityReportShared(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "live_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_photos"]] if obj.get("live_photos") is not None else None,
             "live_videos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_videos"]] if obj.get("live_videos") is not None else None,
             "motion_captures": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["motion_captures"]] if obj.get("motion_captures") is not None else None,

onfido/models/facial_similarity_video_report.py

@@ -42,8 +42,8 @@ class FacialSimilarityVideoReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
+    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine.")
     live_photos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live photo ids that were used in the Onfido engine.")
     live_videos: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with live video ids that were used in the Onfido engine.")
     motion_captures: Optional[List[FacialSimilarityReportMedia]] = Field(default=None, description="Array of objects with motion capture ids that were used in the Onfido engine.")
@@ -51,7 +51,7 @@ class FacialSimilarityVideoReport(BaseModel):
     breakdown: Optional[FacialSimilarityVideoBreakdown] = None
     properties: Optional[FacialSimilarityVideoProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "documents", "live_photos", "live_videos", "motion_captures", "id_photos", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -159,8 +159,8 @@ class FacialSimilarityVideoReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
+            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "live_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_photos"]] if obj.get("live_photos") is not None else None,
             "live_videos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["live_videos"]] if obj.get("live_videos") is not None else None,
             "motion_captures": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["motion_captures"]] if obj.get("motion_captures") is not None else None,

onfido/models/id_number.py

@@ -38,8 +38,8 @@ class IdNumber(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_license', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other']):
-            raise ValueError("must be one of enum values ('ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_license', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other')")
+        if value not in set(['ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_license', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_license', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/identity_enhanced_report.py

@@ -22,7 +22,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.identity_enhanced_breakdown import IdentityEnhancedBreakdown
 from onfido.models.identity_enhanced_properties import IdentityEnhancedProperties
-from onfido.models.report_document import ReportDocument
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
 from onfido.models.report_status import ReportStatus
@@ -41,12 +40,11 @@ class IdentityEnhancedReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
     breakdown: Optional[IdentityEnhancedBreakdown] = None
     properties: Optional[IdentityEnhancedProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,13 +87,6 @@ class IdentityEnhancedReport(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
-        _items = []
-        if self.documents:
-            for _item_documents in self.documents:
-                if _item_documents:
-                    _items.append(_item_documents.to_dict())
-            _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -126,7 +117,6 @@ class IdentityEnhancedReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
             "breakdown": IdentityEnhancedBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": IdentityEnhancedProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None

onfido/models/india_pan_report.py

@@ -22,7 +22,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.india_pan_report_all_of_breakdown import IndiaPanReportAllOfBreakdown
 from onfido.models.india_pan_report_all_of_properties import IndiaPanReportAllOfProperties
-from onfido.models.report_document import ReportDocument
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
 from onfido.models.report_status import ReportStatus
@@ -41,12 +40,11 @@ class IndiaPanReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
     breakdown: Optional[IndiaPanReportAllOfBreakdown] = None
     properties: Optional[IndiaPanReportAllOfProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,13 +87,6 @@ class IndiaPanReport(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
-        _items = []
-        if self.documents:
-            for _item_documents in self.documents:
-                if _item_documents:
-                    _items.append(_item_documents.to_dict())
-            _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -126,7 +117,6 @@ class IndiaPanReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
             "breakdown": IndiaPanReportAllOfBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": IndiaPanReportAllOfProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None

onfido/models/known_faces_report.py

@@ -22,7 +22,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.known_faces_breakdown import KnownFacesBreakdown
 from onfido.models.known_faces_properties import KnownFacesProperties
-from onfido.models.report_document import ReportDocument
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
 from onfido.models.report_status import ReportStatus
@@ -41,12 +40,11 @@ class KnownFacesReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
     breakdown: Optional[KnownFacesBreakdown] = None
     properties: Optional[KnownFacesProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,13 +87,6 @@ class KnownFacesReport(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
-        _items = []
-        if self.documents:
-            for _item_documents in self.documents:
-                if _item_documents:
-                    _items.append(_item_documents.to_dict())
-            _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -126,7 +117,6 @@ class KnownFacesReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
             "breakdown": KnownFacesBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": KnownFacesProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None

onfido/models/proof_of_address_properties.py

@@ -44,8 +44,8 @@ class ProofOfAddressProperties(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement']):
-            raise ValueError("must be one of enum values ('bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement')")
+        if value not in set(['bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('bank_building_society_statement', 'utility_bill', 'council_tax', 'benefit_letters', 'mortgage_statement', 'mobile_phone_bill', 'general_letter', 'insurance_statement', 'pension_property_statement_letter', 'identity_document_with_address', 'exchange_house_statement', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/proof_of_address_report.py

@@ -22,7 +22,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.proof_of_address_breakdown import ProofOfAddressBreakdown
 from onfido.models.proof_of_address_properties import ProofOfAddressProperties
-from onfido.models.report_document import ReportDocument
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
 from onfido.models.report_status import ReportStatus
@@ -41,12 +40,11 @@ class ProofOfAddressReport(BaseModel):
     result: Optional[ReportResult] = None
     sub_result: Optional[ReportSubResult] = None
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
-    documents: Optional[List[ReportDocument]] = Field(default=None, description="Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]")
     name: ReportName
     breakdown: Optional[ProofOfAddressBreakdown] = None
     properties: Optional[ProofOfAddressProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name", "breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,13 +87,6 @@ class ProofOfAddressReport(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in documents (list)
-        _items = []
-        if self.documents:
-            for _item_documents in self.documents:
-                if _item_documents:
-                    _items.append(_item_documents.to_dict())
-            _dict['documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -126,7 +117,6 @@ class ProofOfAddressReport(BaseModel):
             "result": obj.get("result"),
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
-            "documents": [ReportDocument.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
             "name": obj.get("name"),
             "breakdown": ProofOfAddressBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": ProofOfAddressProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None