onfido-python 5.2.0__tar.gz → 5.4.0__tar.gz

{onfido_python-5.2.0/onfido_python.egg-info → onfido_python-5.4.0}/PKG-INFO

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

{onfido_python-5.2.0 → onfido_python-5.4.0}/onfido/__init__.py

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

{onfido_python-5.2.0 → onfido_python-5.4.0}/onfido/api/default_api.py

@@ -3062,6 +3062,290 @@ class DefaultApi:
 
 
 
+    @validate_call
+    def download_aes_document(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _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:
+        """Retrieves the signed document or signing transaction receipt
+
+        Retrieves the signed document or signing transaction receipt depending on the id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param id: The unique identifier of the file which you want to retrieve. (required)
+        :type 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_aes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            id=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_aes_document_with_http_info(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _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]:
+        """Retrieves the signed document or signing transaction receipt
+
+        Retrieves the signed document or signing transaction receipt depending on the id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param id: The unique identifier of the file which you want to retrieve. (required)
+        :type 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_aes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            id=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_aes_document_without_preload_content(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _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:
+        """Retrieves the signed document or signing transaction receipt
+
+        Retrieves the signed document or signing transaction receipt depending on the id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param id: The unique identifier of the file which you want to retrieve. (required)
+        :type 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_aes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            id=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_aes_document_serialize(
+        self,
+        workflow_run_id,
+        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
+        # process the query parameters
+        if workflow_run_id is not None:
+            
+            _query_params.append(('workflow_run_id', workflow_run_id))
+            
+        if id is not None:
+            
+            _query_params.append(('id', id))
+            
+        # 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/pdf', 
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Token'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/advanced_electronic_signature/documents',
+            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_check(
         self,

{onfido_python-5.2.0 → onfido_python-5.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/5.2.0'
+        self.user_agent = 'onfido-python/5.4.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{onfido_python-5.2.0 → onfido_python-5.4.0}/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.2.0".\
+               "SDK Package Version: 5.4.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{onfido_python-5.2.0 → onfido_python-5.4.0}/onfido/models/document_with_driver_verification_report_all_of_properties.py

@@ -85,10 +85,11 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     restricted_licence: Optional[StrictBool] = Field(default=None, description="True for **limited/restricted** driving license, including learner's permits")
     raw_licence_category: Optional[StrictStr] = Field(default=None, description="Underlying, non-normalised, licence category (e.g. \"Junior operators license\")")
     raw_vehicle_classes: Optional[StrictStr] = Field(default=None, description="Comma-separated vehicle classes that the user is qualified for")
+    manual_transmission_restriction: Optional[StrictBool] = Field(default=None, description="True if the user is not qualified to drive a manual transmission")
     vehicle_class_details: Optional[List[DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner]] = Field(default=None, description="Detailed classes/categories information")
     passenger_vehicle: Optional[DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "middle_name", "last_name", "gender", "issuing_country", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data", "drivers_licence", "restricted_licence", "raw_licence_category", "raw_vehicle_classes", "vehicle_class_details", "passenger_vehicle"]
+    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "middle_name", "last_name", "gender", "issuing_country", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data", "drivers_licence", "restricted_licence", "raw_licence_category", "raw_vehicle_classes", "manual_transmission_restriction", "vehicle_class_details", "passenger_vehicle"]
 
     @field_validator('nist_identity_evidence_strength')
     def nist_identity_evidence_strength_validate_enum(cls, value):
@@ -270,6 +271,7 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
             "restricted_licence": obj.get("restricted_licence"),
             "raw_licence_category": obj.get("raw_licence_category"),
             "raw_vehicle_classes": obj.get("raw_vehicle_classes"),
+            "manual_transmission_restriction": obj.get("manual_transmission_restriction"),
             "vehicle_class_details": [DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner.from_dict(_item) for _item in obj["vehicle_class_details"]] if obj.get("vehicle_class_details") is not None else None,
             "passenger_vehicle": DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle.from_dict(obj["passenger_vehicle"]) if obj.get("passenger_vehicle") is not None else None
         })

{onfido_python-5.2.0 → onfido_python-5.4.0/onfido_python.egg-info}/PKG-INFO

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

{onfido_python-5.2.0 → onfido_python-5.4.0}/onfido_python.egg-info/SOURCES.txt

@@ -314,6 +314,7 @@ onfido_python.egg-info/dependency_links.txt
 onfido_python.egg-info/requires.txt
 onfido_python.egg-info/top_level.txt
 tests/test_address_picker.py
+tests/test_advanced_electronic_signatures.py
 tests/test_applicants.py
 tests/test_checks.py
 tests/test_classic_webhook_event_verification.py

{onfido_python-5.2.0 → onfido_python-5.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "onfido-python"
-version = "5.2.0"
+version = "5.4.0"
 description = "Python library for the Onfido API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "MIT"
@@ -8,20 +8,22 @@ readme = "README.md"
 repository = "https://github.com/onfido/onfido-python"
 keywords = ["OpenAPI", "OpenAPI-Generator", "onfido", "identity"]
 include = ["onfido/py.typed"]
-package-mode = false
+packages = [
+    { include = "onfido" }
+]
 
 [tool.poetry.urls]
 "Onfido API documentation" = "https://documentation.onfido.com"
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 
-urllib3 = ">= 1.25.3, < 3.0.0"
+urllib3 = ">= 2.5.0, < 3.0.0"
 python-dateutil = ">= 2.8.2"
 pydantic = ">= 2"
 typing-extensions = ">= 4.7.1"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = ">= 7.2.1"
 pytest-cov = ">= 2.8.1"
 tox = ">= 3.9.0"

{onfido_python-5.2.0 → onfido_python-5.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 = "5.2.0"
+VERSION = "5.4.0"
 PYTHON_REQUIRES = ">= 3.8"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 3.0.0",

onfido_python-5.4.0/tests/test_advanced_electronic_signatures.py

@@ -0,0 +1,70 @@
+import pytest
+
+from onfido import WorkflowRunBuilder
+
+from tests.conftest import (
+    create_applicant,
+    create_workflow_run,
+    repeat_request_until_task_output_changes,
+)
+
+
+@pytest.fixture(scope="function")
+def applicant_id(onfido_api):
+    return create_applicant(onfido_api).id
+
+
+@pytest.fixture(scope="function")
+def workflow_id():
+    return "9554c27e-9886-4052-992d-816467d97d24"
+
+
+@pytest.fixture(scope="function")
+def workflow_run(onfido_api, applicant_id, workflow_id):
+    workflow_run_builder = WorkflowRunBuilder(
+        applicant_id=applicant_id,
+        workflow_id=workflow_id,
+        custom_data={
+            "doc_result": "clear",
+            "face_result": "clear",
+            "transaction_id": "995bf84c-d708-4977-8b88-d4b66bebdaf6",
+        },
+    )
+    return create_workflow_run(
+        onfido_api, workflow_run_builder=workflow_run_builder
+    )
+
+
+@pytest.fixture(scope="function")
+def task_output(onfido_api, workflow_run):
+    task = onfido_api.list_tasks(workflow_run.id)[1]
+
+    output = repeat_request_until_task_output_changes(
+        onfido_api.find_task, [workflow_run.id, task.id], max_retries=10, sleep_time=3
+    ).output
+
+    return output
+
+
+def get_signed_document_id(task_output):
+    return task_output["properties"]["signed_documents"][0]["id"]
+
+
+def get_transaction_receipt_id(task_output):
+    return task_output["properties"]["receipt_document"]["id"]
+
+
+def test_aes_documents(onfido_api, workflow_run, task_output):
+    """Test Advanced Electronic Signature (AES) document download"""
+    signed_document_id = get_signed_document_id(task_output)
+    transaction_receipt_id = get_transaction_receipt_id(task_output)
+
+    # Test signed document download
+    signed_document = onfido_api.download_aes_document(workflow_run.id, signed_document_id)
+    assert len(signed_document) > 0
+    assert signed_document[:4] == b"%PDF"
+
+    # Test transaction receipt download
+    receipt_document = onfido_api.download_aes_document(workflow_run.id, transaction_receipt_id)
+    assert len(receipt_document) > 0
+    assert receipt_document[:4] == b"%PDF"