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

onfido/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "5.0.0"
+__version__ = "5.1.0"
 
 # import apis into sdk package
 from onfido.api.default_api import DefaultApi
@@ -37,6 +37,7 @@ from onfido.models.address_shared import AddressShared
 from onfido.models.addresses_list import AddressesList
 from onfido.models.applicant import Applicant
 from onfido.models.applicant_builder import ApplicantBuilder
+from onfido.models.applicant_consent import ApplicantConsent
 from onfido.models.applicant_consent_builder import ApplicantConsentBuilder
 from onfido.models.applicant_consent_name import ApplicantConsentName
 from onfido.models.applicant_create import ApplicantCreate
@@ -58,12 +59,13 @@ from onfido.models.complete_task_data_builder import CompleteTaskDataBuilder
 from onfido.models.country_codes import CountryCodes
 from onfido.models.device_intelligence_breakdown import DeviceIntelligenceBreakdown
 from onfido.models.device_intelligence_breakdown_breakdown import DeviceIntelligenceBreakdownBreakdown
-from onfido.models.device_intelligence_breakdown_breakdown_device import DeviceIntelligenceBreakdownBreakdownDevice
-from onfido.models.device_intelligence_breakdown_breakdown_device_breakdown import DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
+from onfido.models.device_intelligence_breakdown_device import DeviceIntelligenceBreakdownDevice
+from onfido.models.device_intelligence_breakdown_device_breakdown import DeviceIntelligenceBreakdownDeviceBreakdown
 from onfido.models.device_intelligence_breakdown_properties import DeviceIntelligenceBreakdownProperties
 from onfido.models.device_intelligence_breakdown_properties_device import DeviceIntelligenceBreakdownPropertiesDevice
 from onfido.models.device_intelligence_breakdown_properties_geolocation import DeviceIntelligenceBreakdownPropertiesGeolocation
 from onfido.models.device_intelligence_breakdown_properties_ip import DeviceIntelligenceBreakdownPropertiesIp
+from onfido.models.device_intelligence_properties import DeviceIntelligenceProperties
 from onfido.models.device_intelligence_report import DeviceIntelligenceReport
 from onfido.models.document import Document
 from onfido.models.document_breakdown import DocumentBreakdown
@@ -109,7 +111,7 @@ from onfido.models.document_properties_address_lines import DocumentPropertiesAd
 from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
 from onfido.models.document_properties_document_classification import DocumentPropertiesDocumentClassification
 from onfido.models.document_properties_document_numbers_inner import DocumentPropertiesDocumentNumbersInner
-from onfido.models.document_properties_driving_licence_information import DocumentPropertiesDrivingLicenceInformation
+from onfido.models.document_properties_driving_licence_information_item import DocumentPropertiesDrivingLicenceInformationItem
 from onfido.models.document_properties_extracted_data import DocumentPropertiesExtractedData
 from onfido.models.document_properties_nfc import DocumentPropertiesNfc
 from onfido.models.document_report import DocumentReport

onfido/api/default_api.py

@@ -23,6 +23,7 @@ from typing_extensions import Annotated
 from onfido.models.addresses_list import AddressesList
 from onfido.models.applicant import Applicant
 from onfido.models.applicant_builder import ApplicantBuilder
+from onfido.models.applicant_consent import ApplicantConsent
 from onfido.models.applicant_updater import ApplicantUpdater
 from onfido.models.applicants_list import ApplicantsList
 from onfido.models.check import Check
@@ -7293,6 +7294,267 @@ class DefaultApi:
 
 
 
