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

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

onfido/models/webhook.py

@@ -31,12 +31,17 @@ class Webhook(BaseModel):
     events: Optional[List[WebhookEventType]] = Field(default=None, description="The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed. ")
     environments: Optional[List[StrictStr]] = Field(default=None, description="The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments. ")
     payload_version: Optional[StrictInt] = Field(default=None, description="Webhook version used to control the payload object when sending webhooks.")
+    oauth_enabled: Optional[StrictBool] = Field(default=None, description="Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.")
+    oauth_server_url: Optional[StrictStr] = Field(default=None, description="The url to fetch the OAuth access token using client credentials grant.")
+    oauth_server_client_id: Optional[StrictStr] = Field(default=None, description="The client id to authenticate the client credentials grant.")
+    oauth_server_client_secret: Optional[StrictStr] = Field(default=None, description="The client secret to authenticate the client credentials grant.")
+    oauth_server_scope: Optional[StrictStr] = Field(default=None, description="The scopes to be sent when requesting the access token.")
     id: StrictStr = Field(description="The unique identifier of the webhook.")
     url: Optional[StrictStr] = Field(default=None, description="The url that will listen to notifications (must be https).")
     token: Optional[StrictStr] = Field(default=None, description="Webhook secret token used to sign the webhook's payload.")
     href: Optional[StrictStr] = Field(default=None, description="The API endpoint to retrieve the webhook.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["enabled", "events", "environments", "payload_version", "id", "url", "token", "href"]
+    __properties: ClassVar[List[str]] = ["enabled", "events", "environments", "payload_version", "oauth_enabled", "oauth_server_url", "oauth_server_client_id", "oauth_server_client_secret", "oauth_server_scope", "id", "url", "token", "href"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -100,6 +105,11 @@ class Webhook(BaseModel):
             "events": obj.get("events"),
             "environments": obj.get("environments"),
             "payload_version": obj.get("payload_version"),
+            "oauth_enabled": obj.get("oauth_enabled"),
+            "oauth_server_url": obj.get("oauth_server_url"),
+            "oauth_server_client_id": obj.get("oauth_server_client_id"),
+            "oauth_server_client_secret": obj.get("oauth_server_client_secret"),
+            "oauth_server_scope": obj.get("oauth_server_scope"),
             "id": obj.get("id"),
             "url": obj.get("url"),
             "token": obj.get("token"),

onfido/models/webhook_builder.py

@@ -31,9 +31,14 @@ class WebhookBuilder(BaseModel):
     events: Optional[List[WebhookEventType]] = Field(default=None, description="The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed. ")
     environments: Optional[List[StrictStr]] = Field(default=None, description="The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments. ")
     payload_version: Optional[StrictInt] = Field(default=None, description="Webhook version used to control the payload object when sending webhooks.")
+    oauth_enabled: Optional[StrictBool] = Field(default=None, description="Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.")
+    oauth_server_url: Optional[StrictStr] = Field(default=None, description="The url to fetch the OAuth access token using client credentials grant.")
+    oauth_server_client_id: Optional[StrictStr] = Field(default=None, description="The client id to authenticate the client credentials grant.")
+    oauth_server_client_secret: Optional[StrictStr] = Field(default=None, description="The client secret to authenticate the client credentials grant.")
+    oauth_server_scope: Optional[StrictStr] = Field(default=None, description="The scopes to be sent when requesting the access token.")
     url: StrictStr = Field(description="The url that will listen to notifications (must be https).")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["enabled", "events", "environments", "payload_version", "url"]
+    __properties: ClassVar[List[str]] = ["enabled", "events", "environments", "payload_version", "oauth_enabled", "oauth_server_url", "oauth_server_client_id", "oauth_server_client_secret", "oauth_server_scope", "url"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -97,6 +102,11 @@ class WebhookBuilder(BaseModel):
             "events": obj.get("events"),
             "environments": obj.get("environments"),
             "payload_version": obj.get("payload_version"),
+            "oauth_enabled": obj.get("oauth_enabled"),
+            "oauth_server_url": obj.get("oauth_server_url"),
+            "oauth_server_client_id": obj.get("oauth_server_client_id"),
+            "oauth_server_client_secret": obj.get("oauth_server_client_secret"),
+            "oauth_server_scope": obj.get("oauth_server_scope"),
             "url": obj.get("url")
         })
         # store additional fields in additional_properties

onfido/models/webhook_event_object_status.py

@@ -45,6 +45,7 @@ class WebhookEventObjectStatus(str, Enum):
     AWAITING_APPLICANT = 'awaiting_applicant'
     PAUSED = 'paused'
     REOPENED = 'reopened'
+    UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

onfido/models/webhook_event_payload_object.py

@@ -32,7 +32,7 @@ class WebhookEventPayloadObject(BaseModel):
     status: Optional[WebhookEventObjectStatus] = None
     started_at_iso8601: Optional[datetime] = Field(default=None, description="The date and time when the operation was started, if available.")
     completed_at_iso8601: Optional[datetime] = Field(default=None, description="The date and time when the operation was completed, if available.")
-    href: StrictStr = Field(description="The uri of the resource.")
+    href: Optional[StrictStr] = Field(default=None, description="The uri of the resource.")
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["id", "status", "started_at_iso8601", "completed_at_iso8601", "href"]
 

onfido/models/webhook_event_resource_type.py

@@ -34,6 +34,7 @@ class WebhookEventResourceType(str, Enum):
     WATCHLIST_MONITOR = 'watchlist_monitor'
     WORKFLOW_TIMELINE_FILE = 'workflow_timeline_file'
     WORKFLOW_RUN_EVIDENCE_FOLDER = 'workflow_run_evidence_folder'
+    UNKNOWN_DEFAULT_OPEN_API = 'unknown_default_open_api'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self: