onfido-python 4.0.0__tar.gz → 4.2.0__tar.gz

{onfido_python-4.0.0 → onfido_python-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: onfido-python
-Version: 4.0.0
+Version: 4.2.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "4.0.0"
+__version__ = "4.2.0"
 
 # import apis into sdk package
 from onfido.api.default_api import DefaultApi
@@ -106,7 +106,7 @@ from onfido.models.document_iq_reasons import DocumentIQReasons
 from onfido.models.document_odp_reasons import DocumentODPReasons
 from onfido.models.document_properties import DocumentProperties
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
-from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
+from onfido.models.document_properties_barcode import DocumentPropertiesBarcode
 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
@@ -165,6 +165,8 @@ from onfido.models.facial_similarity_photo_fully_auto_properties import FacialSi
 from onfido.models.facial_similarity_photo_fully_auto_report import FacialSimilarityPhotoFullyAutoReport
 from onfido.models.facial_similarity_photo_properties import FacialSimilarityPhotoProperties
 from onfido.models.facial_similarity_photo_report import FacialSimilarityPhotoReport
+from onfido.models.facial_similarity_report_media import FacialSimilarityReportMedia
+from onfido.models.facial_similarity_report_shared import FacialSimilarityReportShared
 from onfido.models.facial_similarity_video_breakdown import FacialSimilarityVideoBreakdown
 from onfido.models.facial_similarity_video_breakdown_face_comparison import FacialSimilarityVideoBreakdownFaceComparison
 from onfido.models.facial_similarity_video_breakdown_image_integrity import FacialSimilarityVideoBreakdownImageIntegrity

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'onfido-python/4.0.0'
+        self.user_agent = 'onfido-python/4.2.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/configuration.py

@@ -394,7 +394,7 @@ conf = onfido.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v3.6\n"\
-               "SDK Package Version: 4.0.0".\
+               "SDK Package Version: 4.2.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/models/__init__.py

@@ -89,7 +89,7 @@ from onfido.models.document_iq_reasons import DocumentIQReasons
 from onfido.models.document_odp_reasons import DocumentODPReasons
 from onfido.models.document_properties import DocumentProperties
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
-from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
+from onfido.models.document_properties_barcode import DocumentPropertiesBarcode
 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
@@ -148,6 +148,8 @@ from onfido.models.facial_similarity_photo_fully_auto_properties import FacialSi
 from onfido.models.facial_similarity_photo_fully_auto_report import FacialSimilarityPhotoFullyAutoReport
 from onfido.models.facial_similarity_photo_properties import FacialSimilarityPhotoProperties
 from onfido.models.facial_similarity_photo_report import FacialSimilarityPhotoReport
+from onfido.models.facial_similarity_report_media import FacialSimilarityReportMedia
+from onfido.models.facial_similarity_report_shared import FacialSimilarityReportShared
 from onfido.models.facial_similarity_video_breakdown import FacialSimilarityVideoBreakdown
 from onfido.models.facial_similarity_video_breakdown_face_comparison import FacialSimilarityVideoBreakdownFaceComparison
 from onfido.models.facial_similarity_video_breakdown_image_integrity import FacialSimilarityVideoBreakdownImageIntegrity

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/models/document_properties.py

@@ -21,7 +21,7 @@ from datetime import date
 from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
-from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
+from onfido.models.document_properties_barcode import DocumentPropertiesBarcode
 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
@@ -74,7 +74,7 @@ class DocumentProperties(BaseModel):
     real_id_compliance: Optional[StrictBool] = None
     security_tier: Optional[StrictStr] = None
     address_lines: Optional[DocumentPropertiesAddressLines] = None
-    barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
+    barcode: Optional[DocumentPropertiesBarcode] = None
     nfc: Optional[DocumentPropertiesNfc] = None
     driving_licence_information: Optional[DocumentPropertiesDrivingLicenceInformation] = None
     document_classification: Optional[DocumentPropertiesDocumentClassification] = None
@@ -163,13 +163,9 @@ class DocumentProperties(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of address_lines
         if self.address_lines:
             _dict['address_lines'] = self.address_lines.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of each item in barcode (list)
-        _items = []
+        # override the default output from pydantic by calling `to_dict()` of barcode
         if self.barcode:
-            for _item_barcode in self.barcode:
-                if _item_barcode:
-                    _items.append(_item_barcode.to_dict())
-            _dict['barcode'] = _items
+            _dict['barcode'] = self.barcode.to_dict()
         # override the default output from pydantic by calling `to_dict()` of nfc
         if self.nfc:
             _dict['nfc'] = self.nfc.to_dict()
@@ -239,7 +235,7 @@ class DocumentProperties(BaseModel):
             "real_id_compliance": obj.get("real_id_compliance"),
             "security_tier": obj.get("security_tier"),
             "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,
+            "barcode": DocumentPropertiesBarcode.from_dict(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,
             "document_classification": DocumentPropertiesDocumentClassification.from_dict(obj["document_classification"]) if obj.get("document_classification") is not None else None,

onfido_python-4.0.0/onfido/models/document_properties_barcode_inner.py → onfido_python-4.2.0/onfido/models/document_properties_barcode.py

@@ -23,9 +23,9 @@ from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class DocumentPropertiesBarcodeInner(BaseModel):
+class DocumentPropertiesBarcode(BaseModel):
     """
-    DocumentPropertiesBarcodeInner
+    DocumentPropertiesBarcode
     """ # noqa: E501
     first_name: Optional[StrictStr] = None
     middle_name: Optional[StrictStr] = None
@@ -66,7 +66,7 @@ class DocumentPropertiesBarcodeInner(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of DocumentPropertiesBarcodeInner from a JSON string"""
+        """Create an instance of DocumentPropertiesBarcode from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -98,7 +98,7 @@ class DocumentPropertiesBarcodeInner(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DocumentPropertiesBarcodeInner from a dict"""
+        """Create an instance of DocumentPropertiesBarcode from a dict"""
         if obj is None:
             return None
 

onfido_python-4.2.0/onfido/models/document_types.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class DocumentTypes(str, Enum):
+    """
+    DocumentTypes
+    """
+
+    """
+    allowed enum values
+    """
+    PASSPORT = 'passport'
+    DRIVING_LICENCE = 'driving_licence'
+    NATIONAL_IDENTITY_CARD = 'national_identity_card'
+    RESIDENCE_PERMIT = 'residence_permit'
+    PASSPORT_CARD = 'passport_card'
+    TAX_ID = 'tax_id'
+    VISA = 'visa'
+    VOTER_ID = 'voter_id'
+    RESIDENCE_STATUS_DOCUMENT = 'residence_status_document'
+    POSTAL_IDENTITY_CARD = 'postal_identity_card'
+    SOCIAL_SECURITY_CARD = 'social_security_card'
+    WORK_PERMIT = 'work_permit'
+    ASYLUM_REGISTRATION_CARD = 'asylum_registration_card'
+    NATIONAL_HEALTH_INSURANCE_CARD = 'national_health_insurance_card'
+    MUNICIPALITY_IDENTITY_CARD = 'municipality_identity_card'
+    PRIVATE_OPERATORS_CARD = 'private_operators_card'
+    PROOF_OF_CITIZENSHIP = 'proof_of_citizenship'
+    SERVICE_ID_CARD = 'service_id_card'
+    IMMIGRATION_STATUS_DOCUMENT = 'immigration_status_document'
+    INDIGENOUS_CARD = 'indigenous_card'
+    VEHICLE_REGISTRATION_CARD = 'vehicle_registration_card'
+    CERTIFICATE_OF_NATURALISATION = 'certificate_of_naturalisation'
+    PROFESSIONAL_QUALIFICATION_CARD = 'professional_qualification_card'
+    CONSULAR_ID = 'consular_id'
+    INTERNATIONAL_DRIVING_LICENCE = 'international_driving_licence'
+    HOME_OFFICE_LETTER = 'home_office_letter'
+    BIRTH_CERTIFICATE = 'birth_certificate'
+    VEHICLE_REGISTRATION_CERTIFICATE = 'vehicle_registration_certificate'
+    FORM_FOR_AFFIXING_THE_VISA = 'form_for_affixing_the_visa'
+    IDENTIFICATION_NUMBER_DOCUMENT = 'identification_number_document'
+    ADOPTION_CERTIFICATE = 'adoption_certificate'
+    BANK_BUILDING_SOCIETY_STATEMENT = 'bank_building_society_statement'
+    BANK_STATEMENT = 'bank_statement'
+    BENEFIT_LETTERS = 'benefit_letters'
+    CBT = 'cbt'
+    CERTIFICATE_OF_SPONSORSHIP = 'certificate_of_sponsorship'
+    CHARACTER_REFERENCE = 'character_reference'
+    CIVIL_PARTNERSHIP_CERTIFICATE = 'civil_partnership_certificate'
+    COUNCIL_TAX = 'council_tax'
+    CREDIT_CARD_STATEMENT = 'credit_card_statement'
+    DEED_POLL = 'deed_poll'
+    DIVORCE_ABSOLUTE_DECREE = 'divorce_absolute_decree'
+    EDUCATIONAL_STATEMENT = 'educational_statement'
+    ELECTRICITY_BILL = 'electricity_bill'
+    GAS_BILL = 'gas_bill'
+    GOVERNMENT_LETTER = 'government_letter'
+    INTERNET_BILL = 'internet_bill'
+    MARRIAGE_CERTIFICATE = 'marriage_certificate'
+    MOTORCYCLE_INSURANCE = 'motorcycle_insurance'
+    NATIONAL_INSURANCE_CARD = 'national_insurance_card'
+    NATURALISATION_CERTIFICATE = 'naturalisation_certificate'
+    NON_UK_DRIVING_LICENCE = 'non_uk_driving_licence'
+    P45_P60 = 'p45_p60'
+    PAYSLIP = 'payslip'
+    PHONE_BILL = 'phone_bill'
+    PROFESSIONAL_IDENTIFICATION_CARD = 'professional_identification_card'
+    RIGHT_TO_WORK_SHARE_CODE_RESULT = 'right_to_work_share_code_result'
+    STATEMENT_FACT = 'statement_fact'
+    T4_STUDENT_UNIVERSITY_TERM_DATES_EVIDENCE = 't4_student_university_term_dates_evidence'
+    UK_BIOMETRIC_RESIDENCE_PERMIT = 'uk_biometric_residence_permit'
+    UK_DRIVING_LICENCE = 'uk_driving_licence'
+    UNKNOWN = 'unknown'
+    UTILITY_BILL = 'utility_bill'
+    UTILITY_BILL_ELECTRIC = 'utility_bill_electric'
+    UTILITY_BILL_GAS = 'utility_bill_gas'
+    UTILITY_BILL_OTHER = 'utility_bill_other'
+    WATER_BILL = 'water_bill'
+    ADDRESS_CERTIFICATE = 'address_certificate'
+    GENERAL_LETTER = 'general_letter'
+    INSURANCE_STATEMENT = 'insurance_statement'
+    PENSION_PROPERTY_STATEMENT_LETTER = 'pension_property_statement_letter'
+    MORTGAGE_STATEMENT = 'mortgage_statement'
+    MOBILE_PHONE_BILL = 'mobile_phone_bill'
+    IDENTITY_DOCUMENT_WITH_ADDRESS = 'identity_document_with_address'
+    EXCHANGE_HOUSE_STATEMENT = 'exchange_house_statement'
+    ACCOMMODATION_TENANCY_CERTIFICATE = 'accommodation_tenancy_certificate'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DocumentTypes from a JSON string"""
+        return cls(json.loads(json_str))
+
+

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/models/document_with_driver_verification_report_all_of_properties.py

@@ -21,7 +21,7 @@ from datetime import date
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
-from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
+from onfido.models.document_properties_barcode import DocumentPropertiesBarcode
 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
@@ -76,7 +76,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     real_id_compliance: Optional[StrictBool] = None
     security_tier: Optional[StrictStr] = None
     address_lines: Optional[DocumentPropertiesAddressLines] = None
-    barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
+    barcode: Optional[DocumentPropertiesBarcode] = None
     nfc: Optional[DocumentPropertiesNfc] = None
     driving_licence_information: Optional[DocumentPropertiesDrivingLicenceInformation] = None
     document_classification: Optional[DocumentPropertiesDocumentClassification] = None
@@ -171,13 +171,9 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of address_lines
         if self.address_lines:
             _dict['address_lines'] = self.address_lines.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of each item in barcode (list)
-        _items = []
+        # override the default output from pydantic by calling `to_dict()` of barcode
         if self.barcode:
-            for _item_barcode in self.barcode:
-                if _item_barcode:
-                    _items.append(_item_barcode.to_dict())
-            _dict['barcode'] = _items
+            _dict['barcode'] = self.barcode.to_dict()
         # override the default output from pydantic by calling `to_dict()` of nfc
         if self.nfc:
             _dict['nfc'] = self.nfc.to_dict()
@@ -257,7 +253,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
             "real_id_compliance": obj.get("real_id_compliance"),
             "security_tier": obj.get("security_tier"),
             "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,
+            "barcode": DocumentPropertiesBarcode.from_dict(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,
             "document_classification": DocumentPropertiesDocumentClassification.from_dict(obj["document_classification"]) if obj.get("document_classification") is not None else None,

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/models/facial_similarity_motion_report.py

@@ -22,6 +22,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.facial_similarity_motion_breakdown import FacialSimilarityMotionBreakdown
 from onfido.models.facial_similarity_motion_properties import FacialSimilarityMotionProperties
+from onfido.models.facial_similarity_report_media import FacialSimilarityReportMedia
 from onfido.models.report_document import ReportDocument
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
@@ -43,10 +44,14 @@ class FacialSimilarityMotionReport(BaseModel):
     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
+    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.")
     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", "breakdown", "properties"]
+    __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"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -96,6 +101,34 @@ class FacialSimilarityMotionReport(BaseModel):
                 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:
+            for _item_live_photos in self.live_photos:
+                if _item_live_photos:
+                    _items.append(_item_live_photos.to_dict())
+            _dict['live_photos'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in live_videos (list)
+        _items = []
+        if self.live_videos:
+            for _item_live_videos in self.live_videos:
+                if _item_live_videos:
+                    _items.append(_item_live_videos.to_dict())
+            _dict['live_videos'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in motion_captures (list)
+        _items = []
+        if self.motion_captures:
+            for _item_motion_captures in self.motion_captures:
+                if _item_motion_captures:
+                    _items.append(_item_motion_captures.to_dict())
+            _dict['motion_captures'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in id_photos (list)
+        _items = []
+        if self.id_photos:
+            for _item_id_photos in self.id_photos:
+                if _item_id_photos:
+                    _items.append(_item_id_photos.to_dict())
+            _dict['id_photos'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -128,6 +161,10 @@ class FacialSimilarityMotionReport(BaseModel):
             "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"),
+            "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,
+            "id_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["id_photos"]] if obj.get("id_photos") is not None else None,
             "breakdown": FacialSimilarityMotionBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": FacialSimilarityMotionProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/models/facial_similarity_photo_fully_auto_report.py

@@ -22,6 +22,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.facial_similarity_photo_fully_auto_breakdown import FacialSimilarityPhotoFullyAutoBreakdown
 from onfido.models.facial_similarity_photo_fully_auto_properties import FacialSimilarityPhotoFullyAutoProperties
+from onfido.models.facial_similarity_report_media import FacialSimilarityReportMedia
 from onfido.models.report_document import ReportDocument
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
@@ -43,10 +44,14 @@ class FacialSimilarityPhotoFullyAutoReport(BaseModel):
     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
+    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.")
     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", "breakdown", "properties"]
+    __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"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -96,6 +101,34 @@ class FacialSimilarityPhotoFullyAutoReport(BaseModel):
                 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:
+            for _item_live_photos in self.live_photos:
+                if _item_live_photos:
+                    _items.append(_item_live_photos.to_dict())
+            _dict['live_photos'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in live_videos (list)
+        _items = []
+        if self.live_videos:
+            for _item_live_videos in self.live_videos:
+                if _item_live_videos:
+                    _items.append(_item_live_videos.to_dict())
+            _dict['live_videos'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in motion_captures (list)
+        _items = []
+        if self.motion_captures:
+            for _item_motion_captures in self.motion_captures:
+                if _item_motion_captures:
+                    _items.append(_item_motion_captures.to_dict())
+            _dict['motion_captures'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in id_photos (list)
+        _items = []
+        if self.id_photos:
+            for _item_id_photos in self.id_photos:
+                if _item_id_photos:
+                    _items.append(_item_id_photos.to_dict())
+            _dict['id_photos'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -128,6 +161,10 @@ class FacialSimilarityPhotoFullyAutoReport(BaseModel):
             "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"),
+            "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,
+            "id_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["id_photos"]] if obj.get("id_photos") is not None else None,
             "breakdown": FacialSimilarityPhotoFullyAutoBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": FacialSimilarityPhotoFullyAutoProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

{onfido_python-4.0.0 → onfido_python-4.2.0}/onfido/models/facial_similarity_photo_report.py

@@ -22,6 +22,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.facial_similarity_photo_breakdown import FacialSimilarityPhotoBreakdown
 from onfido.models.facial_similarity_photo_properties import FacialSimilarityPhotoProperties
+from onfido.models.facial_similarity_report_media import FacialSimilarityReportMedia
 from onfido.models.report_document import ReportDocument
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
@@ -43,10 +44,14 @@ class FacialSimilarityPhotoReport(BaseModel):
     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
+    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.")
     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", "breakdown", "properties"]
+    __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"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -96,6 +101,34 @@ class FacialSimilarityPhotoReport(BaseModel):
                 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:
+            for _item_live_photos in self.live_photos:
+                if _item_live_photos:
+                    _items.append(_item_live_photos.to_dict())
+            _dict['live_photos'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in live_videos (list)
+        _items = []
+        if self.live_videos:
+            for _item_live_videos in self.live_videos:
+                if _item_live_videos:
+                    _items.append(_item_live_videos.to_dict())
+            _dict['live_videos'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in motion_captures (list)
+        _items = []
+        if self.motion_captures:
+            for _item_motion_captures in self.motion_captures:
+                if _item_motion_captures:
+                    _items.append(_item_motion_captures.to_dict())
+            _dict['motion_captures'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in id_photos (list)
+        _items = []
+        if self.id_photos:
+            for _item_id_photos in self.id_photos:
+                if _item_id_photos:
+                    _items.append(_item_id_photos.to_dict())
+            _dict['id_photos'] = _items
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -128,6 +161,10 @@ class FacialSimilarityPhotoReport(BaseModel):
             "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"),
+            "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,
+            "id_photos": [FacialSimilarityReportMedia.from_dict(_item) for _item in obj["id_photos"]] if obj.get("id_photos") is not None else None,
             "breakdown": FacialSimilarityPhotoBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": FacialSimilarityPhotoProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

onfido_python-4.2.0/onfido/models/facial_similarity_report_media.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FacialSimilarityReportMedia(BaseModel):
+    """
+    FacialSimilarityReportMedia
+    """ # noqa: E501
+    id: StrictStr = Field(description="ID of uploaded biometric media to use.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FacialSimilarityReportMedia from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FacialSimilarityReportMedia from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+