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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: onfido-python
-Version: 4.4.0
+Version: 4.6.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community
@@ -13,6 +13,14 @@ Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
     The Onfido API (v3.6)
     

{onfido_python-4.4.0 → onfido_python-4.6.0}/README.md

@@ -2,9 +2,9 @@
 
 The official Python library for integrating with the Onfido API.
 
-Documentation can be found at <https://documentation.onfido.com>.
+Documentation is available at <https://documentation.onfido.com>.
 
-This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
+This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details. It explains which client library versions use which versions of the API.
 
 [![PyPI version](https://badge.fury.io/py/onfido-python.svg)](https://badge.fury.io/py/onfido-python)
 ![Build Status](https://github.com/onfido/onfido-python/actions/workflows/python.yml/badge.svg)
@@ -19,7 +19,7 @@ Python 3.7+
 
 #### Pip
 
-If the python package is hosted on a repository, you can install directly using:
+If the Python package is hosted on a repository, you can install it directly using:
 
 ```sh
 pip install onfido-python
@@ -68,7 +68,7 @@ with onfido.ApiClient(configuration) as api_client:
   ...
 ```
 
-NB: by default, timeout values are set to 30 seconds.
+NB: by default, timeout values are set to 30 seconds. You can change the default timeout values by setting the `timeout` parameter in the `Configuration` object, as shown in the example above.
 
 ### Making a call to the API
 
@@ -97,7 +97,7 @@ Specific exception types are defined into [exceptions.py](onfido/exceptions.py).
 
 ### Webhook event verification
 
-Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
+Webhook events payload needs to be verified before it can be accessed. Verifying webhook payloads is crucial for security reasons, as it ensures that the payloads are indeed from Onfido and have not been tampered with. The library allows you to easily decode the payload and verify its signature before returning it as an object for user convenience:
 
 ```python
   try:
@@ -115,41 +115,43 @@ Webhook events payload needs to be verified before it can be accessed. Library a
 
 #### Do not use additional properties
 
-Retain from using `additional_properties` dictionary to access not defined properties to avoid breaking changes when these fields will appear.
+Except for accessing Task object's outputs, avoid using the `additional_properties` dictionary to access undefined properties to prevent breaking changes when these fields appear.
 
 ## Contributing
 
-This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
+This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
 
 For contributions to the tests instead, please follow the steps below:
 
-1. [Fork](https://github.com/onfido/onfido-python/fork) repository
+1. Fork the [repository](https://github.com/onfido/onfido-python/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Make your changes
-4. Commit your changes (`git commit -am 'Add some feature'`)
+4. Commit your changes (`git commit -am 'Add detailed description of the feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 
 ## Versioning policy
 
-[Semantic Versioning](https://semver.org) policy is used for library versioning, following guidelines and limitations below:
+Versioning helps manage changes and ensures compatibility across different versions of the library.
 
-- MAJOR versions (x.0.0) might:
+[Semantic Versioning](https://semver.org) policy is used for library versioning, following the guidelines and limitations outlined below:
+
+- MAJOR versions (x.0.0) may:
   - target a new API version
   - include non-backward compatible change
-- MINOR versions (0.x.0) might:
+- MINOR versions (0.x.0) may:
   - add a new functionality, non-mandatory parameter or property
   - deprecate an old functionality
   - include non-backward compatible change to a functionality which is:
     - labelled as alpha or beta
     - completely broken and not usable
-- PATCH version (0.0.x) might:
+- PATCH version (0.0.x) will:
   - fix a bug
   - include backward compatible changes only
 
 ## More documentation
 
-More documentation and code examples can be found at <https://documentation.onfido.com>.
+Additional documentation and code examples can be found at <https://documentation.onfido.com>.
 
 ## Support
 

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

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

{onfido_python-4.4.0 → onfido_python-4.6.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.4.0 → onfido_python-4.6.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.4.0'
+        self.user_agent = 'onfido-python/4.6.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

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

{onfido_python-4.4.0 → onfido_python-4.6.0}/onfido/models/id_number.py

@@ -38,8 +38,8 @@ class IdNumber(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other']):
-            raise ValueError("must be one of enum values ('ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other')")
+        if value not in set(['ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_license', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other']):
+            raise ValueError("must be one of enum values ('ssn', 'social_insurance', 'tax_id', 'identity_card', 'driving_license', 'driving_licence', 'share_code', 'voter_id', 'passport', 'other')")
         return value
 
     model_config = ConfigDict(

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

@@ -45,8 +45,9 @@ class WebhookEventPayloadResource(BaseModel):
     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.")
+    customer_user_id: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(default=None, description="Customer-provided user identifier.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "applicant_id", "created_at", "updated_at", "dashboard_url", "workflow_id", "workflow_run_id", "workflow_version_id", "task_def_id", "task_def_version", "input", "output", "reasons", "link", "error"]
+    __properties: ClassVar[List[str]] = ["id", "applicant_id", "created_at", "updated_at", "dashboard_url", "workflow_id", "workflow_run_id", "workflow_version_id", "task_def_id", "task_def_version", "input", "output", "reasons", "link", "error", "customer_user_id"]
 
     @field_validator('task_def_id')
     def task_def_id_validate_regular_expression(cls, value):
@@ -146,7 +147,8 @@ class WebhookEventPayloadResource(BaseModel):
             "output": obj.get("output"),
             "reasons": obj.get("reasons"),
             "link": WorkflowRunLink.from_dict(obj["link"]) if obj.get("link") is not None else None,
-            "error": WorkflowRunError.from_dict(obj["error"]) if obj.get("error") is not None else None
+            "error": WorkflowRunError.from_dict(obj["error"]) if obj.get("error") is not None else None,
+            "customer_user_id": obj.get("customer_user_id")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: onfido-python
-Version: 4.4.0
+Version: 4.6.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community
@@ -13,6 +13,14 @@ Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
     The Onfido API (v3.6)
     

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "onfido-python"
-version = "4.4.0"
+version = "4.6.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.4.0 → onfido_python-4.6.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.4.0"
+VERSION = "4.6.0"
 PYTHON_REQUIRES = ">= 3.8"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 3.0.0",

{onfido_python-4.4.0 → onfido_python-4.6.0}/tests/test_reports.py

@@ -1,7 +1,12 @@
 import pytest
 
 from onfido import Report, ReportName, ReportStatus
-from tests.conftest import create_applicant, create_check, upload_document
+from tests.conftest import (
+    create_applicant,
+    create_check,
+    upload_document,
+    repeat_request_until_status_changes,
+)
 from typing import List
 
 
@@ -51,13 +56,17 @@ def test_list_reports(sorted_reports):
 
 
 def test_find_report(onfido_api, document_report_id, identity_report_id):
-    get_document_report = onfido_api.find_report(document_report_id)
+    get_document_report = Report(
+        repeat_request_until_status_changes(
+            onfido_api.find_report, [document_report_id], ReportStatus.COMPLETE
+        )
+    )
     get_identity_report = onfido_api.find_report(identity_report_id)
 
     assert isinstance(get_document_report, Report)
     assert get_document_report.actual_instance.id == document_report_id
     assert get_document_report.actual_instance.name == ReportName.DOCUMENT
-    assert get_document_report.actual_instance.status == ReportStatus.AWAITING_DATA
+    assert get_document_report.actual_instance.status == ReportStatus.COMPLETE
 
     assert isinstance(get_identity_report, Report)
     assert get_identity_report.actual_instance.id == identity_report_id

{onfido_python-4.4.0 → onfido_python-4.6.0}/tests/test_workflow_runs.py

@@ -1,6 +1,13 @@
+import tempfile
+import zipfile
 import pytest
 
-from onfido import TimelineFileReference, WorkflowRun, WorkflowRunBuilder, WorkflowRunStatus
+from onfido import (
+    TimelineFileReference,
+    WorkflowRun,
+    WorkflowRunBuilder,
+    WorkflowRunStatus,
+)
 from tests.conftest import (
     create_applicant,
     create_workflow_run,
@@ -70,6 +77,25 @@ 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 = repeat_request_until_http_code_changes(
+        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(