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

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

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

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

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "4.2.0"
+__version__ = "4.4.0"
 
 # import apis into sdk package
 from onfido.api.default_api import DefaultApi
@@ -106,7 +106,7 @@ from onfido.models.document_iq_reasons import DocumentIQReasons
 from onfido.models.document_odp_reasons import DocumentODPReasons
 from onfido.models.document_properties import DocumentProperties
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
-from onfido.models.document_properties_barcode import DocumentPropertiesBarcode
+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

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

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

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

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

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

@@ -89,7 +89,7 @@ from onfido.models.document_iq_reasons import DocumentIQReasons
 from onfido.models.document_odp_reasons import DocumentODPReasons
 from onfido.models.document_properties import DocumentProperties
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
-from onfido.models.document_properties_barcode import DocumentPropertiesBarcode
+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

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

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

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

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

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

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

{onfido_python-4.2.0 → onfido_python-4.4.0}/onfido/models/task.py

@@ -33,7 +33,7 @@ class Task(BaseModel):
     task_def_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The identifier for the Task Definition.")
     task_def_version: Optional[StrictStr] = Field(default=None, description="The task definition version.")
     input: Optional[Dict[str, Any]] = Field(default=None, description="Input object with the fields used by the Task to execute.")
-    output: Optional[Dict[str, Any]] = Field(default=None, description="Output object with the fields produced by the Task execution.")
+    output: Any = Field(default=None, description="Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.")
     created_at: Optional[datetime] = Field(default=None, description="The date and time when the Task was created.")
     updated_at: Optional[datetime] = Field(default=None, description="The date and time when the Task was last updated.")
     additional_properties: Dict[str, Any] = {}

{onfido_python-4.2.0 → onfido_python-4.4.0}/onfido/models/webhook_event_payload_resource.py

@@ -41,7 +41,7 @@ class WebhookEventPayloadResource(BaseModel):
     task_def_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The identifier for the Task Definition.")
     task_def_version: Optional[StrictStr] = Field(default=None, description="The task definition version.")
     input: Optional[Dict[str, Any]] = Field(default=None, description="Input object with the fields used by the Task execution.")
-    output: Optional[Dict[str, Any]] = Field(default=None, description="Output object with the fields produced by the Task execution.")
+    output: Any = Field(default=None, description="Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.")
     reasons: Optional[List[StrictStr]] = Field(default=None, description="The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow Version.")
     link: Optional[WorkflowRunLink] = Field(default=None, description="Object for the configuration of the Workflow Run link.")
     error: Optional[WorkflowRunError] = Field(default=None, description="Error object that details why a Workflow Run is in Error status.")

{onfido_python-4.2.0 → onfido_python-4.4.0}/onfido/models/webhook_event_resource_type.py

@@ -32,6 +32,8 @@ class WebhookEventResourceType(str, Enum):
     WORKFLOW_RUN = 'workflow_run'
     WORKFLOW_TASK = 'workflow_task'
     WATCHLIST_MONITOR = 'watchlist_monitor'
+    WORKFLOW_TIMELINE_FILE = 'workflow_timeline_file'
+    WORKFLOW_RUN_EVIDENCE_FOLDER = 'workflow_run_evidence_folder'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{onfido_python-4.2.0 → onfido_python-4.4.0}/onfido/models/webhook_event_type.py

@@ -43,6 +43,7 @@ class WebhookEventType(str, Enum):
     REPORT_DOT_COMPLETED = 'report.completed'
     WORKFLOW_TIMELINE_FILE_DOT_CREATED = 'workflow_timeline_file.created'
     WORKFLOW_SIGNED_EVIDENCE_FILE_DOT_CREATED = 'workflow_signed_evidence_file.created'
+    WORKFLOW_RUN_EVIDENCE_FOLDER_DOT_CREATED = 'workflow_run_evidence_folder.created'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{onfido_python-4.2.0 → onfido_python-4.4.0}/onfido_python.egg-info/PKG-INFO

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

{onfido_python-4.2.0 → onfido_python-4.4.0}/onfido_python.egg-info/SOURCES.txt

@@ -88,7 +88,7 @@ onfido/models/document_iq_reasons.py
 onfido/models/document_odp_reasons.py
 onfido/models/document_properties.py
 onfido/models/document_properties_address_lines.py
