onfido-python 4.4.0__py3-none-any.whl → 4.6.0__py3-none-any.whl

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/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/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/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/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/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.dist-info → onfido_python-4.6.0.dist-info}/METADATA

@@ -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.dist-info → onfido_python-4.6.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-onfido/__init__.py,sha256=zcNjYI_unnb1qaR30pVOyiJkXHnzQfmK4F8QeBaK-uM,28658
-onfido/api_client.py,sha256=lql3mwRQBgxK4tLxD7ZaEDXgnn4cCqGadI_SLs-bwKg,27329
+onfido/__init__.py,sha256=fHHWxi8IY7jZAxUSnK2vHrLOV_ADikvdqrCQY5GysII,28658
+onfido/api_client.py,sha256=mV9VOHYwcCL3UpDJmLjrFLXuzZrHZ532a-7Sp5Sem9s,27329
 onfido/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-onfido/configuration.py,sha256=SCZ792TldwRxNXWSzYNgQvtLohzYmfDQGr9f8iumZ2A,15012
+onfido/configuration.py,sha256=ANsRZl6rruHhNHvO0NSgTBNhYZHaYttmKC4GspAT1PU,15012
 onfido/exceptions.py,sha256=5W4DJIPVwIzljxoedh5czPXOTBaq6CTTVD92h5ZyN88,5894
 onfido/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 onfido/rest.py,sha256=kI5k8RQ6_BemD6Zx99dJDmr7zwA1mSrHLlba2WwwoMM,9419
 onfido/webhook_event_verifier.py,sha256=3BSbY5D8NTXDbxCX0POuyu5a09dEeWgmikrTe_pttkI,814
 onfido/api/__init__.py,sha256=hqeJm_GD67zukfFQ-H5PPPxYgZZ0DKOMPGTNRAjc3gw,94
-onfido/api/default_api.py,sha256=kWMykJ4nLgi4oYBgLXG88Lm38B6UhMzG1KixOkSJSag,696717
+onfido/api/default_api.py,sha256=1wPurpTPujKLD24OgqZqZ_pTOz1a_PpQhsQqcyKcr5w,707122
 onfido/models/__init__.py,sha256=Zzg8rYhIMdXSQf5d5C2G15jnbnHWsMHwo0KCp2R5NqU,28006
 onfido/models/address.py,sha256=47oVzKVhn6Qxd24HMIuAQmVKgHPyfOnlFmBnthi2wOE,6812
 onfido/models/address_builder.py,sha256=SjuOn2_T7Yic2l7qhaxd-euaijx85BziRkunp5j292M,6840
@@ -157,7 +157,7 @@ onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_li
 onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.py,sha256=RRBNzE6u9YXQ8PmJxOa6kNdWineFm6EEg4qtPGTZcws,3974
 onfido/models/facial_similarity_video_properties.py,sha256=ICtG2ymOwHxDh0yLWeW5D8kvKBw8TJO752w3Vp9msBU,3400
 onfido/models/facial_similarity_video_report.py,sha256=3E9EtYOzfxpQ37PY6nhaj1A4pbC_dEkYuBTSu_m3fmw,8914
-onfido/models/id_number.py,sha256=iOfUgB49KpWxEf6HjEvvx3w2DHBGc-bXRYODzJQHA0Q,3913
+onfido/models/id_number.py,sha256=-rSMPPNrhnEjKJXfgPuZj3PLeHtHRMuv04FNhfBfzA4,3951
 onfido/models/id_photo.py,sha256=MINVgfDRrOPPTZFyL-wYxQvmOHTXs9qKT3rbtMJksro,4085
 onfido/models/id_photo_response.py,sha256=MzNcewhNkp86SNn1JdTyy8yfhR-4m4tnWyIU2-3YA3s,4117
 onfido/models/id_photos_list.py,sha256=cng280Pm_0uVGfxHtJ1jGFDM4XXCRtsBJDxYnwbvw-8,3462
@@ -281,7 +281,7 @@ onfido/models/webhook_event.py,sha256=g5lobXwKJsA0J34puBVMcLbm7vcrVlZoFTuvRvCFE9
 onfido/models/webhook_event_object_status.py,sha256=4jEEia3Ecbji5bNaD4weG21BrgucVod3EKnEdKVJF6A,1267
 onfido/models/webhook_event_payload.py,sha256=aHlXjU0FX3F30zau9JBDkZqsZ2HgeBd_QXN19cNiRVo,4317
 onfido/models/webhook_event_payload_object.py,sha256=VbRajHlUahupevBm464VVuVWbYS4NrsXpEJFgC20KmU,3912
-onfido/models/webhook_event_payload_resource.py,sha256=sGoNAlIX4AjxfM_QN3IglsHOxT4KVpB1Ba2jTxUkxbo,7245
+onfido/models/webhook_event_payload_resource.py,sha256=7kWajSY3e_1Pe7aT04z5AMIcPSKpdYBNkgJNR-07C1Q,7481
 onfido/models/webhook_event_resource_type.py,sha256=paadOwFMD8K8JCuBCAE3F_sWV-32HD3qhkabEl1Ae0E,967
 onfido/models/webhook_event_type.py,sha256=S863kbG9lmTrvxcRUTHpKA5Nng9-uD-naW7XP2nVbS4,1655
 onfido/models/webhook_resend.py,sha256=H_qpNUnh0y1FJQUy1B6ngY69iH7nHU9qjglRXLXKmPc,3478
@@ -299,8 +299,8 @@ onfido/models/workflow_run_request.py,sha256=IGCpkcvqn6kJ2L2nZeuBHNeANqcSUfvx0Ig
 onfido/models/workflow_run_response.py,sha256=Ze469zDUWxZMxqIxas6Sjts3EB21z7PhZTfuWgs0Thw,5080
 onfido/models/workflow_run_shared.py,sha256=WP9qLkf79iaJTeK-QxkwzB2MvR4atT3LdZZRmZopPp4,4857
 onfido/models/workflow_run_status.py,sha256=34P9aHn0FEAirtAo64ej00LH4h-3V36ShZG1XbS_hZo,884
-onfido_python-4.4.0.dist-info/LICENSE,sha256=SKY_O1OkFX8yNWFuVVfYTsXvN46jsgtff-xReserHw4,1073
-onfido_python-4.4.0.dist-info/METADATA,sha256=pBw-j-Pj_kS6IU_U3Wz_6RgeOD8w1PGuXKcvmzqy4Wc,486
-onfido_python-4.4.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-onfido_python-4.4.0.dist-info/top_level.txt,sha256=NHu8xI4S4Avh7xUark3dpdk9atpIVgyf-ptjHXU0-Ns,7
-onfido_python-4.4.0.dist-info/RECORD,,
+onfido_python-4.6.0.dist-info/LICENSE,sha256=SKY_O1OkFX8yNWFuVVfYTsXvN46jsgtff-xReserHw4,1073
+onfido_python-4.6.0.dist-info/METADATA,sha256=k0vuk4kzUWkXBO3N3do_F2FlQPf5sN3wVmFcLQPIsbc,654
+onfido_python-4.6.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+onfido_python-4.6.0.dist-info/top_level.txt,sha256=NHu8xI4S4Avh7xUark3dpdk9atpIVgyf-ptjHXU0-Ns,7
+onfido_python-4.6.0.dist-info/RECORD,,

{onfido_python-4.4.0.dist-info → onfido_python-4.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any