onfido-python 4.3.0__tar.gz → 4.5.0__tar.gz

{onfido_python-4.3.0 → onfido_python-4.5.0}/PKG-INFO

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

{onfido_python-4.3.0 → onfido_python-4.5.0}/onfido/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "4.3.0"
+__version__ = "4.5.0"
 
 # import apis into sdk package
 from onfido.api.default_api import DefaultApi

{onfido_python-4.3.0 → onfido_python-4.5.0}/onfido/api/default_api.py

@@ -3847,6 +3847,271 @@ class DefaultApi:
 
 
 
+    @validate_call
+    def download_evidence_folder(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")],
+        _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,
+    ) -> bytearray:
+        """Retrieve Workflow Run Evidence Folder
+
+        Retrieves the evidence folder for the designated Workflow Run 
+
+        :param workflow_run_id: Workflow Run ID (required)
+        :type workflow_run_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._download_evidence_folder_serialize(
+            workflow_run_id=workflow_run_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        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 download_evidence_folder_with_http_info(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")],
+        _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[bytearray]:
+        """Retrieve Workflow Run Evidence Folder
+
+        Retrieves the evidence folder for the designated Workflow Run 
+
+        :param workflow_run_id: Workflow Run ID (required)
+        :type workflow_run_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._download_evidence_folder_serialize(
+            workflow_run_id=workflow_run_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        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 download_evidence_folder_without_preload_content(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")],
+        _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 Workflow Run Evidence Folder
+
+        Retrieves the evidence folder for the designated Workflow Run 
+
+        :param workflow_run_id: Workflow Run ID (required)
+        :type workflow_run_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._download_evidence_folder_serialize(
+            workflow_run_id=workflow_run_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _download_evidence_folder_serialize(
+        self,
+        workflow_run_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 workflow_run_id is not None:
+            _path_params['workflow_run_id'] = workflow_run_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/zip', 
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Token'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/workflow_runs/{workflow_run_id}/evidence_folder',
+            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 download_id_photo(
         self,

{onfido_python-4.3.0 → onfido_python-4.5.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.3.0'
+        self.user_agent = 'onfido-python/4.5.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{onfido_python-4.3.0 → onfido_python-4.5.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.3.0".\
+               "SDK Package Version: 4.5.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{onfido_python-4.3.0 → onfido_python-4.5.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.3.0 → onfido_python-4.5.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.3.0 → onfido_python-4.5.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.3.0 → onfido_python-4.5.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.3.0 → onfido_python-4.5.0}/onfido_python.egg-info/PKG-INFO

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

{onfido_python-4.3.0 → onfido_python-4.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "onfido-python"
-version = "4.3.0"
+version = "4.5.0"
 description = "Python library for the Onfido API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "MIT"
@@ -8,6 +8,7 @@ readme = "README.md"
 repository = "https://github.com/onfido/onfido-python"
 keywords = ["OpenAPI", "OpenAPI-Generator", "onfido", "identity"]
 include = ["onfido/py.typed"]
+package-mode = false
 
 [tool.poetry.urls]
 "Onfido API documentation" = "https://documentation.onfido.com"

{onfido_python-4.3.0 → onfido_python-4.5.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.3.0"
+VERSION = "4.5.0"
 PYTHON_REQUIRES = ">= 3.8"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 3.0.0",

{onfido_python-4.3.0 → onfido_python-4.5.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.5.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.3.0 → onfido_python-4.5.0}/tests/test_workflow_runs.py

@@ -1,3 +1,5 @@
+import tempfile
+import zipfile
 import pytest
 
 from onfido import TimelineFileReference, WorkflowRun, WorkflowRunBuilder, WorkflowRunStatus
@@ -70,6 +72,23 @@ def test_download_evidence_file(onfido_api, workflow_run):
     assert file[:4] == b"%PDF"
 
 
+def test_download_evidence_folder(onfido_api, applicant_id):
+    workflow_id = "221f9d24-cf72-4762-ac4a-01bf3ccc09dd"
+    workflow_run_id = create_workflow_run(
+        onfido_api, applicant_id=applicant_id, workflow_id=workflow_id
+    ).id
+    repeat_request_until_status_changes(
+        onfido_api.find_workflow_run, [workflow_run_id], WorkflowRunStatus.APPROVED
+    )
+
+    file = onfido_api.download_evidence_folder(workflow_run_id)
+
+    assert len(file) > 0
+    with tempfile.NamedTemporaryFile() as tmp_file:
+        tmp_file.write(file)
+        assert zipfile.is_zipfile(tmp_file.name)
+
+
 def test_generate_timeline_file(onfido_api, applicant_id):
     workflow_id = "221f9d24-cf72-4762-ac4a-01bf3ccc09dd"
     workflow_run_id = create_workflow_run(

onfido_python-4.3.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"