-onfido/models/document_properties_barcode.py
+onfido/models/document_properties_barcode_inner.py
 onfido/models/document_properties_document_classification.py
 onfido/models/document_properties_document_numbers_inner.py
 onfido/models/document_properties_driving_licence_information.py

{onfido_python-4.2.0 → onfido_python-4.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "onfido-python"
-version = "4.2.0"
+version = "4.4.0"
 description = "Python library for the Onfido API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "MIT"

{onfido_python-4.2.0 → onfido_python-4.4.0}/setup.py

@@ -21,7 +21,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "onfido-python"
-VERSION = "4.2.0"
+VERSION = "4.4.0"
 PYTHON_REQUIRES = ">= 3.8"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 3.0.0",

{onfido_python-4.2.0 → onfido_python-4.4.0}/tests/test_report_schemas.py

@@ -87,4 +87,4 @@ def test_schema_of_document_with_address_information_report_id_valid(
     )
 
     assert isinstance(report, DocumentWithAddressInformationReport)
-    assert report.properties.barcode.document_type == 'driving_licence'
+    assert report.properties.barcode[0].document_type == 'driving_licence'

{onfido_python-4.2.0 → onfido_python-4.4.0}/tests/test_studio_webhook_event_verification.py

@@ -61,3 +61,41 @@ def test_webhook_verification_invalid_signature():
 
     with pytest.raises(OnfidoInvalidSignatureError):
         verifier.read_payload(raw_event, signature)
+
+
+def test_webhook_verification_with_object_in_output():
+    signature = "e3e5565647f5ccf07b2fd8ac22eab94a0a0619413d981fb768295c820523f7d7"
+
+    with open('tests/media/studio_webhook_event_with_object_in_output.json', 'r') as file:
+        event = verifier.read_payload(file.read(), signature)
+
+    assert event.payload.resource.output['properties'] == {
+        'date_of_birth': '1990-01-01',
+        'date_of_expiry': '2031-05-28',
+        'document_number': '999999999',
+        'document_numbers': [
+            {
+                'type': 'document_number',
+                'value': '999999999'
+            }
+        ],
+       'document_type': 'passport',
+       'first_name': 'Jane',
+       'issuing_country': 'GBR',
+       'last_name': 'Doe',
+    }
+
+
+def test_webhook_verification_with_list_in_output():
+    signature = "f3a5170acfcecf8c1bf6d9cb9995c0d9dec941af83056a721530f8de7af2c293"
+
+    with open('tests/media/studio_webhook_event_with_list_in_output.json', 'r') as file:
+        event = verifier.read_payload(file.read(), signature)
+
+    assert event.payload.resource.output == [
+        {
+          'checksum_sha256': 'hiwV2PLmeQZzeySPGGwVL48sxVXcyfpXy9LDl1u3lWU=',
+          'id': '7af75a3a-ba34-4aa5-9e3e-096c9f56256b',
+          'type': 'document_photo'
+        }
+    ]

onfido_python-4.4.0/tests/test_tasks.py

@@ -0,0 +1,90 @@
+import pytest
+
+from onfido import Task, TaskItem, CompleteTaskBuilder, CompleteTaskDataBuilder
+from tests.conftest import create_applicant, create_workflow_run, upload_document
+
+
+@pytest.fixture(scope="function")
+def applicant_id(onfido_api):
+    return create_applicant(onfido_api).id
+
+
+@pytest.fixture(scope="function")
+def workflow_id():
+    return "5025d9fd-7842-4805-bce1-a7bfd7131b4e"
+
+@pytest.fixture(scope="function")
+def document_id(onfido_api, applicant_id):
+    return upload_document(onfido_api, applicant_id).id
+
+@pytest.fixture(scope="function")
+def workflow_run_id(onfido_api, applicant_id, workflow_id):
+    return create_workflow_run(
+        onfido_api, applicant_id=applicant_id, workflow_id=workflow_id
+    ).id
+
+
+def test_list_tasks(onfido_api, workflow_run_id):
+    tasks = onfido_api.list_tasks(workflow_run_id)
+
+    assert tasks is not None
+    assert isinstance(tasks[0], TaskItem)
+    assert len(tasks) == 2
+
+
+def test_find_task(onfido_api, workflow_run_id):
+    task = onfido_api.list_tasks(workflow_run_id)[0]
+    get_task = onfido_api.find_task(workflow_run_id, task.id)
+
+    assert get_task is not None
+    assert isinstance(get_task, Task)
+    assert get_task.id == task.id
+    assert get_task.task_def_id == task.task_def_id
+
+
+def test_complete_task(onfido_api, workflow_run_id, document_id):
+    profile_data_task_id = next(
+        filter(lambda task: "profile" in task.id,
+               onfido_api.list_tasks(workflow_run_id))).id
+
+    complete_task_builder = CompleteTaskBuilder(
+        data=CompleteTaskDataBuilder({"first_name": "Jane", "last_name": "Doe"})
+    )
+
+    onfido_api.complete_task(
+        workflow_run_id=workflow_run_id,
+        task_id=profile_data_task_id,
+        complete_task_builder=complete_task_builder,
+    )
+
+    profile_task_outputs = onfido_api.find_task(workflow_run_id,
+                                                profile_data_task_id).output
+
+    assert profile_task_outputs["first_name"] == "Jane"
+    assert profile_task_outputs["last_name"] == "Doe"
+
+    document_capture_task_id = next(
+        filter(lambda task: "document_photo" in task.id,
+               onfido_api.list_tasks(workflow_run_id))
+    ).id
+
+    complete_document_capture_task_builder = CompleteTaskBuilder(
+        data=CompleteTaskDataBuilder([{"id": document_id}])
+    )
+
+    onfido_api.complete_task(
+        workflow_run_id=workflow_run_id,
+        task_id=document_capture_task_id,
+        complete_task_builder=complete_document_capture_task_builder,
+    )
+
+    document_photo_task_id = next(
+        filter(lambda task: "document_photo" in task.id,
+               onfido_api.list_tasks(workflow_run_id))).id
+
+    document_photo_task_outputs = onfido_api.find_task(
+        workflow_run_id,
+        document_photo_task_id).output
+
+    assert document_photo_task_outputs == [{"id": document_id,
+                                            "type": "document"}]

onfido_python-4.2.0/tests/test_tasks.py

@@ -1,59 +0,0 @@
-import pytest
-
-from onfido import Task, TaskItem, CompleteTaskBuilder, CompleteTaskDataBuilder
-from tests.conftest import create_applicant, create_workflow_run
-
-
-@pytest.fixture(scope="function")
-def applicant_id(onfido_api):
-    return create_applicant(onfido_api).id
-
-
-@pytest.fixture(scope="function")
-def workflow_id():
-    return "e8c921eb-0495-44fe-b655-bcdcaffdafe5"
-
-
-@pytest.fixture(scope="function")
-def workflow_run_id(onfido_api, applicant_id, workflow_id):
-    return create_workflow_run(
-        onfido_api, applicant_id=applicant_id, workflow_id=workflow_id
-    ).id
-
-
-def test_list_tasks(onfido_api, workflow_run_id):
-    tasks = onfido_api.list_tasks(workflow_run_id)
-
-    assert tasks is not None
-    assert isinstance(tasks[0], TaskItem)
-    assert len(tasks) == 2
-
-
-def test_find_task(onfido_api, workflow_run_id):
-    task = onfido_api.list_tasks(workflow_run_id)[0]
-    get_task = onfido_api.find_task(workflow_run_id, task.id)
-
-    assert get_task is not None
-    assert isinstance(get_task, Task)
-    assert get_task.id == task.id
-    assert get_task.task_def_id == task.task_def_id
-
-
-def test_complete_task(onfido_api, workflow_run_id):
-    tasks = onfido_api.list_tasks(workflow_run_id)
-    profile_data_task_id = list(filter(lambda task: "profile" in task.id, tasks))[0].id
-
-    complete_task_builder = CompleteTaskBuilder(
-        data=CompleteTaskDataBuilder({"first_name": "Jane", "last_name": "Doe"})
-    )
-
-    onfido_api.complete_task(
-        workflow_run_id=workflow_run_id,
-        task_id=profile_data_task_id,
-        complete_task_builder=complete_task_builder,
-    )
-
-    task_outputs = onfido_api.find_task(workflow_run_id, profile_data_task_id).output
-
-    assert task_outputs["first_name"] == "Jane"
-    assert task_outputs["last_name"] == "Doe"