+    @validate_call
+    def find_applicant_consents(
+        self,
+        applicant_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> List[ApplicantConsent]:
+        """Retrieve Applicant Consents
+
+        Retrieves consents for single applicant. 
+
+        :param applicant_id: (required)
+        :type applicant_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._find_applicant_consents_serialize(
+            applicant_id=applicant_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ApplicantConsent]",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def find_applicant_consents_with_http_info(
+        self,
+        applicant_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[List[ApplicantConsent]]:
+        """Retrieve Applicant Consents
+
+        Retrieves consents for single applicant. 
+
+        :param applicant_id: (required)
+        :type applicant_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._find_applicant_consents_serialize(
+            applicant_id=applicant_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ApplicantConsent]",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def find_applicant_consents_without_preload_content(
+        self,
+        applicant_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Retrieve Applicant Consents
+
+        Retrieves consents for single applicant. 
+
+        :param applicant_id: (required)
+        :type applicant_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._find_applicant_consents_serialize(
+            applicant_id=applicant_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ApplicantConsent]",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _find_applicant_consents_serialize(
+        self,
+        applicant_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if applicant_id is not None:
+            _path_params['applicant_id'] = applicant_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Token'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/applicants/{applicant_id}/consents',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def find_check(
         self,

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/5.0.0'
+        self.user_agent = 'onfido-python/5.1.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

onfido/configuration.py

@@ -501,7 +501,7 @@ conf = onfido.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v3.6\n"\
-               "SDK Package Version: 5.0.0".\
+               "SDK Package Version: 5.1.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

onfido/models/__init__.py

@@ -20,6 +20,7 @@ from onfido.models.address_shared import AddressShared
 from onfido.models.addresses_list import AddressesList
 from onfido.models.applicant import Applicant
 from onfido.models.applicant_builder import ApplicantBuilder
+from onfido.models.applicant_consent import ApplicantConsent
 from onfido.models.applicant_consent_builder import ApplicantConsentBuilder
 from onfido.models.applicant_consent_name import ApplicantConsentName
 from onfido.models.applicant_create import ApplicantCreate
@@ -41,12 +42,13 @@ from onfido.models.complete_task_data_builder import CompleteTaskDataBuilder
 from onfido.models.country_codes import CountryCodes
 from onfido.models.device_intelligence_breakdown import DeviceIntelligenceBreakdown
 from onfido.models.device_intelligence_breakdown_breakdown import DeviceIntelligenceBreakdownBreakdown
-from onfido.models.device_intelligence_breakdown_breakdown_device import DeviceIntelligenceBreakdownBreakdownDevice
-from onfido.models.device_intelligence_breakdown_breakdown_device_breakdown import DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
+from onfido.models.device_intelligence_breakdown_device import DeviceIntelligenceBreakdownDevice
+from onfido.models.device_intelligence_breakdown_device_breakdown import DeviceIntelligenceBreakdownDeviceBreakdown
 from onfido.models.device_intelligence_breakdown_properties import DeviceIntelligenceBreakdownProperties
 from onfido.models.device_intelligence_breakdown_properties_device import DeviceIntelligenceBreakdownPropertiesDevice
 from onfido.models.device_intelligence_breakdown_properties_geolocation import DeviceIntelligenceBreakdownPropertiesGeolocation
 from onfido.models.device_intelligence_breakdown_properties_ip import DeviceIntelligenceBreakdownPropertiesIp
+from onfido.models.device_intelligence_properties import DeviceIntelligenceProperties
 from onfido.models.device_intelligence_report import DeviceIntelligenceReport
 from onfido.models.document import Document
 from onfido.models.document_breakdown import DocumentBreakdown
@@ -92,7 +94,7 @@ from onfido.models.document_properties_address_lines import DocumentPropertiesAd
 from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
 from onfido.models.document_properties_document_classification import DocumentPropertiesDocumentClassification
 from onfido.models.document_properties_document_numbers_inner import DocumentPropertiesDocumentNumbersInner
-from onfido.models.document_properties_driving_licence_information import DocumentPropertiesDrivingLicenceInformation
+from onfido.models.document_properties_driving_licence_information_item import DocumentPropertiesDrivingLicenceInformationItem
 from onfido.models.document_properties_extracted_data import DocumentPropertiesExtractedData
 from onfido.models.document_properties_nfc import DocumentPropertiesNfc
 from onfido.models.document_report import DocumentReport

onfido/models/applicant_consent.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 pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from onfido.models.applicant_consent_name import ApplicantConsentName
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ApplicantConsent(BaseModel):
+    """
+    ApplicantConsent
+    """ # noqa: E501
+    name: ApplicantConsentName
+    granted: StrictBool
+    granted_at: Optional[datetime] = Field(description="The date and time when this applicant consent was granted, if not granted the value is nil.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["name", "granted", "granted_at"]
+
+    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 ApplicantConsent 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
+
+        # set to None if granted_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.granted_at is None and "granted_at" in self.model_fields_set:
+            _dict['granted_at'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ApplicantConsent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "granted": obj.get("granted"),
+            "granted_at": obj.get("granted_at")
+        })
+        # 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
+
+

onfido/models/device_intelligence_breakdown.py

@@ -20,6 +20,7 @@ import json
 from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.device_intelligence_breakdown_breakdown import DeviceIntelligenceBreakdownBreakdown
+from onfido.models.device_intelligence_breakdown_device import DeviceIntelligenceBreakdownDevice
 from onfido.models.device_intelligence_breakdown_properties import DeviceIntelligenceBreakdownProperties
 from typing import Optional, Set
 from typing_extensions import Self
@@ -28,10 +29,11 @@ class DeviceIntelligenceBreakdown(BaseModel):
     """
     DeviceIntelligenceBreakdown
     """ # noqa: E501
+    device: Optional[DeviceIntelligenceBreakdownDevice] = None
     breakdown: Optional[DeviceIntelligenceBreakdownBreakdown] = None
     properties: Optional[DeviceIntelligenceBreakdownProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["breakdown", "properties"]
+    __properties: ClassVar[List[str]] = ["device", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -74,6 +76,9 @@ class DeviceIntelligenceBreakdown(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of device
+        if self.device:
+            _dict['device'] = self.device.to_dict()
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
@@ -97,6 +102,7 @@ class DeviceIntelligenceBreakdown(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "device": DeviceIntelligenceBreakdownDevice.from_dict(obj["device"]) if obj.get("device") is not None else None,
             "breakdown": DeviceIntelligenceBreakdownBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
             "properties": DeviceIntelligenceBreakdownProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })

onfido/models/device_intelligence_breakdown_breakdown.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
-from onfido.models.device_intelligence_breakdown_breakdown_device import DeviceIntelligenceBreakdownBreakdownDevice
+from onfido.models.device_intelligence_breakdown_device import DeviceIntelligenceBreakdownDevice
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,7 +27,7 @@ class DeviceIntelligenceBreakdownBreakdown(BaseModel):
     """
     DeviceIntelligenceBreakdownBreakdown
     """ # noqa: E501
-    device: Optional[DeviceIntelligenceBreakdownBreakdownDevice] = None
+    device: Optional[DeviceIntelligenceBreakdownDevice] = None
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["device"]
 
@@ -92,7 +92,7 @@ class DeviceIntelligenceBreakdownBreakdown(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "device": DeviceIntelligenceBreakdownBreakdownDevice.from_dict(obj["device"]) if obj.get("device") is not None else None
+            "device": DeviceIntelligenceBreakdownDevice.from_dict(obj["device"]) if obj.get("device") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

onfido/models/{device_intelligence_breakdown_breakdown_device.py → device_intelligence_breakdown_device.py}

@@ -19,15 +19,15 @@ import json
 
 from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
-from onfido.models.device_intelligence_breakdown_breakdown_device_breakdown import DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
+from onfido.models.device_intelligence_breakdown_device_breakdown import DeviceIntelligenceBreakdownDeviceBreakdown
 from typing import Optional, Set
 from typing_extensions import Self
 
-class DeviceIntelligenceBreakdownBreakdownDevice(BaseModel):
+class DeviceIntelligenceBreakdownDevice(BaseModel):
     """
     Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
     """ # noqa: E501
-    breakdown: Optional[DeviceIntelligenceBreakdownBreakdownDeviceBreakdown] = None
+    breakdown: Optional[DeviceIntelligenceBreakdownDeviceBreakdown] = None
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["breakdown"]
 
@@ -49,7 +49,7 @@ class DeviceIntelligenceBreakdownBreakdownDevice(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of DeviceIntelligenceBreakdownBreakdownDevice from a JSON string"""
+        """Create an instance of DeviceIntelligenceBreakdownDevice from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -84,7 +84,7 @@ class DeviceIntelligenceBreakdownBreakdownDevice(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DeviceIntelligenceBreakdownBreakdownDevice from a dict"""
+        """Create an instance of DeviceIntelligenceBreakdownDevice from a dict"""
         if obj is None:
             return None
 
@@ -92,7 +92,7 @@ class DeviceIntelligenceBreakdownBreakdownDevice(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "breakdown": DeviceIntelligenceBreakdownBreakdownDeviceBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None
+            "breakdown": DeviceIntelligenceBreakdownDeviceBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

onfido/models/{device_intelligence_breakdown_breakdown_device_breakdown.py → device_intelligence_breakdown_device_breakdown.py}

@@ -23,9 +23,9 @@ from onfido.models.document_breakdown_data_comparison_breakdown_issuing_country
 from typing import Optional, Set
 from typing_extensions import Self
 
-class DeviceIntelligenceBreakdownBreakdownDeviceBreakdown(BaseModel):
+class DeviceIntelligenceBreakdownDeviceBreakdown(BaseModel):
     """
-    DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
+    DeviceIntelligenceBreakdownDeviceBreakdown
     """ # noqa: E501
     application_authenticity: Optional[DocumentBreakdownDataComparisonBreakdownIssuingCountry] = None
     device_integrity: Optional[DocumentBreakdownDataComparisonBreakdownIssuingCountry] = None
@@ -51,7 +51,7 @@ class DeviceIntelligenceBreakdownBreakdownDeviceBreakdown(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of DeviceIntelligenceBreakdownBreakdownDeviceBreakdown from a JSON string"""
+        """Create an instance of DeviceIntelligenceBreakdownDeviceBreakdown from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -92,7 +92,7 @@ class DeviceIntelligenceBreakdownBreakdownDeviceBreakdown(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DeviceIntelligenceBreakdownBreakdownDeviceBreakdown from a dict"""
+        """Create an instance of DeviceIntelligenceBreakdownDeviceBreakdown from a dict"""
         if obj is None:
             return None
 

onfido/models/device_intelligence_breakdown_properties_device.py

@@ -17,8 +17,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -36,7 +36,7 @@ class DeviceIntelligenceBreakdownPropertiesDevice(BaseModel):
     randomized_device: Optional[StrictBool] = Field(default=None, description="Whether the device is providing false randomized device and network information.")
     fake_network_request: Optional[StrictBool] = Field(default=None, description="Whether device is using stolen security tokens to send the network information.")
     ip_reputation: Optional[StrictStr] = Field(default=None, description="Whether there is highly suspicious traffic related to the IP address. The risk depends on the overall ratio of clear checks on a given IP.")
-    device_fingerprint_reuse: Optional[StrictInt] = Field(default=None, description="The number of times the device was used to create a report for a new applicant. A value greater than 1 indicates potential device reuse.")
+    device_fingerprint_reuse: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The number of times the device was used to create a report for a new applicant. A value greater than 1 indicates potential device reuse.")
     single_device_used: Optional[StrictBool] = Field(default=None, description="Whether the document or biometric media were uploaded from a single device.")
     document_capture: Optional[StrictStr] = Field(default=None, description="Whether the document media were live captured from the device camera.")
     biometric_capture: Optional[StrictStr] = Field(default=None, description="Whether the biometric media were live captured from the device camera.")

onfido/models/device_intelligence_properties.py

@@ -0,0 +1,116 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from onfido.models.device_intelligence_breakdown_properties_device import DeviceIntelligenceBreakdownPropertiesDevice
+from onfido.models.device_intelligence_breakdown_properties_geolocation import DeviceIntelligenceBreakdownPropertiesGeolocation
+from onfido.models.device_intelligence_breakdown_properties_ip import DeviceIntelligenceBreakdownPropertiesIp
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DeviceIntelligenceProperties(BaseModel):
+    """
+    DeviceIntelligenceProperties
+    """ # noqa: E501
+    device: Optional[DeviceIntelligenceBreakdownPropertiesDevice] = None
+    ip: Optional[DeviceIntelligenceBreakdownPropertiesIp] = None
+    geolocation: Optional[DeviceIntelligenceBreakdownPropertiesGeolocation] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["device", "ip", "geolocation"]
+
+    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 DeviceIntelligenceProperties 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of device
+        if self.device:
+            _dict['device'] = self.device.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of ip
+        if self.ip:
+            _dict['ip'] = self.ip.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of geolocation
+        if self.geolocation:
+            _dict['geolocation'] = self.geolocation.to_dict()
+        # 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 DeviceIntelligenceProperties from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "device": DeviceIntelligenceBreakdownPropertiesDevice.from_dict(obj["device"]) if obj.get("device") is not None else None,
+            "ip": DeviceIntelligenceBreakdownPropertiesIp.from_dict(obj["ip"]) if obj.get("ip") is not None else None,
+            "geolocation": DeviceIntelligenceBreakdownPropertiesGeolocation.from_dict(obj["geolocation"]) if obj.get("geolocation") is not None else None
+        })
+        # 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
+
+

onfido/models/device_intelligence_report.py

@@ -21,6 +21,7 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.device_intelligence_breakdown import DeviceIntelligenceBreakdown
+from onfido.models.device_intelligence_properties import DeviceIntelligenceProperties
 from onfido.models.report_name import ReportName
 from onfido.models.report_result import ReportResult
 from onfido.models.report_status import ReportStatus
@@ -41,8 +42,9 @@ class DeviceIntelligenceReport(BaseModel):
     check_id: Optional[StrictStr] = Field(default=None, description="The ID of the check to which the report belongs. Read-only.")
     name: ReportName
     breakdown: Optional[DeviceIntelligenceBreakdown] = None
+    properties: Optional[DeviceIntelligenceProperties] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "breakdown"]
+    __properties: ClassVar[List[str]] = ["id", "created_at", "href", "status", "result", "sub_result", "check_id", "name", "breakdown", "properties"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,6 +90,9 @@ class DeviceIntelligenceReport(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of breakdown
         if self.breakdown:
             _dict['breakdown'] = self.breakdown.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
         # 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():
@@ -113,7 +118,8 @@ class DeviceIntelligenceReport(BaseModel):
             "sub_result": obj.get("sub_result"),
             "check_id": obj.get("check_id"),
             "name": obj.get("name"),
-            "breakdown": DeviceIntelligenceBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None
+            "breakdown": DeviceIntelligenceBreakdown.from_dict(obj["breakdown"]) if obj.get("breakdown") is not None else None,
+            "properties": DeviceIntelligenceProperties.from_dict(obj["properties"]) if obj.get("properties") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

onfido/models/document_properties.py

@@ -24,7 +24,7 @@ from onfido.models.document_properties_address_lines import DocumentPropertiesAd
 from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
 from onfido.models.document_properties_document_classification import DocumentPropertiesDocumentClassification
 from onfido.models.document_properties_document_numbers_inner import DocumentPropertiesDocumentNumbersInner
-from onfido.models.document_properties_driving_licence_information import DocumentPropertiesDrivingLicenceInformation
+from onfido.models.document_properties_driving_licence_information_item import DocumentPropertiesDrivingLicenceInformationItem
 from onfido.models.document_properties_extracted_data import DocumentPropertiesExtractedData
 from onfido.models.document_properties_nfc import DocumentPropertiesNfc
 from typing import Optional, Set
@@ -76,7 +76,7 @@ class DocumentProperties(BaseModel):
     address_lines: Optional[DocumentPropertiesAddressLines] = None
     barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
     nfc: Optional[DocumentPropertiesNfc] = None
-    driving_licence_information: Optional[DocumentPropertiesDrivingLicenceInformation] = None
+    driving_licence_information: Optional[List[DocumentPropertiesDrivingLicenceInformationItem]] = None
     document_classification: Optional[DocumentPropertiesDocumentClassification] = None
     extracted_data: Optional[DocumentPropertiesExtractedData] = None
     additional_properties: Dict[str, Any] = {}
@@ -173,9 +173,13 @@ class DocumentProperties(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of nfc
         if self.nfc:
             _dict['nfc'] = self.nfc.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of driving_licence_information
+        # override the default output from pydantic by calling `to_dict()` of each item in driving_licence_information (list)
+        _items = []
         if self.driving_licence_information:
-            _dict['driving_licence_information'] = self.driving_licence_information.to_dict()
+            for _item_driving_licence_information in self.driving_licence_information:
+                if _item_driving_licence_information:
+                    _items.append(_item_driving_licence_information.to_dict())
+            _dict['driving_licence_information'] = _items
         # override the default output from pydantic by calling `to_dict()` of document_classification
         if self.document_classification:
             _dict['document_classification'] = self.document_classification.to_dict()
@@ -241,7 +245,7 @@ class DocumentProperties(BaseModel):
             "address_lines": DocumentPropertiesAddressLines.from_dict(obj["address_lines"]) if obj.get("address_lines") is not None else None,
             "barcode": [DocumentPropertiesBarcodeInner.from_dict(_item) for _item in obj["barcode"]] if obj.get("barcode") is not None else None,
             "nfc": DocumentPropertiesNfc.from_dict(obj["nfc"]) if obj.get("nfc") is not None else None,
-            "driving_licence_information": DocumentPropertiesDrivingLicenceInformation.from_dict(obj["driving_licence_information"]) if obj.get("driving_licence_information") is not None else None,
+            "driving_licence_information": [DocumentPropertiesDrivingLicenceInformationItem.from_dict(_item) for _item in obj["driving_licence_information"]] if obj.get("driving_licence_information") is not None else None,
             "document_classification": DocumentPropertiesDocumentClassification.from_dict(obj["document_classification"]) if obj.get("document_classification") is not None else None,
             "extracted_data": DocumentPropertiesExtractedData.from_dict(obj["extracted_data"]) if obj.get("extracted_data") is not None else None
         })

onfido/models/{document_properties_driving_licence_information.py → document_properties_driving_licence_information_item.py}

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

onfido/models/document_with_driver_verification_report_all_of_properties.py

@@ -24,7 +24,7 @@ from onfido.models.document_properties_address_lines import DocumentPropertiesAd
 from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
 from onfido.models.document_properties_document_classification import DocumentPropertiesDocumentClassification
 from onfido.models.document_properties_document_numbers_inner import DocumentPropertiesDocumentNumbersInner
-from onfido.models.document_properties_driving_licence_information import DocumentPropertiesDrivingLicenceInformation
+from onfido.models.document_properties_driving_licence_information_item import DocumentPropertiesDrivingLicenceInformationItem
 from onfido.models.document_properties_extracted_data import DocumentPropertiesExtractedData
 from onfido.models.document_properties_nfc import DocumentPropertiesNfc
 from onfido.models.document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle import DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle
@@ -78,7 +78,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     address_lines: Optional[DocumentPropertiesAddressLines] = None
     barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
     nfc: Optional[DocumentPropertiesNfc] = None
-    driving_licence_information: Optional[DocumentPropertiesDrivingLicenceInformation] = None
+    driving_licence_information: Optional[List[DocumentPropertiesDrivingLicenceInformationItem]] = None
     document_classification: Optional[DocumentPropertiesDocumentClassification] = None
     extracted_data: Optional[DocumentPropertiesExtractedData] = None
     drivers_licence: Optional[StrictBool] = Field(default=None, description="True for **non-restricted** driving licences")
@@ -181,9 +181,13 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of nfc
         if self.nfc:
             _dict['nfc'] = self.nfc.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of driving_licence_information
+        # override the default output from pydantic by calling `to_dict()` of each item in driving_licence_information (list)
+        _items = []
         if self.driving_licence_information:
-            _dict['driving_licence_information'] = self.driving_licence_information.to_dict()
+            for _item_driving_licence_information in self.driving_licence_information:
+                if _item_driving_licence_information:
+                    _items.append(_item_driving_licence_information.to_dict())
+            _dict['driving_licence_information'] = _items
         # override the default output from pydantic by calling `to_dict()` of document_classification
         if self.document_classification:
             _dict['document_classification'] = self.document_classification.to_dict()
@@ -259,7 +263,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
             "address_lines": DocumentPropertiesAddressLines.from_dict(obj["address_lines"]) if obj.get("address_lines") is not None else None,
             "barcode": [DocumentPropertiesBarcodeInner.from_dict(_item) for _item in obj["barcode"]] if obj.get("barcode") is not None else None,
             "nfc": DocumentPropertiesNfc.from_dict(obj["nfc"]) if obj.get("nfc") is not None else None,
-            "driving_licence_information": DocumentPropertiesDrivingLicenceInformation.from_dict(obj["driving_licence_information"]) if obj.get("driving_licence_information") is not None else None,
+            "driving_licence_information": [DocumentPropertiesDrivingLicenceInformationItem.from_dict(_item) for _item in obj["driving_licence_information"]] if obj.get("driving_licence_information") is not None else None,
             "document_classification": DocumentPropertiesDocumentClassification.from_dict(obj["document_classification"]) if obj.get("document_classification") is not None else None,
             "extracted_data": DocumentPropertiesExtractedData.from_dict(obj["extracted_data"]) if obj.get("extracted_data") is not None else None,
             "drivers_licence": obj.get("drivers_licence"),

onfido/models/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_shared.py

@@ -31,8 +31,13 @@ class WebhookShared(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.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["enabled", "events", "environments", "payload_version"]
+    __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"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -95,7 +100,12 @@ class WebhookShared(BaseModel):
             "enabled": obj.get("enabled"),
             "events": obj.get("events"),
             "environments": obj.get("environments"),
-            "payload_version": obj.get("payload_version")
+            "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")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

onfido/models/webhook_updater.py

@@ -31,9 +31,14 @@ class WebhookUpdater(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: Optional[StrictStr] = Field(default=None, 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 WebhookUpdater(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_python-5.0.0.dist-info → onfido_python-5.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: onfido-python
-Version: 5.0.0
+Version: 5.1.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community
@@ -19,6 +19,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 

{onfido_python-5.0.0.dist-info → onfido_python-5.1.0.dist-info}/RECORD

@@ -1,20 +1,21 @@
-onfido/__init__.py,sha256=056tEO3p6M1NHMuHRFt8egOymMyalj0_yLWc4-5lz_E,28728
-onfido/api_client.py,sha256=TAD4uoiWtXk6GHSqKRs0utym8N92OOrZEXMaaFzfMJM,27336
+onfido/__init__.py,sha256=RGMTWSKdU0a6Jbxhf7mjuUYfTDymzAj7E6euURKwl9I,28846
+onfido/api_client.py,sha256=2dUUKSyp8A9chRaEIJOQMKJxotSmYK9PZzIak9l15d8,27336
 onfido/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-onfido/configuration.py,sha256=nGQzsUVjvHdOObHNVqEHgVBHEjVoUv-GbwuN89TFZPE,17499
+onfido/configuration.py,sha256=ieBRtciwq2kOv9FZzTA9BkErOTQ5mfnaiWvPRFAXhVs,17499
 onfido/exceptions.py,sha256=WeiPD-xpPmBqoLZK859mtLTO5bM8aIsj_oSrkr4bUR4,6393
 onfido/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 onfido/rest.py,sha256=kI5k8RQ6_BemD6Zx99dJDmr7zwA1mSrHLlba2WwwoMM,9419
 onfido/webhook_event_verifier.py,sha256=RPoASdqspjgBn9Q_U4dRzOMuMVDYpXSaXluB_zydSIk,891
 onfido/api/__init__.py,sha256=hqeJm_GD67zukfFQ-H5PPPxYgZZ0DKOMPGTNRAjc3gw,94
-onfido/api/default_api.py,sha256=yJ7meWxCOsjHqHvtTzNjPq1BWe6Ohn-MIBBj8Xt2tYA,718164
-onfido/models/__init__.py,sha256=tfLRPpOt3cP_sinrG_ZYXBg-KQSFV3qbLy7sdmTEQyE,28076
+onfido/api/default_api.py,sha256=Kuo7DV2b_syxWEv3o99NLotLjqupATmKL8P8ZYorTjY,728215
+onfido/models/__init__.py,sha256=mvIdcOMTDxlyyk61hz0vjs2g5HgafRAo5lBctzwVxg8,28194
 onfido/models/address.py,sha256=47oVzKVhn6Qxd24HMIuAQmVKgHPyfOnlFmBnthi2wOE,6812
 onfido/models/address_builder.py,sha256=SjuOn2_T7Yic2l7qhaxd-euaijx85BziRkunp5j292M,6840
 onfido/models/address_shared.py,sha256=WSQNw_W-V63Jgsh1Jf6KYWb4qm-eOW1URx_8r0LBUMk,6836
 onfido/models/addresses_list.py,sha256=jRGJls3Q6Kp356ngIZBRLnMv5hi9iyvWbt2Ss0BkZ4w,3492
 onfido/models/applicant.py,sha256=vbNaqoa2SJf1jVzmmDwIFLeIPkX4UY01EujKbZ4q-h4,6721
 onfido/models/applicant_builder.py,sha256=TxQXfh-EVPNxmiE1GhVY5iccz9g2iDtcFjL2SiekVKY,6578
+onfido/models/applicant_consent.py,sha256=IYuhM0BGuniQIQbnCkpIDi7mrp114UNFCn5nolCnRKM,3640
 onfido/models/applicant_consent_builder.py,sha256=56H283tjE430WgY7p_u5_X0ZH96v1j5uPyX3kjeAQRM,3185
 onfido/models/applicant_consent_name.py,sha256=o8eRcl-XgrJo9Q4EZtuBIUVFG8PKY4eiJTpS1BSCCkE,861
 onfido/models/applicant_create.py,sha256=whgIDGEObzjoPEbjq4UztQTgUAxzm5AP0YCtodIoqAs,3924
@@ -34,15 +35,16 @@ onfido/models/checks_list.py,sha256=_GDkN9e73HT0m2g3uGS_7i62_d6uDrEXqpryEARynJ8,
 onfido/models/complete_task_builder.py,sha256=ei2Xxhlnm5ZRuhz27Ptx_eLx7BzSDYb798w67Jf1MxI,3314
 onfido/models/complete_task_data_builder.py,sha256=jqn15cH3do9uIo1jKIRqgzq_fYgMsgssOgUxG0l4X9Q,5372
 onfido/models/country_codes.py,sha256=i9dgxc_DZkV2h2xWe5P09rAkRPlJrBKlYPzmXjFq6co,4685
-onfido/models/device_intelligence_breakdown.py,sha256=ge4lLA_3rwzgJa7FyTPepuHlXMIvVZPYhzaNC9Zp5jQ,3978
-onfido/models/device_intelligence_breakdown_breakdown.py,sha256=CXYtzMzTEIA1NXy4Gu60TQWSbZXHPKYr8U-qA4XfOnw,3504
-onfido/models/device_intelligence_breakdown_breakdown_device.py,sha256=qpgVFyE2KTnTHhp9lOWUiF--QFsiF15kL932AleeC-A,3653
-onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.py,sha256=Cs5BfPLtGoUIJhjGI6hK8HlZM_fvgJ2GXwFmyzgIBjg,4767
+onfido/models/device_intelligence_breakdown.py,sha256=Of9_f4p7ohqK2wNYkMLH8u9jrcwIAmn0g2nejaS_Zg4,4434
+onfido/models/device_intelligence_breakdown_breakdown.py,sha256=2_wgbsN4UqV9f8OJmiQjvcYTzPxz_zWApHsvyqPc3pQ,3467
+onfido/models/device_intelligence_breakdown_device.py,sha256=t3rQ5jmIoVT6hVMZ0GHgsEEwOrHKE0infiPduZR79MU,3589
+onfido/models/device_intelligence_breakdown_device_breakdown.py,sha256=d-tihT0UYoO4aXHmo5x0tEBKCMt24B8JBc3WFE2gw6E,4731
 onfido/models/device_intelligence_breakdown_properties.py,sha256=K44aalsUKtaTEvyKnQRDjnxbi1vGWkZgh7YF3PifhqQ,4519
-onfido/models/device_intelligence_breakdown_properties_device.py,sha256=e8AHJTGbeXgr5XQ5fYalO0e0zPiAGdo1wZpVc2eCqX4,8776
+onfido/models/device_intelligence_breakdown_properties_device.py,sha256=sQYwHHetd7UR0z7KIXhLd6sn8BQyivJutXI1R2RG8sc,8816
 onfido/models/device_intelligence_breakdown_properties_geolocation.py,sha256=78wKBOHlNHAc96ZWMPa6hQQPbYKX6ospdNYgyL56-qM,3618
 onfido/models/device_intelligence_breakdown_properties_ip.py,sha256=Wtm2BPyovvwlRCSk51OhpUAJHp1yZvtb2RktesPXPvg,3205
-onfido/models/device_intelligence_report.py,sha256=ivYsI_S-mpB0LKLfuHK7teciqipgG3Lsg-p0frEyJyw,4734
+onfido/models/device_intelligence_properties.py,sha256=cZek94wE-s7P_ye3cZhAIna8B4jm99izNkDOZ_ubZ8U,4483
+onfido/models/device_intelligence_report.py,sha256=Cf-6sTV2pK32LPyZJiA0enkMfuwHZ7W07NRS5s1pnEE,5205
 onfido/models/document.py,sha256=e0pLWAn6cfIkwieNUiVAW66aGd4WGLXpoP8UIIGRhsY,5321
 onfido/models/document_breakdown.py,sha256=x7lFBT2V2jJvW0JZ6-U_Ca9vjjPOvtCVJP0i__tYc_Y,7813
 onfido/models/document_breakdown_age_validation.py,sha256=ioeCHhNEJB4DnY7cqv-oBa87g46mpnq6BBzBIiafXB8,3699
@@ -82,12 +84,12 @@ onfido/models/document_breakdown_visual_authenticity_breakdown_template.py,sha25
 onfido/models/document_cdq_reasons.py,sha256=1m2qxLuIeC1HKVQim9TLt95l76FDi_rJi0uBYKtd03E,5214
 onfido/models/document_iq_reasons.py,sha256=OKiCuxShiJ4uBrALjsK_Z_z28fnLwPEYev5YV6cDOVc,5392
 onfido/models/document_odp_reasons.py,sha256=RQ6UAGnhkg7hfwOaEqAbuxdjIh2F1QyAhsoIpRsQfN0,3966
-onfido/models/document_properties.py,sha256=NC_eI8cnozD_3vBGm9SFsach5HdRAldbbXRVqs5Mu3c,13103
+onfido/models/document_properties.py,sha256=Miaz_TMMXU7IfPdlp1hqgePNC0AabER2JYdZIDV0Cs8,13371
 onfido/models/document_properties_address_lines.py,sha256=KBEQPfyCQNpoA_VjP6vKroWqnOa_sy-G_UnyiBox-jI,3606
 onfido/models/document_properties_barcode_inner.py,sha256=FVPy1Gc65ECQDY3cuF8J5jhuUNBceyua0ldUepaGZmA,5150
 onfido/models/document_properties_document_classification.py,sha256=YRa0qNQBNXCPnHJn9_N0lKaXzhVCC-xKPezBBaYR7mU,3400
 onfido/models/document_properties_document_numbers_inner.py,sha256=xUZ4yR2OXisMrBjygBDhJGYySvfdcfc1VEvMLrOqN1k,3198
-onfido/models/document_properties_driving_licence_information.py,sha256=ij5akKUnk_-TZxXeh0jun4IGQf6d4NhmSURHeidjxpA,3486
+onfido/models/document_properties_driving_licence_information_item.py,sha256=avQ-fOOqkW7FGZ-Y8NUFSlCWG3Y9SzPgRc97eCEuj8U,3502
 onfido/models/document_properties_extracted_data.py,sha256=vW-B2osOZhlGdeanDlgBDLTcDWYLT6-q5SudaSaBuo8,5376
 onfido/models/document_properties_nfc.py,sha256=0ToFxpEA45NN6Oy9jpOzmLktJpWLAWhBREjehJds-1Y,4475
 onfido/models/document_report.py,sha256=3TBwNCLsnAso7Mv0rWryIGRRTEBuL2bR3Sdx80A-G-4,5787
@@ -99,7 +101,7 @@ onfido/models/document_video_report.py,sha256=Tn4FmpTstClrDbX2WJWjBi46Bq3asDMSZO
 onfido/models/document_video_with_address_information_report.py,sha256=_lY0TXi9XbjLVqzIYBqc9lxP6GSn4MMYpK0iBpSrkyQ,5895
 onfido/models/document_with_address_information_report.py,sha256=zGEpWmcmzURrdDJFWhdJfVB_WdOpaTftdd_00dt7E30,5875
 onfido/models/document_with_driver_verification_report.py,sha256=h7Oi6QXBtksCQjw40VebLNBwDK0ZtibAje-b2VCE89c,6013
-onfido/models/document_with_driver_verification_report_all_of_properties.py,sha256=zJVCr0upQg4UbuqGBcGqdO3aqQiMK8oaaGGbf6DPb_c,15993
+onfido/models/document_with_driver_verification_report_all_of_properties.py,sha256=qmQMfYGj3-jLwwNBK4OduzWy6rfucjOysmgf0fs5Uf0,16261
 onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.py,sha256=xI7noUuOz8MIrJ7iErenQgww2EmgTukpYehLBcC1zZI,3792
 onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.py,sha256=7IYp8uXyMjA2WKyEDkQw_3_ZixPVosy3x7XcXSksXVQ,3866
 onfido/models/document_with_driving_licence_information_report.py,sha256=ZNBwUXWK41K6OMSvaGHZVLZoVVBqRickt7MpbSxjqKA,5903
@@ -275,8 +277,8 @@ onfido/models/watchlist_sanctions_only_report.py,sha256=rmp04GCVBnLDjS_3uOEV9jNG
 onfido/models/watchlist_standard_breakdown.py,sha256=S-y95QaIFHX7mxpTM7Icw3MSf6zRIxvWP9sogqGLruQ,4837
 onfido/models/watchlist_standard_properties.py,sha256=H6PQLnRUJyVB6iEqNzbcq2b8sL0uHKvZ3bvlnjvAxMo,3258
 onfido/models/watchlist_standard_report.py,sha256=mh6YqlnlKGnKk9dt4Gs1qWrhuE71rKPu7k6X9AlHhvo,5193
-onfido/models/webhook.py,sha256=jfqOqga-muzPOTCX90N0yRY41FOWDHsRbwK-2SMHGBI,4613
-onfido/models/webhook_builder.py,sha256=pwhg4W9CuRSdup25LJAV099md70EHPJ9H9gEaREGHy0,4172
+onfido/models/webhook.py,sha256=pMgD0U2WSquDQSa0dAjztD2AzuDl8ZYfpRJoPUZ5PTo,5820
+onfido/models/webhook_builder.py,sha256=EAvRZdklz5zPoQ_tDl2Ywetq_kRaRAWV09l5rkKPA5I,5379
 onfido/models/webhook_create.py,sha256=8Ur6l4YhUAaIl4WCd-dWqPVmHGZ-2cxROA--U0BLVus,3070
 onfido/models/webhook_event.py,sha256=g5lobXwKJsA0J34puBVMcLbm7vcrVlZoFTuvRvCFE9o,3323
 onfido/models/webhook_event_object_status.py,sha256=5R3ggSbPedMyHsiRfx4DXfb-nkURFzhN7EteA3mhXQ8,1325
@@ -287,9 +289,9 @@ onfido/models/webhook_event_resource_type.py,sha256=OGkDFWQNxYZOv871DW5xc4eB-oeQ
 onfido/models/webhook_event_type.py,sha256=YY-PhXB_Hb9O5QOxinQgjRZYIH6XSu5QF5TJyCviWjg,1625
 onfido/models/webhook_resend.py,sha256=H_qpNUnh0y1FJQUy1B6ngY69iH7nHU9qjglRXLXKmPc,3478
 onfido/models/webhook_response.py,sha256=VpnpGMafbWR7oj2Tws-sQlVmNzP9RPEMKvQ_g6wrbt0,3557
-onfido/models/webhook_shared.py,sha256=5KI0bTRB_XbewC1xG1Uhezj5lBjnKGqCIXfrdJvgFJI,4025
+onfido/models/webhook_shared.py,sha256=SWwKu5H9l7bDt1sKZD_SvrsDfEafVcnP_LNsbxXPHkE,5232
 onfido/models/webhook_update.py,sha256=gHE4t1uN84tbCLAcXv5ntfV-HHsWMNCcxjqsDG-r38E,3104
-onfido/models/webhook_updater.py,sha256=6Ff3y5eObsgIDFON-LOjPNyOCbCQ3PF7Eb-dvN6mpuc,4196
+onfido/models/webhook_updater.py,sha256=rtB5nVG6BHjo4xihLLSq77RezySx8OV_SDt2ozJzSKs,5403
 onfido/models/webhooks_list.py,sha256=Mgq7ViW-WcNbQjxTkAyU-RxY3SOBqdDxY3RcwFu6yTU,3449
 onfido/models/webhooks_resend_item.py,sha256=huJSQx0TfXawHiGG7ftxQH399DeK0xWsvTTSLXKM4Nw,3356
 onfido/models/workflow_run.py,sha256=0LI2s-9Rv3VxRQfYU8kofRJcqp3k0hrB64tvNNXXgUw,6952
@@ -300,8 +302,8 @@ onfido/models/workflow_run_request.py,sha256=IGCpkcvqn6kJ2L2nZeuBHNeANqcSUfvx0Ig
 onfido/models/workflow_run_response.py,sha256=Ze469zDUWxZMxqIxas6Sjts3EB21z7PhZTfuWgs0Thw,5080
 onfido/models/workflow_run_shared.py,sha256=WP9qLkf79iaJTeK-QxkwzB2MvR4atT3LdZZRmZopPp4,4857
 onfido/models/workflow_run_status.py,sha256=JCHhcFSLM3aiW-fOve51psGJ0_RS-PI--NnvVNSG3fI,942
-onfido_python-5.0.0.dist-info/LICENSE,sha256=SKY_O1OkFX8yNWFuVVfYTsXvN46jsgtff-xReserHw4,1073
-onfido_python-5.0.0.dist-info/METADATA,sha256=MTsN_8L3kP6ms0hgl3l6jLrGoDXUN3D3n30jewdI458,654
-onfido_python-5.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-onfido_python-5.0.0.dist-info/top_level.txt,sha256=NHu8xI4S4Avh7xUark3dpdk9atpIVgyf-ptjHXU0-Ns,7
-onfido_python-5.0.0.dist-info/RECORD,,
+onfido_python-5.1.0.dist-info/licenses/LICENSE,sha256=SKY_O1OkFX8yNWFuVVfYTsXvN46jsgtff-xReserHw4,1073
+onfido_python-5.1.0.dist-info/METADATA,sha256=DpwT6dz8L1dmdMnwApfyfwpnJ2qXq3ksKnf4XwNdPak,676
+onfido_python-5.1.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+onfido_python-5.1.0.dist-info/top_level.txt,sha256=NHu8xI4S4Avh7xUark3dpdk9atpIVgyf-ptjHXU0-Ns,7
+onfido_python-5.1.0.dist-info/RECORD,,

{onfido_python-5.0.0.dist-info → onfido_python-5.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.4.0)
 Root-Is-Purelib: true
 Tag: py3-none-any