onfido-python 5.3.0__tar.gz → 5.5.0__tar.gz

{onfido_python-5.3.0 → onfido_python-5.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onfido-python
-Version: 5.3.0
+Version: 5.5.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community
@@ -23,5 +23,5 @@ Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
     

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/__init__.py

@@ -3,9 +3,9 @@
 # flake8: noqa
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "5.3.0"
+__version__ = "5.5.0"
 
 # import apis into sdk package
 from onfido.api.default_api import DefaultApi
@@ -205,6 +205,10 @@ from onfido.models.identity_enhanced_breakdown_sources_breakdown_total_sources_p
 from onfido.models.identity_enhanced_properties import IdentityEnhancedProperties
 from onfido.models.identity_enhanced_properties_matched_addresses_inner import IdentityEnhancedPropertiesMatchedAddressesInner
 from onfido.models.identity_enhanced_report import IdentityEnhancedReport
+from onfido.models.idr_ssn_breakdown import IdrSsnBreakdown
+from onfido.models.idr_ssn_breakdown_breakdown import IdrSsnBreakdownBreakdown
+from onfido.models.idr_ssn_breakdown_breakdown_full_match import IdrSsnBreakdownBreakdownFullMatch
+from onfido.models.idr_ssn_breakdown_breakdown_last4_digits_match import IdrSsnBreakdownBreakdownLast4DigitsMatch
 from onfido.models.india_pan_report import IndiaPanReport
 from onfido.models.india_pan_report_all_of_breakdown import IndiaPanReportAllOfBreakdown
 from onfido.models.india_pan_report_all_of_breakdown_device import IndiaPanReportAllOfBreakdownDevice

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/api/default_api.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -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.3.0 → onfido_python-5.5.0}/onfido/api_client.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -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.3.0'
+        self.user_agent = 'onfido-python/5.5.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/configuration.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -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.3.0".\
+               "SDK Package Version: 5.5.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/exceptions.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/__init__.py

@@ -2,9 +2,9 @@
 
 # flake8: noqa
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -188,6 +188,10 @@ from onfido.models.identity_enhanced_breakdown_sources_breakdown_total_sources_p
 from onfido.models.identity_enhanced_properties import IdentityEnhancedProperties
 from onfido.models.identity_enhanced_properties_matched_addresses_inner import IdentityEnhancedPropertiesMatchedAddressesInner
 from onfido.models.identity_enhanced_report import IdentityEnhancedReport
+from onfido.models.idr_ssn_breakdown import IdrSsnBreakdown
+from onfido.models.idr_ssn_breakdown_breakdown import IdrSsnBreakdownBreakdown
+from onfido.models.idr_ssn_breakdown_breakdown_full_match import IdrSsnBreakdownBreakdownFullMatch
+from onfido.models.idr_ssn_breakdown_breakdown_last4_digits_match import IdrSsnBreakdownBreakdownLast4DigitsMatch
 from onfido.models.india_pan_report import IndiaPanReport
 from onfido.models.india_pan_report_all_of_breakdown import IndiaPanReportAllOfBreakdown
 from onfido.models.india_pan_report_all_of_breakdown_device import IndiaPanReportAllOfBreakdownDevice

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/address.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/address_builder.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/address_shared.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/addresses_list.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_builder.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_consent.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_consent_builder.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_consent_name.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_create.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_request.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_response.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_shared.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_update.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicant_updater.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/applicants_list.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/check.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)

{onfido_python-5.3.0 → onfido_python-5.5.0}/onfido/models/check_builder.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Onfido API v3.6
+    Onfido Public API v3.6
 
-    The Onfido API (v3.6)
+    The Onfido Public API (v3.6)
 
     The version of the OpenAPI document: v3.6
     Generated by OpenAPI Generator (https://openapi-generator.tech)