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

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

onfido/models/repeat_attempts_list_repeat_attempts_inner.py

@@ -43,8 +43,8 @@ class RepeatAttemptsListRepeatAttemptsInner(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['match', 'mismatch']):
-            raise ValueError("must be one of enum values ('match', 'mismatch')")
+        if value not in set(['match', 'mismatch', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('match', 'mismatch', 'unknown_default_open_api')")
         return value
 
     @field_validator('names')
@@ -53,8 +53,8 @@ class RepeatAttemptsListRepeatAttemptsInner(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['match', 'mismatch']):
-            raise ValueError("must be one of enum values ('match', 'mismatch')")
+        if value not in set(['match', 'mismatch', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('match', 'mismatch', 'unknown_default_open_api')")
         return value
 
     @field_validator('result')
@@ -63,8 +63,8 @@ class RepeatAttemptsListRepeatAttemptsInner(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['clear', 'consider']):
-            raise ValueError("must be one of enum values ('clear', 'consider')")
+        if value not in set(['clear', 'consider', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('clear', 'consider', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/report_name.py

@@ -47,6 +47,7 @@ class ReportName(str, Enum):
     US_DRIVING_LICENCE = 'us_driving_licence'
     DEVICE_INTELLIGENCE = 'device_intelligence'
     INDIA_PAN = 'india_pan'
+    UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

onfido/models/report_result.py

@@ -29,6 +29,7 @@ class ReportResult(str, Enum):
     CLEAR = 'clear'
     CONSIDER = 'consider'
     UNIDENTIFIED = 'unidentified'
+    UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

onfido/models/report_shared.py

@@ -20,7 +20,6 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-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
@@ -39,10 +38,9 @@ class ReportShared(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
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "documents", "name"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -85,13 +83,6 @@ class ReportShared(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
         # 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():
@@ -116,7 +107,6 @@ class ReportShared(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")
         })
         # store additional fields in additional_properties

onfido/models/report_status.py

@@ -31,6 +31,7 @@ class ReportStatus(str, Enum):
     CANCELLED = 'cancelled'
     COMPLETE = 'complete'
     WITHDRAWN = 'withdrawn'
+    UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

onfido/models/report_sub_result.py

@@ -30,6 +30,7 @@ class ReportSubResult(str, Enum):
     REJECTED = 'rejected'
     SUSPECTED = 'suspected'
     CAUTION = 'caution'
+    UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

onfido/models/results_feedback.py

@@ -39,8 +39,8 @@ class ResultsFeedback(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['clear', 'consider']):
-            raise ValueError("must be one of enum values ('clear', 'consider')")
+        if value not in set(['clear', 'consider', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('clear', 'consider', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/us_driving_licence_builder.py

@@ -62,8 +62,8 @@ class UsDrivingLicenceBuilder(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['driver license', 'driver permit', 'id card']):
-            raise ValueError("must be one of enum values ('driver license', 'driver permit', 'id card')")
+        if value not in set(['driver license', 'driver permit', 'id card', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('driver license', 'driver permit', 'id card', 'unknown_default_open_api')")
         return value
 
     @field_validator('eye_color_code')
@@ -72,8 +72,8 @@ class UsDrivingLicenceBuilder(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK']):
-            raise ValueError("must be one of enum values ('BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK')")
+        if value not in set(['BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK', 'unknown_default_open_api')")
         return value
 
     @field_validator('gender')
@@ -82,8 +82,8 @@ class UsDrivingLicenceBuilder(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('state')

onfido/models/us_driving_licence_report.py

@@ -21,7 +21,6 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.document_properties import DocumentProperties
-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 UsDrivingLicenceReport(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[UsDrivingLicenceBreakdown] = 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", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,13 +87,6 @@ class UsDrivingLicenceReport(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 UsDrivingLicenceReport(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": UsDrivingLicenceBreakdown.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/us_driving_licence_shared.py

@@ -62,8 +62,8 @@ class UsDrivingLicenceShared(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['driver license', 'driver permit', 'id card']):
-            raise ValueError("must be one of enum values ('driver license', 'driver permit', 'id card')")
+        if value not in set(['driver license', 'driver permit', 'id card', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('driver license', 'driver permit', 'id card', 'unknown_default_open_api')")
         return value
 
     @field_validator('eye_color_code')
@@ -72,8 +72,8 @@ class UsDrivingLicenceShared(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK']):
-            raise ValueError("must be one of enum values ('BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK')")
+        if value not in set(['BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK', 'unknown_default_open_api')")
         return value
 
     @field_validator('gender')
@@ -82,8 +82,8 @@ class UsDrivingLicenceShared(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('state')

onfido/models/watchlist_aml_properties.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
@@ -26,7 +26,7 @@ class WatchlistAmlProperties(BaseModel):
     """
     WatchlistAmlProperties
     """ # noqa: E501
-    records: Optional[List[StrictStr]] = Field(default=None, description="Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.")
+    records: Optional[List[Dict[str, Any]]] = Field(default=None, description="Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.")
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["records"]
 

onfido/models/watchlist_aml_report.py

@@ -20,7 +20,6 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-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 WatchlistAmlReport(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[WatchlistAmlBreakdown] = None
     properties: Optional[WatchlistAmlProperties] = 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 WatchlistAmlReport(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 WatchlistAmlReport(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": WatchlistAmlBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": WatchlistAmlProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None

onfido/models/watchlist_enhanced_report.py

@@ -20,7 +20,6 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-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 WatchlistEnhancedReport(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[WatchlistEnhancedBreakdown] = None
     properties: Optional[WatchlistEnhancedProperties] = 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 WatchlistEnhancedReport(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 WatchlistEnhancedReport(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": WatchlistEnhancedBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": WatchlistEnhancedProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None

onfido/models/watchlist_monitor.py

@@ -40,8 +40,8 @@ class WatchlistMonitor(BaseModel):
     @field_validator('report_name')
     def report_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['watchlist_standard', 'watchlist_aml']):
-            raise ValueError("must be one of enum values ('watchlist_standard', 'watchlist_aml')")
+        if value not in set(['watchlist_standard', 'watchlist_aml', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('watchlist_standard', 'watchlist_aml', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/watchlist_monitor_builder.py

@@ -35,8 +35,8 @@ class WatchlistMonitorBuilder(BaseModel):
     @field_validator('report_name')
     def report_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['watchlist_standard', 'watchlist_aml']):
-            raise ValueError("must be one of enum values ('watchlist_standard', 'watchlist_aml')")
+        if value not in set(['watchlist_standard', 'watchlist_aml', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('watchlist_standard', 'watchlist_aml', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/watchlist_monitor_shared.py

@@ -35,8 +35,8 @@ class WatchlistMonitorShared(BaseModel):
     @field_validator('report_name')
     def report_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['watchlist_standard', 'watchlist_aml']):
-            raise ValueError("must be one of enum values ('watchlist_standard', 'watchlist_aml')")
+        if value not in set(['watchlist_standard', 'watchlist_aml', 'unknown_default_open_api']):
+            raise ValueError("must be one of enum values ('watchlist_standard', 'watchlist_aml', 'unknown_default_open_api')")
         return value
 
     model_config = ConfigDict(

onfido/models/watchlist_peps_only_report.py

@@ -20,7 +20,6 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-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 WatchlistPepsOnlyReport(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[WatchlistStandardBreakdown] = None
     properties: Optional[WatchlistStandardProperties] = 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 WatchlistPepsOnlyReport(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 WatchlistPepsOnlyReport(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": WatchlistStandardBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": WatchlistStandardProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None

onfido/models/watchlist_sanctions_only_report.py

@@ -20,7 +20,6 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-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 WatchlistSanctionsOnlyReport(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[WatchlistStandardBreakdown] = None
     properties: Optional[WatchlistStandardProperties] = 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 WatchlistSanctionsOnlyReport(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 WatchlistSanctionsOnlyReport(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": WatchlistStandardBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": WatchlistStandardProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None

onfido/models/watchlist_standard_properties.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
@@ -26,7 +26,7 @@ class WatchlistStandardProperties(BaseModel):
     """
     WatchlistStandardProperties
     """ # noqa: E501
-    records: Optional[List[StrictStr]] = Field(default=None, description="Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.")
+    records: Optional[List[Dict[str, Any]]] = Field(default=None, description="Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.")
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["records"]
 

onfido/models/watchlist_standard_report.py

@@ -20,7 +20,6 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-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 WatchlistStandardReport(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[WatchlistStandardBreakdown] = None
     properties: Optional[WatchlistStandardProperties] = 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 WatchlistStandardReport(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 WatchlistStandardReport(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": WatchlistStandardBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": WatchlistStandardProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None